「Webhook」通知外部商家履约备餐状态变更
收藏
我的收藏接口说明
将生服点单订单的履约备餐状态变更通知外部商家,如备餐中、已出餐、已取餐事件。
1、消息可能重复推送,请使用 Msg_Id 进行去重处理!
2、信息推送使用说明参考:生活服务消息推送
**WebHook消息可能丢失**
基本信息
基本 信息 | ||||
HTTP URL | -- | |||
HTTP Method | POST | |||
Scope | life.trade.meal_retail_webhook_order_status | |||
回调地址配置 | 配置webhook地址, event为:retail_life_meal_order_status_change |
请求头
名称 | 类型 | 必填 | 描述 |
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 | 是 | 消息类型,用于区分各类消息 | retail_life_meal_order_status_change |
client_key | string | 是 | 对应服务商平台或开发者平台中的APPID,应用ID | |
content | string | 是 | 消息内容,根据需要解析消息内容,不同类型的消息内容不同 | |
log_id | string | 是 | 抖音内部日志id,可提供给抖音方便排查问题 | |
Content内容
名称 | 类型 | 是否必填 | 描述 | 示例值 |
order_id | string | 是 | 抖音侧订单 ID | 100001 |
timestamp | int | 是 | 状态变更时间戳ms | |
cur_status | int | 是 | 当前订单状态:
| |
请求示例
响应参数
响应内容可以为空。
开发者收到消息推送后,http code 响应 200 且响应时间小于 3s,抖音侧即认为推送成功。
若开发者 http 响应 code 非 200 或响应时间超过 3s,抖音侧会间隔 500ms 发起重试,最大重试次数为 3 次。
抖音侧收到成功请求时也可能会继续重复推送,请务必使用请求头中 Msg-Id 进行消息去重处理。