订阅接口
POST
http://poll.kuaidi100.com/pollmap
通过订阅接口提交快递单号，接口接收到后便对这些运单进行跟踪，当运单状态发生变化的时候，通过调用回调接口将运单的跟踪信息推送给贵公司，直到这些运单号的生命周期结束（一般以“已签收”为准）。
1.使用http协议表单提交的方式进行信息交互，字符编码默认统一采用UTF-8，数据格式：application/x-www-form-urlencoded；
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| key | 是 | string | 授权码，请申请企业版获取 |
| company | 是 | string | 订阅的快递公司的编码，一律用小写字母 |
| number | 是 | string | 订阅的快递单号，单号的最大长度是40个字符 |
| from | 是 | string | 快递寄件地址 |
| to | 是 | string | 快递收件地址 |
| parameters | 是 | Object | 辅助参数 |
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| callbackurl | 是 | string | 回调接口的地址 |
| salt | 否 | string | 签名用随机字符串 |
| phone | 否 | string | 收寄件人的移动电话号码（只能填写一个，顺丰速运和丰网速运必填，其他快递公司选填） |
| ordertime | 否 | string | 订单下单时间，格式“yyyy-MM-dd HH” |
| resultv2 | 否 | string | 添加此字段表示开通行政区域解析功能。0：关闭（默认），1：开通行政区域解析功能以及物流轨迹增加物流状态值，2：开通行政解析功能以及物流轨迹增加物流状态值并且返回出发、目的及当前城市信息 4：开通行政解析功能以及物流轨迹增加物流高级状态名称并且返回出发、目的及当前城市信息 6:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息 |
1.6 状态码附表
| returnCode | massage | 描述 |
|---|---|---|
| 200 | 提交成功 | 订阅提交成功 |
| 400 | 无法解析 | 出发地目的地无法解析或下单时间无法解析 |
| 500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数写错等，也会报此错误 |
| 501 | 重复订阅 | 此单已经订阅成功且目前还在跟踪过程中。若要提交多次订阅，请在收到单号的status=abort或shutdown后隔半小时再提交订阅 |
| 502 | 提交内容含有敏感关键字，被安全防护拦截 | 回调地址、提交内容包含敏感词，请联系快递100工作人员 |
| 600 | 您不是合法的订阅者（即授权Key出错） | 账号无可用单量，需要充值 |
| 601 | POLL: KEY 已过期 | 账号无可用单量，需要充值 |
| 700 | 不支持的快递公司 | 拒绝订阅的快递公司，检查快递公司编码是否有误 |
| 701 | 订阅方的订阅数据存在错误（如不支持的快递公司、单号为 空、单号超长等）或错误的回调地址 | 请检查快递公司编码、对照技术文档检查参数、在后台调试工具测试回调地址 |
| 702 | POLL:识别不到该单号对应的快递公司 | 快递公司编码错误或者无可用单量，需要充值 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://poll.kuaidi100.com/pollmap' \
--data-urlencode 'param={ "company": "ems", "number": "1136281381675", "from": "广东省深圳市南山区", "to": "北京市朝阳区", "key": "XXX ", "parameters": { "callbackurl": "您的回调接口的地址，如http://www.您的域名.com/kuaidi?callbackid=...", "salt": "*", "phone": "", "ordertime": " 2021-08-05 15:20:00" } }'响应示例响应示例
{
"result": true,
"returnCode": "200",
"message": "提交成功"
}请求参数
Body 参数application/x-www-form-urlencoded
schema
string
默认是json
param
string
主体参数对象
示例值:
{ "company": "ems", "number": "1136281381675", "from": "广东省深圳市南山区", "to": "北京市朝阳区", "key": "XXX ", "parameters": { "callbackurl": "您的回调接口的地址，如http://www.您的域名.com/kuaidi?callbackid=...", "salt": "*", "phone": "", "ordertime": " 2021-08-05 15:20:00" } }
返回响应
扫码加入交流群