商家寄件工单接口

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

一、创建工单

1.1 接口格式

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

1.2 请求地址

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

请求参数（header）：

请求参数（query）：

param数据结构：

desc数据结构：

1.3 返回结果

data数据结构：

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）：

请求参数（query）：

param数据结构:

2.3 返回结果

data数据结构：

replyList数据结构：

opRecords数据结构：

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）：

请求参数（query）：

param数据结构（查询留言）:

param数据结构（新增留言）:

3.3 返回结果

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

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）：

请求参数（query）：

param数据结构:

4.3 返回结果

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：

body:

5.3 返回结果

六、工单留言回调接口

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

6.1 接口格式

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

6.2 请求地址

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

请求参数：

6.3 返回结果

七、附录

7.1 反馈类型secondType参数字典

7.2 attach数据结构

7.3 处理状态status参数字典