文档中心
一、创建工单 二、查询工单详情 三、工单留言 四、上传附件 五、工单结果回调接口 六、工单留言回调接口 七、附录

商家寄件工单接口

企业用户可以将异常反馈工单功能集成到自有平台或系统使用,反馈重量异常、虚假揽收等订单情况。本接口有流量控制,同一用户在5秒内调用接口超过100次将被限制访问。目前支持的快递品牌有圆通、申通和德邦。

一、创建工单

1.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://api.kuaidi100.com/workorder/api/create

请求参数(header):

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(query):

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
secondTypeint反馈类型(参考附录6.1)
kuaidinumstring快递单号
descobject问题描述
callBackUrlstring工单结果回调地址(非必填)
msgCallBackUrlstring工单留言回调地址(非必填)
telWeightstring反馈重量(反馈类型为重量异常时必填)不能超过五个字
modityValuestring商品价值(反馈类型为破损、遗失、少件、错件必填)

desc数据结构:

参数名是否必填类型说明
contentstring问题内容
attachList附件信息(参考附录6.2)

1.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

data数据结构:

字段类型说明备注
idint工单id
statusint处理状态

1.4 提供数据内容

请求参数示例

sign=E059DFE9D75FF74ADEE66A2AE4881AA8
key=******
t=1681293665905
	param={
    	    "kuaidinum":"asdsd123123123",
    	    "telWeight":"1",
    	    "callBackUrl":"http://127.0.0.1:9100/apitest/apiOrder/callback",
   	        "secondType":4,
   	        "desc":{
        	    "attach":[
           		{
                	  "type":0,
                	  "uri":"http://xxxxxxxxxxxxxxxxxxxxx"
           		}
                     ]
                  },
              "content":"重量异常"
             }

返回结果示例

{
    "code": 200,
    "data": {
        "id": 1042,
        "status": 0
    },
    "message": "success",
    "time": 0,
    "success": true
}

二、查询工单详情

查询创建的工单详情信息

2.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

2.2 请求地址

https://api.kuaidi100.com/workorder/api/status

请求参数(header):

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(query):

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
consultIdint工单id,例如:1

2.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

data数据结构:

字段类型说明备注
idint工单id
telWeightstring反馈重量
promisestring承诺描述
replyListList回复列表
secondTypeint反馈类型
opRecordsList处理结果
secondDescstring反馈类型描述
statusDescstring处理状态描述
weightstring重量
kuaidiNumstring快递单号
kuaidiComstring快递公司
createTimeDate创建时间
lastModifiedDate修改时间
statusint处理状态
descstring描述

replyList数据结构:

字段类型说明备注
committerstring处理人员
contentstring留言内容
lastModifiedDate修改时间
attachList附件

opRecords数据结构:

字段类型说明备注
idint工单id
contentstring处理内容
resultstring处理结果

2.4 提供数据内容

请求参数示例

t=1681293665905
param={
    	"consultId":1056
}
sign=E059DFE9D75FF74ADEE66A2AE4881AA8
key=******

返回结果示例

{
   	"code": 200,
    	"data": {
        	"id": 1056,
        	"telWeight": null,
        	"promise": "用户您好,当前您反馈“催取件”问题我们将持续协助您处理,在此期间请您优先联系已分配给您的快递员号码,如超时未能得到解决建议您下单给平台的其他快递品牌寄件。感谢您的理解。",
        	"replyList": [
            		{
                	"committer": "超级管理员勿改",
                	"content": "您好,您的问题已经收到,我们会尽快处理。感谢您对快递100的支持!",
                	"lastModified": "2023-04-12 20:52:00",
                	"attach": null
            		},
            		{
                	"committer": "深圳清峰电子商务有限公司",
                	"content": "催取件",
                	"lastModified": "2023-04-12 20:47:31",
                	"attach": [
                    			{
                       			"uri": "http://xxx.com/downloadfile/cew3Dca3b-xFI2ILewy80_3l8g9oX8q2IBEt9h0kG5XCldLqJYzZcg",
                        		"type": 0
                   			 }
                		  ]
            		}
        		],
        	"secondType": 1,
       	 	"opRecords": null,
        	"secondDesc": "催取件",
        	"statusDesc": "已完结",
        	"weight": "0",
        	"kuaidiNum": "9382000001103st",
        	"kuaidiCom": "shentong",
        	"createTime": "2023-04-12 20:47:31",
        	"lastModified": "2023-04-12 20:52:06",
        	"status": 3,
        	"desc": null
    },
    "message": "success",
    "time": 0,
    "success": true
}

三、工单留言

3.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

3.2 请求地址

https://api.kuaidi100.com/workorder/api/reply

请求参数(header):

名称类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(query):

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接
methodstring新增留言: addReply,查询留言: queryReply

param数据结构(查询留言):

参数名是否必填类型说明
consultIdint工单id,例如:1

param数据结构(新增留言):

参数名是否必填类型说明
consultIdint工单id,例如:1
contentstring留言内容
attachList附件

3.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

data数据结构(查询留言):

字段类型说明备注
committerstring处理人员
contentstring留言内容
lastModifiedDate留言时间
attachList附件

3.4 提供数据内容

查询留言: 请求参数示例

t=1681293665905
param={
    	"consultId":"1056"
      }
sign=E059DFE9D75FF74ADEE66A2AE4881AA8
key=******
method=queryReply

返回结果示例

{
   		"code": 200,
    		"data": [
        			{
            			"committer": "测试环境帐号",
            			"content": "testAPI",
            			"lastModified": "2023-04-10 14:10:03",
            			"attach": null
        			},
        			{
            			"committer": "测试环境帐号",
            			"content": "testApi",
            			"lastModified": "2023-04-10 15:03:12",
            			"attach": [
                					{
                    						"uri": "1",
                    						"type": 0
                					}
            					]
        			  }
   			 ],
    		"message": "success",
    		"time": 0,
    		"success": true
}

新增留言: 请求参数示例

t=1681293665905
param={
    	"consultId":1023,
        "content":"testApi",
        "attach":[
                  {"uri":"xxxxx","type":0}
                 ]
      }
sign=E059DFE9D75FF74ADEE66A2AE4881AA8
key=******
method=addReply

返回结果示例

{
    "code": 200,
    "data": null,
    "message": "success",
    "time": 0,
    "success": true
}

四、上传附件

上传提交工单内的图片文件

4.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

4.2 请求地址

https://api.kuaidi100.com/workorder/api/upload

请求参数(header):

名称类型默认值
Content-Typestringmultipart/form-data

请求参数(query):

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接
filefile图片

param数据结构:

参数名是否必填类型说明
fileNamestring图片名称,例如:pic1

4.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

4.4 提供数据内容

请求参数示例

t=1681293665905
param={
    	"fileName":"testImg"
      }
sign=E059DFE9D75FF74ADEE66A2AE4881AA8
key=******
file=file

返回结果示例

{
   "code": 200,
   "data":
"http://file.kuaidi100.com/downloadfile/0fPfDVqPF_LNPnxoS3dtjpb5CQEGB9nJAuAAnDgi_tNWzZLnMYRHBA",
   "message": "success",
   "time": 0,
   "success": true
}

五、工单结果回调接口

工单提交时有填写回调地址是会触发回调。当调用回调地址不成功时,会隔半小时重试一次,总共重试三次。 不成功的情况包含但不限于:回调接口返回失败、回调接口三秒超时未响应、响应格式不对。

5.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

5.2 请求地址

由贵司通过创建工单接口的callbackurl字段提供

请求参数

Header:

名称类型默认值
Content-Typestringapplication/json

body:

参数名是否必填类型说明
workorderIdnumber工单id
statusint处理状态
resultstring处理结果

5.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

六、工单留言回调接口

工单提交时有填写回调地址是会触发回调。当调用回调地址不成功时,会隔半小时重试一次,总共重试三次。 不成功的情况包含但不限于:回调接口返回失败、回调接口三秒超时未响应、响应格式不对。

6.1 接口格式

提供统一格式的HTTP POST接口,并返回统一格式JSON数据。

6.2 请求地址

由贵司通过创建工单接口的msgCallBackUrl字段提供;

请求参数:

参数名是否必填类型说明
workorderIdstring工单id
committerstring处理人员
contentstring留言内容
lastModifiedDate留言时间
attachList附件

6.3 返回结果

字段类型说明备注
codeint响应码200表示提交成功
dataobject返回数据
messagestring返回信息
timeint响应时间
successboolean是否成功

七、附录

7.1 反馈类型secondType参数字典

secondType反馈类型
1催取件
4重量异常
5虚假揽收
7线下收费
10破损
11遗失
12签收未收到货
13服务态度差
14少件
15错件
16催物流
17催派送
18更改收件信息
19拦截退回
20核实退回原因

7.2 attach数据结构

参数名是否必填类型说明
uristring图片链接
typeint附件类型(0:图片)

7.3 处理状态status参数字典

status处理状态
0未受理
1未回复
2已回复
3已完结