抖音开放平台Logo
控制台

查询用户可用券信息

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

可通过调用该接口，查询用户在对应小程序下可用券信息。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/promotion/v1/coupon/get_coupon_receive_info/
HTTP Method
POST
Scope
promotion.coupon.admin
权限要求

无

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
app_idString是ttec789ac573xxxxxx01

小程序appid

open_idString是Cv4PoJXaTPn63rNu

用户在小程序的open_id。该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取

coupon_idString否702345xxxxxxx

抖音开放平台券id，开发者通过平台的领券回调或查询接口获得券id

请求示例

curl --location --request POST 'https://open.douyin.com/api/promotion/v1/coupon/get_coupon_receive_info' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id":"ttcfdbb96650exxxx",
    "open_id":"Cv4PoJXaTPnxxxx",
    "coupon_status": 10
}'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString是"access_token无效"
错误描述
err_noInt32是28001003
错误码
log_idString是"202405291440576E078D8757B9"
日志id

响应示例

正常响应示例

{
  "err_no": 0,
  "err_msg": "",
  "log_id": "202304201146560B814XXXDB9D0B051956",
  "data": {
    "coupon_receive_list": [
      {
        "discount_type": 2,
        "receive_desc": "领取描述",
        "valid_end_time": 1678716000,
        "talent_open_id": "Cv4PoJXaxxx63rNu",
        "valid_begin_time": 1678705200,
        "consume_path": "pages/index/index",
        "coupon_id": "720998824905xxxx532",
        "coupon_status": 10,
        "discount_amount": 1000,
        "min_pay_amount": 10,
        "consume_desc": "使用描述",
        "coupon_name": "券名称",
        "merchant_meta_no": "merchant_demo",
        "talent_account": "473945xxx83",
        "receive_time": 1678709372
      }
    ]
  }
}

异常响应示例

{
  "err_msg": "参数不合法",
  "err_no": 28001007,
  "log_id": "202304181452428BAD8F6XXX34EEB829AD"
}

错误码

http状态码错误码错误码描述排查建议
20028001005
系统内部错误，请重试
请求重试，若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001006
网络调用错误，请重试
重试即可
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常