WebHook 推送数据格式说明

开发者可以通过自建服务接收来自 WebHook 消息,方式为 POST，相关 WebHook 推送数据格式的说明如下：

Request Headers

WebHook request headers 包含以下一些关键数据

Content-Type: application/x-www-form-urlencoded    # 默认为 application/x-www-form-urlencoded , 若需要修改为 application/json 请联系对接人员

banri-number: 00000000 　　 # 默认是运单号

banri-timestamp: 1700137429　 # 触发 WebHook 的时间戳

banri-sign: sign # 根据签名密钥计算后的签名

💡

banri-sign 签名密钥计算签名的实现算法为

md5(secretKey . '&' . banri-timestamp. '&' . banri-number. '&' . secretKey )

提示

对接时请提供secretKey和接收WebHook消息的URL

Request Body

以下是推送的示范数据（仅供参考，请以实际收到的数据为准）

{
		"type": "tracking",
		"jp_number": "00000000",
		"order_number_system": "6600000000EC",
		"tracking": [{
			"code": "TONK",
			"message": "国际出货准备中",
			"time": "2024-07-30 16:37:41",
			"zone": "UTC+9"
		}, {
			"code": "GXQA",
			"message": "快件到达 【武汉东西湖中转场】",
			"time": "2024-08-07 12:38:31",
			"zone": "UTC+8"
		}, {
			"code": "...",
			"message": "...",
			"time": "YYYY-MM-DD HH:ii:ss",
			"zone": "UTC+0"
		}]
	}

Response

需要响应时间为5秒，并且响应HTTP状态码为200，响应数据如下时表示成功。

{"success": true}

提示

如果响应未成功，会每隔3秒后再次推送，共计推送15次

如果需要修改推送频率，请联系对接人员。并且提供推送频率间隔（秒）。格式如下：

次 => 秒
1,2 => x
3 => x
4 => x
5 => x
6 => x
7,8,9 => x
10 => x
11,12,13 => x
14,15 => x

提示

提供secretKey和接收WebHook消息的URL后，调用下单接口会自动触发WebHook消息推送, 可以进行测试:)

物流轨迹订阅

WebHook 推送数据格式说明#

Request Headers#

Request Body#

Response#

WebHook 推送数据格式说明

Request Headers

Request Body

Response