用户领券结果回调通知
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
申请说明
使用限制
接口说明
请求Body
| 参数 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| coupon_id | string | 是 | 券id，由平台生成，全局唯一 开发者可以用coupon_id作为幂等键，实现通知消息的幂等处理 | 709243586555366 |
| app_id | string | 是 | 小程序appid | ttxxxxxx |
| open_id | string | 是 | 领券用户的小程序open id | 95790093 |
| coupon_status | int32 | 是 | 券状态，10：已领取 | 10 |
| receive_time | int64 | 是 | 领券时间，单位秒 | 1686546782 |
| merchant_meta_no | string | 是 | 外部券模板编号，由开发者在创建券模板的接口上传，便于开发者定位属于自己业务的券 | 7090813568795790093 |
| valid_begin_time | int64 | 是 | 券有效期开始时间，单位秒 | 1639643394 |
| valid_end_time | int64 | 是 | 券有效期结束时间，单位秒 | 1639642948 |
| talent_open_id | string | 是 | 发放券的主播的小程序open id | 68795790093 |
| talent_account | string | 是 | 发放券的主播的抖音号 | 221234234243 |
| union_id | string | 是 | 领券用户的union id | 3d5f4913-xxxx-443d-b7ab-538db3f4e237 |
回调信息
| 名称 | 描述 |
|---|---|
| HTTP URL | 券模板配置的回调通知callback_url，详细可见券模板创建 。 要求必须为https地址。请确保回调通知URL是外部可正常访问的，且不能携带后缀参数，否则可能导致无法接收到回调通知。 |
| HTTP Method | POST |
回调通知签名验证，可参考： 签名算法，重点关注 “签名验证” 部分。如下图所示部分：
响应参数
| err_no | err_msg | notify_status | 描述 | 备注 |
|---|---|---|---|---|
| 0 | "" | "success" | 收到通知并处理成功 | |
| 1 | "拒绝发券_{详细原因}" | "success" | 收到通知但由于命中风控、用户黑名单等原因拒绝发放 | 只有通过「申请说明」进行功能申请后，拒绝发券能力才会生效。未通过申请前，回调接口仅用于开发者的消息订阅。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com' \
--header 'Byte-Timestamp;' \
--header 'Byte-Nonce-Str;' \
--header 'Byte-Signature;' \
--header 'content-type: application/json' \
--data-raw '{
"type": "string",
"msg": "string"
}'响应示例响应示例
200 - 成功示例
{
"err_no": 0,
"err_msg": "",
"notify_status": "success"
}请求参数
Header 参数
Byte-Timestamp
string
签名时间戳
Byte-Nonce-Str
string
签名随机串
Byte-Signature
string
签名值
content-type
string
必需
Body 参数application/json