接口描述
手机查快递接口,通过收寄人手机接口获取该渠道三个月内快递单信息。
请求地址
POST
http://xx.com/api/query/phone
请求头
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求体
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
key | 是 | string | 接入方在平台的api账户标识 |
phone | 是 | string | 手机号码 |
sign | 是 | string | 签名, 用于验证身份, 按(key phone secret )的顺序进行MD5加密(注意加密后字符串一定要转大写), 不需要加上“ ”号 |
type | 否 | number | 类型 0:所有,1:发件人,2:收件人 3:既是发件人也是收件人 |
size | 否 | number | 返回最近的单号轨迹数量 |
返回结果
字段名称 | 类型 | 是否必填 | 字段含义 |
---|---|---|---|
result | boolean | 是 | 请求结果 |
message | string | 是 | 消息体 |
data | arrayobject | 是 | 业务数据 |
data类型说明
字段名称 | 类型 | 是否必填 | 字段含义 |
---|---|---|---|
type | number | 是 | 1:寄件人;2:收件人;3:既是发件人也是收件人 |
num | string | 是 | 运单号 |
details | arrayobject | 是 | 物流轨迹实体类 |
details类型说明
字段名称 | 类型 | 是否必填 | 字段含义 |
---|---|---|---|
context | string | 是 | 节点轨迹描述 |
location | string | 是 | 轨迹所在地区行政区,如:广东深圳南山 |
time | string | 是 | 节点时间,必须格式化为 yyyy-MM-dd HH:mm:ss |
提供数据说明
代码语言:txt复制一、请求失败
{
"result": false,
"message": "手机号码格式错误",
"data": null
}
二、请求成功,但是查无结果
{
"result": true,
"message": "查无结果",
"data": []
}
三、请求成功,有单号
{
"result": true,
"message": "SUCCESS",
"data": [
{
"type": 2,
"num": "UT0000280482232",
"details": [
{
"context": "【深圳转运中心】,正发往【深圳南山区十六部】",
"location": "广东省深圳市",
"time": "2018-04-29 16:31:48"
},
{
"context": "到【东莞凤岗中心分部集货点】",
"location": "广东省东莞市",
"time": "2018-04-29 11:23:18"
}
]
},
{
"type": 1,
"num": "UT0000280482235",
"details": [
{
"context": "站点【退货部】进行了【货物退回客户扫描】操作",
"location": "江苏省南京市玄武区",
"time": "2018-04-29 18:01:22"
},
{
"context": "【南京玄武网点】的小哥郑义正在派件",
"location": "江苏省南京市玄武区",
"time": "2018-04-29 10:17:26"
}
]
}
]
}
官方文档:
https://api.kuaidi100.com/document/6051a69aa52d305ab4d2a1cf.html