佣金计划创建结果推送(webhook)
收藏
我的收藏接口说明
异步创建佣金计划场景下,对创建接口进行推送。目前门店维度下的通用计划创建会进行异步通知,且会通知多次,用于给门店下每个商品创建对应的通用计划。
基本信息
基本信息 | ||||
HTTP Method | POST | |||
回调地址配置 | 配置webhook回调地址, event为 life_hotel_commission_rate_result |
请求头
名称 | 类型 | 必填 | 描述 |
Msg-Id | string | 是 | 同一实体下同一action的msg_id相同,服务商可根据msg_id对于消息去重 |
X-Douyin-Signature | string | 是 | 抖音侧签名,服务商可根据签名判断该消息是否来自抖音开放平台,抖音服务端会将应用的(client secret + 消息体)使用 sha1 哈希作为 X-Douyin-Signature header 的 value。您可以自行使用 client secret 和收到的消息体进行 sha1 哈希,与该请求头进行比对 可参考: 文档 - 抖音开放平台 - 服务商平台 |
Content-Type | string | 是 | 固定值application/json |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
event | string | 是 | 消息类型,用于区分各类消息。
| life_hotel_commission_rate_result |
client_key | string | 是 | 对应服务商平台或开发者平台中的APPID,应用ID | |
content | string | 是 | 消息内容,json字符串。根据需要解析消息内容,不同类型的消息内容不同 | |
log_id | string | 是 | 抖音内部日志id,可提供给抖音方便排查问题 | |
Content内容
参数名称 | 参数类型 | 必须参数 | 备注 |
» dimension_type | enum | 必填 | 维度 |
» dimension_id | string | 必填 | 维度id |
» code | int | 必填 | 创建结果状态码
|
» message | string | 必填 | 文案说明 |
» plan_ids | list<string> | 选填 | 创建成功的计划id列表 |
响应参数
响应内容可以为空。
开发者收到消息推送后,http code 响应 200 且响应时间小于 3s,抖音侧即认为推送成功。
若开发者 http 响应 code 非 200 或响应时间超过 3s,抖音侧会间隔 500ms 发起重试,最大重试次数为 3 次。
抖音侧收到成功请求时也可能会继续重复推送,请务必使用请求头中 Msg-Id 进行消息去重处理。