# 工单中心

# 1、接口声明

在调用接口时必须在https请求的header中携带"token"参数。

token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token,开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时,需定时刷新,或根据接口返回的token失效提示,进行重新获取。请求token接口,无论token是否存在,都会返回新的token,并重置token的过期时间(目前24小时)。

token使用方式说明:
1、开发者需要统一获取和管理token,在调用智齿客服各个业务开放接 口时都应该使用同一个的token,不应该每个业务都刷新获取新的 token,否则容易导致token失效,影响接口的正常调用;
2、目前token的有效期通过返回的expire_in来传达,目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示,进行重新获取token。

# 2、接口调用

# 2.1、获取访问token编码

接口说明:

获取API开放接口token,此token仅适用于智齿开放平台 5.0版本全部API接口 。API接口中的参数 appid, app_key 请联系智齿售后人员获取。

请求方式:

GET

请求地址:

https://www.sobot.com/api/get_token

请求参数:

参数 类型 必填 名称 备注
appid String 接口凭证Id 第三方用户接口调用唯一凭证id
create_time String 时间戳 时间戳,秒,例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 签名 md5(appid+create_time+app_key) sign签名,app_key为秘钥

返回参数:

参数 类型 必填 名称
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
token String token编码
expires_in String 凭证有效时间 单位:秒

时间戳转换参考工具:

http://tool.chinaz.com/Tools/unixtime.aspx

sign签名生成示例:

例如,appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例:

curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例:

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.2、查询数据字典

接口说明:

数据字典包含:工单分类、工单状态、工单优先级、抄送数据其中抄送,工单分类为动态字典项,返回数据会随企业自身配置会发生变化。需要上述数据具体值时,请调用此接口获取。

请求方式:

GET

请求地址:

/api/ws/5/ticket/get_data_dict

请求参数:

参数 类型 必填 名称 备注

返回参数:

参数 类型 必填 名称
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
ticket_type_list List 工单分类信息 企业自定义分类,业务变化频繁
ticket_status_list List 工单状态信息
ticket_level_list List 工单优先级信息
group_list List 技能组信息 业务变化频繁
agent_list List 坐席信息 业务变化频繁

ticket_type_list集合:

参数 类型 必填 名称 备注
typeid String 分类ID
companyid String 公司ID
type_name String 分类名称
parentid String 父ID
type_level String 分类级别 最多五级(第一级,2:第二级,3:第三级,4:第四级,5:第五级)
node_flag String 是否叶子节点 0 是 1 不是
sub_type_list List 子分类信息 内容与ticket_type_list一致

ticket_status_list集合:

参数 类型 必填 名称
dict_value String 工单状态CODE
dict_name String 工单状态名称

ticket_level_list集合:

参数 类型 必填 名称
dict_value String 工单优先级CODE
dict_name String 工单优先级名称

group_list集合:

参数 类型 必填 名称
groupid String 技能组ID
group_name String 技能组名称

agent_list集合:

参数 类型 必填 名称
agentid String 坐席ID
agent_name String 坐席名称

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/get_data_dict

返回示例:

{
    "item": {
        "ticket_level_list": [
            {
                "dict_name": "低",
                "dict_value": "0"
            },
            {
                "dict_name": "中",
                "dict_value": "1"
            },
            {
                "dict_name": "高",
                "dict_value": "2"
            },
            {
                "dict_name": "紧急",
                "dict_value": "3"
            }
        ],
        "group_list": [
            {
                "group_name": "测试电销组",
                "groupid": "acb290d666814d65834c70073aed65f2_4"
            },
            {
                "group_name": "智齿_123",
                "groupid": "e3b931da9ab24a2abcb6f6ae59ae8c0c"
            }
        ],
        "ticket_status_list": [
            {
                "dict_name": "尚未受理",
                "dict_value": "0"
            },
            {
                "dict_name": "受理中",
                "dict_value": "1"
            },
            {
                "dict_name": "等待回复",
                "dict_value": "2"
            },
            {
                "dict_name": "已解决",
                "dict_value": "3"
            },
            {
                "dict_name": "已关闭",
                "dict_value": "99"
            }
        ],
        "ticket_type_list": [
            {
                "companyid": "acb290d666814d65834c70073aed65f2",
                "node_flag": "0",
                "parentid": "-1",
                "type_level": "1",
                "type_name": "其他",
                "typeid": "9"
            }, 
            {
                "companyid": "acb290d666814d65834c70073aed65f2",
                "node_flag": "1",
                "parentid": "-1",
                "sub_type_list": [
                    {
                        "companyid":"acb290d666814d65834c70073aed65f2",
                        "node_flag": "0",
                        "parentid": "131b5060166d4dbbb4beda95a4ff3d32",
                        "type_level": "2",
                        "type_name": "系统/应用类问题",
                        "typeid": "42a4d00d26304a1fa3c94c552d47cfdf"
                    },
                    {
                        "companyid": "acb290d666814d65834c70073aed65f2",
                        "node_flag": "1",
                        "parentid": "131b5060166d4dbbb4beda95a4ff3d32",
                        "sub_type_list": [
                            {
                                "companyid": "acb290d666814d65834c70073aed65f2",
                                "node_flag": "1",
                                "parentid": "5dc2f4d31c894f35a779f6a6d175c803",
                                "sub_type_list": [
                                    {
                                    "companyid": "acb290d666814d65834c70073aed65f2",
                                    "node_flag": "0",
                                    "parentid": "d3c3a3efc71f4a949bb7be8af6643626",
                                    "type_level": "3",
                                    "type_name": "摄像问题",
                                    "typeid": "d3c3a3efc71f4a949bb7be8af6643626"
                                    }
                                ],
                            "type_level": "2",
                            "type_name": "拍照",
                                "typeid": "5dc2f4d31c894f35a779f6a6d175c803"
                            }
                        ],
                        "type_level": "1",
                        "type_name": "故障排查",
                        "typeid": "131b5060166d4dbbb4beda95a4ff3d32"
                    }
                ]
            }
        ],
        "agent_list": [
            {
                "agent_name": "ming",
                "agentid": "0a37c8156d094311890e48fbc06501c4"
            },
            {
                "agent_name": "智齿测试12",
                "agentid": "efcfda336b5d4caeb4fd71392c54b5c9"
            }
        ]
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.3、查询自定义字段定义信息

接口说明:

返回工单自定义字段的基本信息

请求方式:

GET

请求地址:

/api/ws/5/ticket/query_ticket_extend_fields

请求参数:

参数 类型 必填 名称 备注

返回参数:

参数 类型 必填 名称
ret_code String 返回编码
ret_msg String 返回信息
items List 返回集合

items对象:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_name String 自定义字段名称
field_type String 自定义字段类型 1单行文本,2多行文本,3日期,4时间,5 数值,6下拉列表,7复选框,8单选框
fill_flag String 自定义字段是否必填 0 否 1 是
field_data_list List 选择型字段的选项信息

field_data_list集合:

参数 类型 必填 名称
data_name String 自定义字段选项名称
data_value String 自定义字段选项CODE值

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/query_ticket_extend_fields

返回示例:

{
    "items": [
        {
            "field_data_list": [
                {
                    "data_name": "999",
                    "data_value": "540264609760473"
                },
                {
                    "data_name": "777",
                    "data_value": "540264668320333"
                },
                {
                    "data_name": "888",
                    "data_value": "540264668320352"
                }
            ],
            "field_name": "下拉列表",
            "field_type": 6,
            "fieldid": "3ceef648f3d6412abdf8fd6aac5db9f3",
            "fill_flag": 1
        },
        {
            "field_data_list": [
                {
                    "data_name": "语文",
                    "data_value": "500862751814255"
                },
                {
                    "data_name": "数学",
                    "data_value": "500862751819356"
                },
                {
                    "data_name": "英语",
                    "data_value": "502372726676614"
                }
            ],
            "field_name": "复选",
            "field_type": 7,
            "fieldid": "8f52d2f19fad4a8eae22238437817b9c",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "测试234",
            "field_type": 5,
            "fieldid": "d1dc7e1e13794cf1a936d74b76c4ecc0",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "时间",
            "field_type": 4,
            "fieldid": "4e1e6b21b433461d9bac2cee6d3297d1",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "日期",
            "field_type": 3,
            "fieldid": "30b5071f2b514d57b6d34e7c95cdf431",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "567",
            "field_type": 2,
            "fieldid": "c2610afb04014d788e398324f7f01329",
            "fill_flag": 0
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功!"
}

# 2.4、工单自定义字段(选择型)添加选项信息

接口说明:

工单选择型自定义字段批量添加选项信息。

请求方式:

POST

请求地址:

/api/ws/5/ticket/save_option_data_value

请求参数:

参数 类型 必填 名称
fieldid String 工单自定义字段ID
field_data_value List 工单自定义字段选项信息
agentid String 操作坐席ID
agent_name String 操作坐席名称

data_value集合:

参数 类型 必填 名称
field_value String 字段选项值
field_text String 字段文本值

返回参数:

参数 类型 必填 名称
ret_code String 返回编码
ret_msg String 返回信息

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/save_option_data_value -X POST -H 'content-type: application/json' 
-H 'token:4ac37cb2e9c740dba4b75a34d5358802'  -d '{"fieldid":" 3ceef648f3d6412abdf8fd6aac5db9f3","agentid":"0a37c8156d094311890e48fbc06501c4","agent_name":"ming","field_data_value":[{" field_value":"539325753445693","field_text":"下列选项一"}]}'

返回示例:

 {
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.5、查询工单分类关联的工单模板

接口说明:

返回工单分类关联的工单模板中的自定义字段信息

请求方式:

GET

请求地址:

/api/ws/5/ticket/query_fileds_by_typeid

请求参数:

参数 类型 必填 名称
ticket_typeid String 工单分类ID

返回参数:

参数 类型 必填 名称
ret_code String 返回编码
ret_msg String 返回信息
items List 返回集合

items对象:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_name String 自定义字段名称
field_type String 自定义字段类型 1单行文本,2多行文本,3日期,4时间,5 数值,6下拉列表,7复选框,8单选框
fill_flag String 自定义字段是否必填 0 否 1 是
field_data_list List 选择型字段的选项信息

field_data_list集合:

参数 类型 必填 名称
data_name String 自定义字段选项名称
data_value String 自定义字段选项CODE值

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/query_fileds_by_typeid
?ticket_typeid=75c5b76905054a0bad862d0e725570e9

返回示例:

{
    "items": [
        {
            "field_data_list": [
                {
                    "data_name": "999",
                    "data_value": "540264609760473"
                },
                {
                    "data_name": "777",
                    "data_value": "540264668320333"
                },
                {
                    "data_name": "888",
                    "data_value": "540264668320352"
                }
            ],
            "field_name": "下拉列表",
            "field_type": 6,
            "fieldid": "3ceef648f3d6412abdf8fd6aac5db9f3",
            "fill_flag": 1
        },
        {
            "field_data_list": [
                {
                    "data_name": "语文",
                    "data_value": "500862751814255"
                },
                {
                    "data_name": "数学",
                    "data_value": "500862751819356"
                },
                {
                    "data_name": "英语",
                    "data_value": "502372726676614"
                }
            ],
            "field_name": "复选",
            "field_type": 7,
            "fieldid": "8f52d2f19fad4a8eae22238437817b9c",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "测试234",
            "field_type": 5,
            "fieldid": "d1dc7e1e13794cf1a936d74b76c4ecc0",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "时间",
            "field_type": 4,
            "fieldid": "4e1e6b21b433461d9bac2cee6d3297d1",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "日期",
            "field_type": 3,
            "fieldid": "30b5071f2b514d57b6d34e7c95cdf431",
            "fill_flag": 0
        },
        {
            "field_data_list": [],
            "field_name": "567",
            "field_type": 2,
            "fieldid": "c2610afb04014d788e398324f7f01329",
            "fill_flag": 0
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功!"
}

# 2.6、创建工单(客户)

接口说明:

  1. 1)调用此接口,系统会根据提交的参数按此优先级“客户ID > 对接ID > 客户邮箱 > 客户手机号”查找客户,如果匹配成功,用该客户作为工单关联客户,否则新建客户后关联。

备注:

1、此处所传工单自定义字段,必须是所传工单分类id关联工单模板中的自定义字段。 2、分类关联模板中的自定义字段通过“查询工单分类关联的工单模板信息“接口获取。 3、工单分类ID需要调用“查询数据字典”中工单分类获取具体值。 4、如需上传附件,需要调用“附件上传(客户)”进行。

请求方式:

POST

请求地址:

/api/ws/5/ticket/save_user_ticket

请求参数:

参数 类型 必填 名称 备注
companyid String 企业ID
ticket_title String 工单标题
userid String 客户ID
partnerid String 对接ID
ticket_content String 工单问题描述
user_emails String 客户邮箱
user_tels String 客户电话
ticket_typeid String 工单分类ID 叶子节点的分类ID
ticket_from String 工单来源 1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言,12 邮件留言,13语音留言,16微信小程序客户留言,17企业微信客户留言
file_str String 附件路径 多个附件,附件之间采用英文分号";"隔开
extend_fields List 工单自定义字段信息

extend_fields集合:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_value String 自定义字段值

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
ticketid String 工单ID

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/save_user_ticket -X POST -H 'content-type: application/json' -H 'token:4ac37cb2e9c740dba4b75a34d5358802' -d '{"companyid":"acb290d666814d65834c70073aed65f2","ticket_title":"测试工单","userid":"007e447e1c104583971c2e990df0d4ac","ticket_content":"测试工单",,"ticket_typeid":"4112bddd39cd4895808180f139cd497a",   "ticket_from":"1","extend_fields":[{"fieldid":"5ba3741d772c47d9a3066db1d3900b4e","field_value":"123"},{"fieldid":"3ceef648f3d6412abdf8fd6aac5db9f3","field_value":"539325753445693"}}'

返回示例:

{
    "item": {
        "ticketid": "5c4015d7bf71493db4a53a2877a1ae98"
    },
    "items": [],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.7、创建工单(坐席)

接口说明:

坐席创建工单并把工单关联到相对应的客户下

备注:

1、此处所传工单自定义字段,必须是所传工单分类id关联工单模板中的自定义字段。 2、分类关联模板中的自定义字段通过“查询工单分类关联的工单模板信息“接口获取。 3、工单分类ID需要调用“查询数据字典”中工单分类获取具体值。 4、如需上传附件,需要调用“附件上传(坐席)”进行。

请求方式:

POST

请求地址:

/api/ws/5/ticket/save_agent_ticket

请求参数:

参数 类型 必填 名称 备注
companyid String 企业ID
ticket_title String 工单标题
userid String 客户ID
ticket_content String 工单问题描述
ticket_from String 工单来源 0工单中心,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台 14微信小程序-在线工作台,15企业微信-在线工作台
deal_groupid String 受理技能组ID
deal_group_name String 受理技能组名称
deal_agentid String 受理坐席ID
deal_agent_name String 受理坐席名称
create_agentid String 创建坐席ID
create_agent_name String 创建坐席名称
recordid String 记录ID 呼叫记录ID或会话记录ID
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_level String 工单优先级 0低,1中,2高,3紧急
ticket_typeid String 工单分类ID 叶子节点的分类ID
file_str String 附件路径 多个附件,附件之间采用英文分号";"隔开
copy_agent List 抄送坐席
extend_fields List 工单自定义字段信息

copy_agent 集合:

参数 类型 必填 名称 备注
agent_name String 坐席名称
agent_mail String 坐席邮箱

extend_fields集合:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_value String 自定义字段值

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
ticketid String 工单ID

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/save_agent_ticket -X POST -H 'content-type: application/json' 
-H 'token:4ac37cb2e9c740dba4b75a34d5358802' 
-d '{"companyid":"acb290d666814d65834c70073aed65f2","ticket_title":"测试工单","userid":"007e447e1c104583971c2e990df0d4ac","ticket_content":"测试工单","ticket_status":"1","ticket_level":"0","create_agentid ":"0a37c8156d094311890e48fbc06501c4","create_agent_name":"ming",
"ticket_typeid":"4112bddd39cd4895808180f139cd497a","ticket_from":"0","extend_fields":[{"fieldid":"5ba3741d772c47d9a3066db1d3900b4e","field_value":"123"},{"fieldid":"3ceef648f3d6412abdf8fd6aac5db9f3","field_value":"539325753445693"}]}'

返回示例:

{
    "item": {
        "ticketid": "5c4015d7bf71493db4a53a2877a1ae98"
    },
    "items": [],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.8、回复工单(客户)

接口说明:

  1. 1)客户:客户可回复所有人
  2. 2)坐席:坐席回复分为仅回复坐席和回复所有人。

请求方式:

POST

请求地址:

/api/ws/5/ticket/save_user_reply

请求参数:

参数 类型 必填 名称 备注
ticketid String 工单ID
reply_content String 工单回复内容
file_str String 回复附件路径 多个附件,附件之间采用英文分号";"隔开

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/save_user_reply -X POST -H 'content-type: application/json' 
-H 'token:4ac37cb2e9c740dba4b75a34d5358802' -d '{"ticketid":"acb290d666814d65834c70073aed65f2"," reply_content":"坐席回复工单"}'

返回示例:

 {
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.9、回复工单(坐席)

接口说明:

  1. 1)客户:客户可回复所有人
  2. 2)坐席:坐席回复分为仅回复坐席和回复所有人。

请求方式:

POST

请求地址:

/api/ws/5/ticket/save_ticket_reply

请求参数:

参数 类型 必填 名称 备注
ticket_title String 工单标题
ticket_content String 工单问题描述
ticketid String 工单ID
get_ticket_datetime String 获取工单信息时间 2019-09-19 13:00:00 (当前时间)
reply_content String 工单回复内容
reply_type String 工单回复类型 0 所有人可见,1 仅坐席可见
deal_groupid String 受理技能组ID
deal_group_name String 受理技能组名称
deal_agentid String 受理坐席ID
deal_agent_name String 受理坐席名称
reply_agentid String 回复坐席ID 指当前处理回复的坐席
reply_agent_name String 回复坐席名称
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_level String 工单优先级 0低,1中,2高,3紧急
reply_file_str String 回复附件路径 多个附件,附件之间采用英文分号";"隔开
copy_agent List 抄送坐席
extend_fields List 工单自定义字段信息

copy_agent集合:

参数 类型 必填 名称 备注
agent_name String 坐席名称
agent_mail String 坐席邮箱

extend_fields集合:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_value String 自定义字段值

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/save_ticket_reply -X POST 
-H 'content-type: application/json' 
-H 'token:4ac37cb2e9c740dba4b75a34d5358802' -d '{"ticketid":"acb290d666814d65834c70073aed65f2","ticket_title":"测试工单","reply_content":"坐席回复工单","ticket_content":"测试工单"," reply_type":"0","ticket_status":"1","ticket_level":"0",
"get_ticket_datetime":"2019-09-19 13:00:00","reply_agentid ":"0a37c8156d094311890e48fbc06501c4","reply_agent_name ":"ming","copy_agent":[{"agent_name":"工单坐席","agent_mail ":"3443355456@qq.com"}],"reply_agentid ":"0a37c8156d094311890e48fbc06501c4","reply_agent_name":"ming",  "extend_fields":[{"fieldid":"5ba3741d772c47d9a3066db1d3900b4e","field_value":"123"},{"fieldid":"3ceef648f3d6412abdf8fd6aac5db9f3","field_value":"539325753445693"}]}'

返回示例:

 {
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.10、附件上传(客户)

接口说明:

客户创建工单或回复工单时,上传一个或多个附件。 先上传附件,再调用“创建工单(客户)”或者“回复工单(客户)”。

备注:

1、在请求中注明Content-Type: multipart/form-data;boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

请求方式:

POST

请求地址:

/api/ws/5/ticket/user_upload_file

请求参数:

参数 类型 必填 名称 备注
file IO流 文件流 选择要上传的文件
file_num_key String 上传文件标识 随机生成的值,用于判断上传文件数量

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
file_url String 文件路径

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/user_upload_file -X POST-H 'content-type:multipart/form-data;boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' -F 'file=@/ C:/Users/Pictures/微信图片_20190528114613.jpg ' -F 'file_num_key=16dfc20e-f3de-46tf-8088-844cfde704d3'

返回示例:

{
   "item": {   
"file_url":"https://sobot.oss-cn-beijing.aliyuncs.com/console/acb290d666814d65834c70073aed65f2/ticket/微信图片_20190528114613.jpg"
   },
   "ret_code": "000000",
   "ret_msg": "操作成功"
}

# 2.11、附件上传(坐席)

接口说明:

坐席创建工单或回复工单时,上传一个或多个附件 先上传附件,再调用“创建工单(坐席)”或者“回复工单(坐席)”

备注:

1、在请求中注明Content-Type: multipart/form-data;boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

请求方式:

POST

请求地址:

/api/ws/5/ticket/upload_file

请求参数:

参数 类型 必填 名称 备注
file IO流 文件流 选择要上传的文件
file_num_key String 上传文件标识 随机生成的值,用于判断上传文件数量

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
file_url String 文件路径

请求示例:

curl https://www.sobot.com/api/ws/5/ticket/upload_file -X POST -H 'content-type:multipart/form-data;boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' -F 'file=@/ C:/Users/Pictures/微信图片_20190528114613.jpg' -F 'file_num_key=16dfc20e-f3de-46tf-8088-844cfde704d3'

返回示例:

{
   "item": {   
        "file_url":"https://sobot.oss-cn-beijing.aliyuncs.com/console/acb290d666814d65834c70073aed65f2/ticket/微信图片_20190528114613.jpg"
   },
   "ret_code": "000000",
   "ret_msg": "操作成功"
}

# 2.12、查询工单列表

接口说明:

按照工单创建时间段查询工单列表信息

请求方式:

GET

请求地址:

/api/ws/5/ticket/query_tickets

请求参数:

参数 类型 必填 名称 备注
create_start_datetime String 工单创建开始时间 2018-09-18 00:00:00
create_end_datetime String 工单创建结束时间 2018-09-18 23:59:59(查询创建时间段不能大于一个月)
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_from String 工单来源 0工单中心,1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台,12 邮件留言,13语音留言,14微信小程序-在线工作台,15企业微信-在线工作台,16微信小程序客户留言,17企业微信客户留言
ticket_typeid String 工单分类ID
userid String 客户ID
deal_agentid String 受理坐席ID
page_no Integer 当前页数 默认第一页
page_size Integer 当前页显示条数 默认每页显示15条,最大每页显示50条

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
items List 返回集合
page_no Integer 当前页数
page_size Integer 当前页显示条数
page_count Integer 总页数
total_count Integer 总条数

items集合:

参数 类型 必填 名称 备注
ticketid String 工单ID
ticket_title String 工单标题
titicket_type_name String 工单分类 显示格式:一级/二级/三级
ticket_content String 问题描述
ticket_code String 工单编号
ticket_from String 工单来源 0工单中心,1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台,12 邮件留言,13语音留言,14微信小程序-在线工作台,15企业微信-在线工作台,16微信小程序客户留言,17企业微信客户留言
ticket_level String 工单优先级 0低,1中,2高,3紧急
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
start_type String 工单发起人类型 0坐席,1客户
start_name String 工单发起人名称
deal_agent_name String 受理坐席名称
deal_group_name String 受理技能组名称
create_datetime String 工单创建时间 2018-09-18 12:00:00
update_datetime String 工单更新时间 2018-09-18 13:00:00
user_nick String 客户昵称
user_name String 客户名称
user_tels String 客户电话 多个电话号码,号码之间采用英文逗号","隔开
user_emails String 客户邮箱 多个邮箱,邮箱之间采用英文逗号","隔开

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/query_tickets? create_start_datetime=2018-09-18 00:00:00&create_end_datetime=2018-09-18 23:59:59

返回示例:

 {
    "items": [
        {
            "create_datetime": "2018-09-18 09:10:05",
            "deal_group_name": "",
            "deal_agent_name": "",
            "start_name": "测试标签",
            "start_type": "1",
            "ticket_code": "20190912000007",
            "ticket_content": "测试工单",
            "ticket_from": "1",
            "ticket_level": "0",
            "ticket_status": "1",
            "ticket_title": "测试工单",
            "ticket_type_name": "其他",
            "ticketid": "b6dacd72a5cf4e2999e78a18a9126c72",
            "update_datetime":"2018-09-18 09:15:55",
            "user_nick": "测试标签"
        },
        {
            "create_datetime":"2018-09-18 08:14:05",
            "deal_group_name": "",
            "deal_agent_name": "",
            "start_name": "测试标签",
            "start_type": "1",
            "ticket_code": "20190912000006",
            "ticket_content": "测试工单",
            "ticket_from": "1",
            "ticket_level": "0",
            "ticket_status": "1",
            "ticket_title": "测试工单",
            "ticket_type_name": "其他",
            "ticketid": "266a341702ef40d595915a3c19676745",
            "update_datetime":"2018-09-18 08:20:05",
            "user_nick": "测试标签"
        },
        {
            "create_datetime":"2018-09-18 07:34:25",
            "deal_group_name": "123",
            "deal_agent_name": "ming",
            "start_name": "智齿测试12",
            "start_type": "0",
            "ticket_code": "20190912000003",
            "ticket_content": "<p>34433434</p>",
            "ticket_from": "0",
            "ticket_level": "0",
            "ticket_status": "0",
            "ticket_title": "4343",
            "ticket_type_name": "其他",
            "ticketid": "f294176887284c5597794c636d5a1bfe",
            "update_datetime":"2018-09-18 07:54:35",
            "user_emails": "wangxun0104@hotmail.com",
            "user_name": "王迅",
            "user_nick": "王迅",
            "user_tels": "18280240680"
        }
    ],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "ret_code": "000000",
    "ret_msg": "操作成功",
    "total_count": 3
}

# 2.13、查询工单详情页

接口说明:

返回该条工单的详细信息(包括工单回复、操作历史)。

请求方式:

GET

请求地址:

/api/ws/5/ticket/get_ticket_by_id

请求参数:

参数 类型 必填 名称 备注
ticketid String 工单ID

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
companyid String 公司ID
ticketid String 工单ID
ticket_code String 工单编号
ticket_title String 工单标题
ticket_content String 工单问题描述
ticket_from String 工单来源 0工单中心,1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台,12 邮件留言,13语音留言,14微信小程序-在线工作台,15企业微信-在线工作台,16微信小程序客户留言,17企业微信客户留言
ticket_level String 工单优先级 0低,1中,2高,3紧急
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_type_name String 工单分类名称
start_type String 工单发起人类型 0坐席,1客户
start_name String 工单发起人名称
deal_group_name String 工单受理技能组名称
deal_agent_name String 工单受理坐席名称
userid String 工单关联客户ID
user_nick String 客户昵称
user_name String 客户名称
user_tels String 客户电话 多个电话号码,号码之间采用英文逗号","隔开
user_emails String 客户邮箱 多个邮箱,邮箱之间采用英文逗号","隔开
update_agent_name String 工单更新人名称
create_datetime String 工单创建时间 2018-09-18 10:14:05
update_datetime String 工单更新时间 2018-09-18 10:34:45
file_list List 附件
extend_fields_list List 工单自定义字段
deal_list List 工单全部回复
update_log_list List 工单操作记录

extend_fields_list集合:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_name String 自定义字段名称
field_type String 自定义字段类型 1单行文本,2多行文本,3日期,4时间,5 数值,6下拉列表,7复选框,8单选框
field_text String 选择型字段选项文本值
field_value String 自定义字段值

deal_list集合:

参数 类型 必填 名称 备注
reply_title String 回复标题
reply_content String 回复内容
reply_type String 回复类型 0 所有人可见 1 仅坐席所见
reply_datetime String 回复时间 2018-09-18 10:34:45
start_type String 回复人类型 0 坐席 1 客户
update_user_name String 回复人名称
face_img String 回复人头像
file_list List 回复附件

update_log_list集合:

参数 类型 必填 名称 备注
update_title String 操作记录标题
update_content String 操作记录内容
log_from String 操作记录来源 1 页面操作,2 流转触发器,3 定时触发器
update_datetime String 操作记录时间 2018-09-18 10:34:45
start_type String 操作人类型 0 坐席 1 客户
update_agent_name String 操作人名称
face_img String 操作人头像

file_list集合:

参数 类型 必填 名称 备注
file_name String 附件名称
file_url String 附件路径
file_type String 附件类型

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' -dhttps://www.sobot.com/api/ws/5/ticket/get_ticket_by_id?ticketid=ebe6a8b6bcf840418b8e58d123262945

返回示例:

{
    "item": {
        "companyid": "acb290d666814d65834c70073aed65f2",
        "create_datetime": "2018-09-18 10:14:05",
        "deal_group_name": "",
        "deal_list": [
            {
                "face_img": "https://sobot.oss-cn-beijing.aliyuncs.com/console/acb290d666814d65834c70073aed65f2/userImage/201801151617381.PNG",
                "file_list": [
                    {
                        "file_name": "微信图片_20190528114613.jpg",
                        "file_type": "jpg",
                        "file_url": "https://sobot.oss-cn-beijing.aliyuncs.com/console/acb290d666814d65834c70073aed65f2/ticket/微信图片_20190528114613_1568614560169.jpg"
                    }
                ],
                "reply_content": "<p>343</p>",
                "reply_datetime":"2018-09-18 10:34:45",
                "reply_title": "回复 北京客户 ",
                "reply_type": "0",
                "start_type": "0",
                "update_user_name": "智齿测试12"
            }
        ],
        "deal_agent_name": "智齿测试12",
        "extend_fields_list": [
            {
                "field_name": "下拉列表",
                "fieldid": "3ceef648f3d6412abdf8fd6aac5db9f3",
                "field_type": "6",
                "field_text": "999",
                "field_value": "540264609760473"
            },
            {
                "field_name": "时间",
                "fieldid": "4e1e6b21b433461d9bac2cee6d3297d1",
                "field_type": "4",
                "field_text": "",
                "field_value": "00:00"
            },
            {
                "field_name": "测试234",
                "fieldid": "d1dc7e1e13794cf1a936d74b76c4ecc0",
                "field_type": "1",
                "field_text": "",
                "field_value": "455445"
            }
        ],
        "file_list": [],
        "start_name": "北京客户",
        "start_type": "1",
        "ticket_code": "1534758910",
        "ticket_content": "<p>测试用</p>",
        "ticket_from": "1",
        "ticket_level": "0",
        "ticket_status": "2",
        "ticket_title": "客户留言-北京客户",
        "ticket_type_name": "咨询/咨询1/咨询2",
        "ticketid": "d6aef19dca6b4ee5b9dc4206d8162105",
        "update_log_list": [
            {
                "face_img": "https://sobot.oss-cn-beijing.aliyuncs.com/console/acb290d666814d65834c70073aed65f2/userImage/201801151617381.PNG",
                "log_from": "1",
                "start_type": "0",
                "update_content": "{\"回复\":\"343\",\"回复附件\":\"微信图片_20190528114613.jpg\"}",
                "update_agent_name": "智齿测试12",
                "update_datetime":"2018-09-18 10:34:45",
                "update_title": "工单更新"
            },
            {
                "face_img": "https://img.sobot.com/console/common/face/user.png",
                "log_from": "1",
                "start_type": "1",
                "update_content": "{\"工单分类\":\"咨询/咨询1/咨询2\",\"工单标题\":\"客户留言-北京客户\",\"问题描述\":\"测试用\",\"自定义字段\":\"下拉列表:;复选:;测试2:;单选:;测试1:\",\"优先级\":\"低\",\"工单状态\":\"尚未受理\"}",
                "update_datetime": "2018-09-18 10:14:05",
                "update_title": "工单创建"
            }
        ],
        "update_datetime": "2018-09-18 10:34:45",
        "user_nick": "北京客户",
        "userid": "fdd41fb55c4f41e4afa4906064deced3"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.14、查询工单统计概览

接口说明:

获取某个时间段工单对应的数量。

请求方式:

GET

请求地址:

/api/ws/5/ticket/get_ticket_data

请求参数:

参数 类型 必填 名称 备注
start_datetime String 开始时间 2019-09-18 00:00:00
end_datetime String 结束时间 2019-09-18 23:59:59

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
item Object 返回对象

item对象:

参数 类型 必填 名称 备注
unassigned_ticket_num String 未分配工单数量
unsolved_ticket_num String 未解决工单数量

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/get_ticket_data?start_datetime= 2019-09-18 00:00:00&end_datetime=2019-09-18 23:59:59

返回示例:

 {
    "item": {
        "unassigned_ticket_num": "2",
        "unsolved_ticket_num": "3"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.15、查询工单坐席工作量

接口说明:

获取某个时间段工单坐席工作量。

请求方式:

GET

请求地址:

/api/ws/5/ticket/query_agent_jobs

请求参数:

参数 类型 必填 名称 备注
start_datetime String 开始时间 2019-09-18 00:00:00
end_datetime String 结束时间 2019-09-18 23:59:59

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
items List 返回集合

Items集合:

参数 类型 必填 名称 备注
agentid String 坐席ID
agent_name String 坐席名称
deal_ticket_num String 处理工单数量
ticket_end_rate String 工单完结率

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/query_agent_jobs?start_datetime= 2019-09-18 00:00:00&end_datetime=2019-09-18 23:59:59

返回示例:

 {
    "items": [
        {
            "deal_ticket_num": "1",
            "agent_name": "智齿测试12",
            "agentid": "efcfda336b5d4caeb4fd71392c54b5c9",
            "ticket_end_rate": "0.0"
        },
        {
            "deal_ticket_num": 0,
            "agent_name": "ming",
            "agentid": "0a37c8156d094311890e48fbc06501c4",
            "ticket_end_rate": "0.0"
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.16、查询工单消息推送异常数据

接口说明:

返回工单消息推送失败的数据

请求方式:

GET

请求地址:

/api/ws/5/ticket/query_ticket_push_fail_infos

请求参数:

参数 类型 必填 名称 备注
start_datetime String 开始时间 2020-04-08 00:00:00
end_datetime String 结束时间 2020-04-08 23:59:59
page_no Integer 当前页数 默认第一页
page_size Integer 当前页显示条数 默认每页显示15条,最大每页显示50条

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
items List 返回集合
page_no Integer 当前页数
page_size Integer 当前页显示条数
page_count Integer 总页数
total_count Integer 总条数

items对象:

参数 类型 必填 名称 备注
ticketid String 工单ID
companyid String 公司ID
ticket_title String 工单标题
ticket_content String 问题描述
ticket_code String 工单编号
ticket_from String 工单来源 0工单中心,1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台,12 邮件留言,13语音留言,14微信小程序-在线工作台,15企业微信-在线工作台,16微信小程序客户留言,17企业微信客户留言
ticket_level String 工单优先级 0低,1中,2高,3紧急
ticket_status String 工单状态 0尚未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_type_name String 工单分类名称 显示格式:一级/二级/三级
deal_agentid String 受理坐席ID
deal_agent_name String 受理坐席名称
deal_groupid String 受理技能组ID
deal_group_name String 受理技能组名称
reply_content String 工单回复内容
update_datetime String 工单更新时间 2020-04-08 13:00:00
update_agent_name String 操作坐席名称
userid String 工单关联客户ID
user_nick String 客户昵称
user_name String 客户名称
user_tels String 客户电话 多个电话号码,号码之间采用英文逗号,隔开
user_emails String 客户邮箱 多个邮箱,邮箱之间采用英文逗号,隔开
recordid String 工单关联记录ID 工单来源是呼叫中心这个是呼叫记录ID,来源是在线工作台-PC客服提交这个是会话记录ID
file_str String 附件路径
voice_url String 录音文件
hope_accept_time String SLA规定的首次解决时间 2020-04-08 13:00:00
hope_complete_time String SLA规定的首次解决时间 2020-04-08 13:00:00
is_reminder String 催单信息标识 是否催单信息 0 否 1 是
reminder_agentid String 催单坐席id
reminder_agent_name String 催单坐席名称
reminder_remark String 催单备注
reminder_time String 催单时间 具体的时间点,例如2020-04-20 12:35:30
partnerid String 关联客户对接id
extend_fields_list List 工单自定义字段

extend_fields_list集合:

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_name String 自定义字段名称
field_type String 自定义字段类型 1单行文本,2多行文本,3日期,4时间,5 数值,6下拉列表,7复选框,8单选框
field_text String 选择型字段选项文本值
field_value String 自定义字段值

请求示例:

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/ws/5/ticket/query_ticket_push_fail_infos
?start_datetime= 2020-04-08 00:00:00&end_datetime=2020-04-08 23:59:59

返回示例:


{
 "items": [
      {
        "companyid": "40d8940f1e854642b41f7c21f790b8e3",
        "deal_agent_name": "",
        "deal_agentid": "",
        "deal_group_name": "",
        "deal_groupid": "",
        "extend_fields_list": [],
        "file_str": "",
        "hope_accept_time": "",
        "hope_complete_time": "",
        "partnerid": "test_lily",
         "recordid": "",
        "ticket_code": "20200326000002",
        "ticket_content": "<p>lily的工单中心</p>",
        "ticket_from": "0",
        "ticket_level": "0",
        "ticket_status": "0",
        "ticket_title": "停服务后创建工单",
        "ticketid": "4c38229b83bd4101a09612b9ac26baf7",
        "update_agent_name": "小丽",
        "user_name": "VIP客户",
        "userid": "11a1e8a4a8e9480a8f409dc2a130431f",
        "is_reminder": "0",
        "voice_url": ""
      },
      {
        "companyid": "40d8940f1e854642b41f7c21f790b8e3",
        "deal_agent_name": "在线203",
        "deal_agentid": "587d3293ff794d7785a33d9a0695ea32",
        "deal_group_name": "",
        "deal_groupid": "",
        "extend_fields_list": [
          {
            "field_name": "RIO--下拉列表",
            "field_text": "77",
            "field_type": "6",
            "field_value": "121",
            "fieldid": "6cb4450292d34720877f6083514ca6fb"
          },
            {
            "field_name": "时间",
            "field_type": "4",
            "field_value": "09:00",
            "fieldid": "22696682739c4fd7a68094eeed34a8a9"
          }
         ],
         "file_str": "",
         "hope_accept_time": "",
         "hope_complete_time": "",
         "partnerid": "sdk284",
         "recordid": "",
         "ticket_code": "20200326000001",
         "ticket_content": "三个好感动",
         "ticket_from": "4",
         "ticket_level": "0",
         "ticket_status": "1",
         "ticket_title": "重复点击回复",
         "ticketid": "2831ceace38c45649840374a08d321bd",
         "update_agent_name": "小丽",
         "userid": "9a4da303f00b4f5295459070edb6b34a",
         "voice_url": ""
        },
        {
           "ticketid":"23ddfbcd7de8472c93e4385d6195dfd5",
           "companyid":"40d8940f1e854642b41f7c21f790b8e3",
           "ticket_code": "202004200000001",
           "is_reminder": "1",
           "reminder_agentid":"587d3293ff794d7785a33d9a0695ea32",
           "reminder_agent_name": "在线203",
           "reminder_remark": "催单信息",
           "reminder_time": "2020-04-20 12:35:30",
           "update_datetime": "2020-04-20 12:35:30"
        }
    ],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "ret_code": "000000",
    "ret_msg": "操作成功",
    "total_count": 2
}

# 3、工单消息转发

该功能消息格式为json格式;实时消息推送配置将在次日凌晨零点开始生效。

实时消息推送需要客户提供数据接收接口,例如 https://xxxxxxx.xxxxxx.com/sobot/message,所有的类型的数据使用相同的地址。

# 3.1、工单信息

# 3.1.1content对象

参数 类型 必填 名称 备注
companyid String 企业ID 适用一个公司多个超管帐号或者多个分公司需要分别统计的情况
ticketid String 工单ID
ticket_code String 工单编号
ticket_title String 工单标题 最大长度为100
ticket_content String 问题描述 最大长度为5000
ticket_type_name String 工单分类名称 多级分类之间用/分隔
ticket_status String 工单状态 0未受理,1受理中,2等待回复,3已解决,99已关闭,98已删除
ticket_level String 工单级别 0低,1中,2高,3紧急
ticket_from String 工单来源 0工单中心,1 PC客户留言,2 H5客户留言,3 微信公众号客户留言,4 APP客户留言 ,6 PC-在线工作台,7客户中心,8呼叫中心,9微信公众号-在线工作台,10 H5-在线工作台,11 APP-在线工作台,12 邮件留言,13语音留言,14微信小程序-在线工作台,15企业微信-在线工作台,16微信小程序客户留言,17企业微信客户留言
file_str String 附件路径 多个附件之间用分号分隔
deal_groupid String 受理客服组ID
deal_group_name String 受理客服组名称
deal_agentid String 受理客服ID
deal_agent_name String 受理客服名称
copy_agent String 抄送客服
hope_accept_time String SLA规定的首次解决时间 具体的时间点,例如2019-11-11 13:01:30
hope_complete_time String SLA规定的首次解决时间 具体的时间点,例如2019-11-11 13:05:00
userid String 关联客户ID
user_nick String 关联客户昵称
user_name String 关联客户真实姓名
user_tels String 关联客户电话 多个电话之间以分号分隔
user_emails String 关联客户邮箱 多个邮箱之间以分号分隔
partnerid String 关联客户对接ID
recordid String 记录ID 工单来源是呼叫中心这个是呼叫记录ID,来源是在线工作台-PC客服提交这个是会话记录ID
update_name String 更新人名称 当前编辑工单或回复工单的操作人姓名
update_time String 更新时间 当前编辑工单保存或回复工单提交的时间具体的时间点,例如2019-11-11 12:00:30
reply_content String 回复内容 回复工单的内容
is_reminder String 催单信息标识 是否催单信息 0 否 1 是
reminder_agentid String 催单坐席id
reminder_agent_name String 催单坐席名称
reminder_remark String 催单备注
reminder_time String 催单时间 具体的时间点,例如2020-04-20 12:35:30
extend_fields_list List 工单自定义字段集合

extend_fields_list集合

参数 类型 必填 名称 备注
fieldid String 自定义字段ID
field_type String 自定义字段类型 1单行文本 2多行文本 3日期 4时间 5数值 6下拉列表 7复选框 8 单选框
field_name String 自定义字段名称
field_value String 自定义字段值
field_text String 选择型字段选项文本值

# 3.1.2返回内容

参数 类型 必填 名称 备注
sys_code String 产品编码 4
type String 消息类型 ticket
content List 消息内容

# 3.1.3返回示例

非催单信息

{
    "sys_code": "4",
    "type": "ticket",
    "content": [
        {
            "companyid": "5cc2c708202d4defaf72d4bcac362a55",
            "ticketid": "56b7954e8ff1428ea39cd5a8136de9e1",
            "ticket_code": "20191111000001",
            "ticket_title": "测试工单",
            "ticket_content": "测试工单",
            "ticket_type_name": "咨询",
            "ticket_status": "0",
            "ticket_level":"0",
            "ticket_from":"0",
            "file_str": "",
            "deal_groupid": "5436dc5288b645188aedc2a21f66a4ba",
            "deal_group_name": "咨询客服组",
            "deal_agentid": "0a37c8156d094311890e48fbc06501c4",
            "deal_agent_name": "ming",
            "copy_agent": "",
            "hope_accept_time": "2019-11-11 13:01:30",
            "hope_complete_time": "2019-11-11 13:05:00",
            "userid": "3dff300e008f4c4a8c399751ddb7b8cc",
            "user_nick": "北京客户",
            "partnerid": "",
            "recordid": "",
            "reply_content": "回复工单",
            "update_name": "客服一",
            "update_time": "2019-11-11 12:00:30",
            "is_reminder": "0",
            "extend_fields_list": [ {
               "fieldid": "1",
               "field_type": 1,
               "field_text": "",
               "field_name": "微信",
               "field_value": "21332112"
            },
            {
               "fieldid": "4",
               "field_type": 6,
               "field_text": "下拉一",
               "field_name": "下拉列表",
               "field_value": "500862697708553"  
            }]
        }
    ]
}

催单信息

{
    "sys_code": "4",
    "type": "ticket",
    "content": [
        {
            "companyid": "5cc2c708202d4defaf72d4bcac362a55",
            "ticketid": "56b7954e8ff1428ea39cd5a8136de9e1",
            "ticket_code": "20191111000001",
            "is_reminder": "1",
            "reminder_remark": "回复工单",
            "reminder_agentid": "0a37c8156d094311890e48fbc06501c4",
            "reminder_agent_name": "客服一",
            "reminder_time": "2020-04-20 12:00:30",
            "update_time": "2020-04-20 12:00:30"
        }
    ]
}

# 请求响应示例

按此响应示例对接可进行消息确认,便于双方统计到的数据进行对比

 { 
     "data":{ 
        "receiveTime":"20191209115658" 
     }, 
     "retCode":"000000", 
     "retMsg":"数据接收成功" 
}
//retCode返回000000时,表示数据接收成功 retMsg 和 data 为可选字段,备用,可以为空,例如: { "data":{}, "retCode":"000000", "retMsg":"" }

# 4、错误编码

# 4.1、操作成功

业务操作成功。

错误编码 错误说明
000000 操作成功(除此编码以外的编码为错误编码)

# 4.2、系统异常

系统服务异常。

错误编码 错误说明
900001 token为空
900002 token已失效,请重新获取
900003 signature错误
900004 没有找到公司的api配置信息
999999 系统未知异常

# 4.3、业务异常

业务异常。

错误编码 错误说明
400001 创建时间不能为空
400002 创建结束时间不能小于创建开始时间
400003 查询创建时间段不能超过一个月
400004 请求参数不能为空
400005 时间格式不正确
400006 操作坐席ID不能为空
400007 操作坐席ID不正确
400008 工单分类ID不能为空
400009 工单状态不能为空
400010 工单来源不能为空
400011 工单级别不能为空
400012 技能组ID不能为空
400013 受理客服组与受理客服不匹配