查询授权用户发放的活动信息
接口说明
提供接口查询IM场景下授权给某个用户后,查询用户设置的活动信息。
使用限制
仅返回IM场景券模版的活动信息。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/promotion/v1/coupon/query_activity_meta_data/ |
| HTTP Method | POST |
| Scope | promotion.coupon.admin |
| 权限要求 | 开发者类型:企业开发者 小程序券 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
open_id必填String
示例:Cv4PoJXaTPn63rNu
用户在小程序的open_id。该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取
page_num必填Int32
示例:1
页码,从1开始
page_size必填Int32
示例:10
单页大小,不能超过100
send_scene必填Enum
示例:4
券的发放场景,仅支持4(IM场景发送):
- 取值4:IM场景发送
展开子属性
status必填Enum
示例:1
活动状态
展开子属性
coupon_meta_idString
示例:70234500000
已创建的抖音开放平台券模板id,通过/api/promotion/v2/coupon/create_coupon_meta/接口返回的coupon_meta_id字段获取
coupon_nameString
示例:三亚10日游专享券
券名称,长度15以内,根据券名称模糊查询。
discount_typeEnum
示例:1
优惠类型
展开子属性
请求示例
curl --location --request POST '/api/promotion/v1/coupon/query_activity_meta_data/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data-raw '{ "open_id": "f74be57c-7356-4868-814b-dd20cf20ddca", "send_scene": 4, "coupon_meta_id": "7288255536846340xxx", "coupon_name": "好券模版", "page_num": 1, "page_size": 10, "status": 1 }'
响应参数
Body展开全部子属性
err_msg必填String
err_no非0时对应的错误信息文案提示,成功时为空字符串
err_no必填Int32
示例:0
0表示成功
log_id必填String
示例:202008121419360101980821035705926A
标识请求的唯一id
dataStruct
成功时必填
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "total": 1, "activity_list": [ { "discount_type": 1, "receive_end_time": 1696995547, "remain_stock": 10, "app_icon": "", "consume_time_desc": "领取后 3000000 自然日内有效", "coupon_icon": "https://p9-dexxer-sign.bytxxxxmg.com/tos-cn-i-zptclditwk/067a8aa4b371f26xxxxxxcab319.png~tplv-ke512zj2cu-144x144.jpeg?x-expires=2008056593&x-signature=vN4nWq%2B9fvcq2vNIX2I5HgedfMo%3D", "coupon_meta_name": "api-im渠道", "discount_amount": 100000, "receive_begin_time": 1696649954, "activity_id": "728779470083xxxxxx", "activity_status": 1, "app_name": "ii", "discount_type_name": "立减券", "app_id": "ttcfdbb966xxxxx0", "consume_desc": "无门槛立减", "coupon_meta_id": "7288xxxxxxxx340156", "share_fission_desc": "分享被领取后无奖励", "support_share_fission": true, "total_stock": 10 } ] }, "err_msg": "", "err_no": 0, "log_id": "02169699342137500000000000000000000ffff0a7039acbdb087" }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 0 | success | 接口请求成功,无需排查 |
| 200 | 28001005 | 系统内部错误,请重试 | 请求重试,若依然无解请向平台提交反馈 |
| 200 | 28001007 | 参数不合法 | 检查请求参数是否填写正常 |
| 200 | 28001004 | open_id invalid | open_id不正确 |
