抖音开放平台Logo
控制台

预约取消/完成通知

更新时间 2024-07-24 02:58:49
收藏
我的收藏
当预约完成或者预约被（用户/客服）取消时平台会使用该通知接口通知开发者​

​使用限制​

无​

​接口说明​

    1.​当客服发起取消时，会向开发者发送“客服取消”通知，status="CANCEL",operator_type= "CUSTOMER_SERVICE"​
    2.​当用户发起取消时，会向开发者发送“用户取消”通知，status="CANCEL",operator_type= "USER"​
    3.​预售券商品类型，开发者无需同步核销状态，由开平自动核销，当该预约单到达指定日期（最晚预约子单的预定结束时间）被自动核销之后，会通知开发者“预约完成”, status="FINISH".​
    4.​门票退款后，会向开发者发送“系统取消”通知，status="CANCEL",operator_type= "SYSTEM"​

​基本信息​

名称​
描述​
HTTP URL​
在行业模板配置-消息订阅-预约通知中指定的通知地址，配置方式参考行业模板配置文档​
HTTP Method​
POST​

​请求头​

参见通用参数。​

​请求参数​

参数名称​
类型​
是否必填​
描述​
msg​
​
string​
是​
订单相关信息的序列化后的 json 字符串​
​
type​
​
string​
​
是​
​
枚举值：(依照现有的方式处理)​
payment 支付（成功/取消）​
refund 退款（成功/失败）​
settle 分账 （成功/失败）​
book 预约 （完成/取消）​
version​
string​
是​
固定值："2.0" callback版本，用于开发者识别回调参数的变更​
msg 内部结构说明​
参数名称​
类型​
是否必填​
描述​
app_id​
string​
是​
小程序appid​
status​
string​
是​
预约状态枚举值​
"FINISH":预约完成，​
"CANCEL"预约取消​
order_id​
string​
是​
抖音侧订单号，len <= 64 byte​
book_id​
string​
是​
预约单id，len <= 64 byte​
out_book_no​
string​
是​
开发者预约单id，len <= 64 byte​
message​
string​
否​
相关操作的原因。​
operator_type​
string​
​
否​
​
操作人类型，​
"CUSTOMER_SERVICE" 客服​
"USER" 用户​
"SYSTEM" 系统​
event_time​
int64​
是​
操作时间，13位时间戳，毫秒​

​请求示例​

text
复制
curl --location --request POST 'https://xxxxxxx.net/api/v2/result_callback?timestamp=1345678901234&nonce=iuy987q4htafreqw' \
--header 'Content-Type: application/json'
--data-raw='{
"version": "2.0", //本次固定为2.0, 通过版本信息识别，用不同的结构体去解析上述关键参数
"msg": "msg":"{\"app_id\":\"ttcfdbb96650e33350\",\"status\":\"SUCCESS\",\"order_id\":\"ot7057435515980663048\",\"cp_extra\":\"Duis aliqua esse dolore\",\"message\":\"SUCCESS\",\"event_time\":1643189272388,\"settle_id\":\"ot7057416814925531429\",\"out_settle_no\":\"ext_order_no_1643188675912_settle——1\",\"rake\":0,\"commission\":0,\"settle_detail\":\"商户号68882720803499563550-分成金额(分)2\",\"settle_amount\":2}",
"type": "book"
}'
msg 内部结构​
json
复制
{
"app_id": "ttcfdbb9663350",
"status": "CANCEL",
"order_id": "ot71175283778732",
"message": "000",
"event_time": 1657179470875,
"book_id": "ot711752052499436",
"out_book_no": "1657179463800",
"operator_type": "CUSTOMER_SERVICE"
}

​响应参数​

名称​
类型​
是否必填​
描述​
err_no​
int​
是​
错误码，0代表成功​
err_tips​
string​
是​
错误提示信息​

​响应示例​

​正常示例​

json
复制
{
"err_no": 0,
"err_tips": "success"
}
​