查询主播发券配置信息

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

接口说明

可通过调用该接口,查询主播发券权限和库存上限等配置信息。

使用限制

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/promotion/v1/coupon/get_talent_coupon/
HTTP Method
POST
Scope
promotion.coupon.admin

请求头

名称字段类型是否必填示例描述
access-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Body

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

账号类型:

  • 取值1时:talent_account 字段必填
  • 取值2是:open_id 字段必填
app_idStringttec789ac573xxxxxx01

小程序appid

coupon_meta_idString702345xxxxxxx

已创建的抖音开放平台券模板id,通过/api/promotion/v2/coupon/create_coupon_meta/接口返回的coupon_meta_id字段获取

open_idStringCv4PoJXaTPn63rNu

用户open_id,account_type为2时必填。该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取

talent_accountString7932234

主播抖音号,account_type为1时必填。该字段通过查看主播个人主页获得

请求示例

curl --location --request POST 'https://open.douyin.com/api/promotion/v1/coupon/get_talent_coupon' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_type": 1,
    "talent_account": "7932234",
    "open_id": "",
    "app_id": "ttec789ac573xxxxxx01",
    "coupon_meta_id": "702345xxxxxxx"
}' 

响应参数

Body

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

err_no非0时对应的错误信息文案提示,成功时为空字符串

err_noInt320

0表示成功

log_idString202008121419360101980821035705926A

标识请求的唯一id

响应示例

正常响应示例

{
  "data": {
    "account_type": 1,
    "talent_account": "7932234",
    "app_id": "ttec789ac573xxxxxx01",
    "coupon_meta_id": "702345xxxxxxx",
    "status": 1,
    "stock_limit": 100
  },
  "err_msg": "",
  "err_no": 0,
  "log_id": "20230418153707479F50CDEC0653C4E448"
}

异常响应示例

{
  "err_msg": "主播发券配置不存在",
  "err_no": 29005025,
  "log_id": "202304181452428BAD8F6FDE34EEB829AD"
}

错误码

http状态码错误码错误码描述排查建议
2000
success
接口请求成功,无需排查
20029005025
主播发券配置不存在
确认是否有调用主播发券权限配置 接口绑定主播与券模板的关系
20028001007
参数不合法
检查请求参数是否填写正常
20029005071
No Permission Operate
没有权限调用该接口,检查申请access-token的client_key是否与app_id一致
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈