在线客服 API

接口声明

在调用接口时必须在 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 来传达，目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。
3、开发者需要根据接口返回的 Token 失效提示，进行重新获取 Token。

接口调用

● 获取访问 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": "操作成功"
}

● 请求人工客服

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口以用户的身份来发起用户和客服之间的会话请求，并建立会话。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/chat_connect

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
partnerid	String	是	企业自己的用户 id，可自行传值
source	String	否	客户来源：0-pc、1-微信、2-sdk、3-微博、4-h5
agentid	String	否	指定客服的 id
tran_flag	String	否	是否必须转入指定客服：1-是、0-否
groupid	String	否	指定技能组
params	String（json）	否	自定义参数
user_tels	String	否	用户电话
user_emails	String	否	用户邮箱
user_name	String	否	用户真实姓名
user_nick	String	否	用户昵称
user_img	String	否	用户头像

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item对象：

参数	类型	必填	描述
status	Integer		状态：-1 ：重复请求，拒绝处理、0：排队、1：成功、2：无客服、3：在黑名单
agent_name	String		客服姓名
agent_face	String		客服头像
agentid	String		客服 id
visitorid	String		用户 id
cid	String		会话 id
count	Integer		排队位置

请求示例：

curl  https://www.sobot.com/api/chat/5/user/chat_connect 
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	 
    "partnerid" : "123",
    "source" : "0",
    "agentid " : "61673ee8d98d4282a95cdad38ffd5f5b ",
    "tran_flag" : "1",
    "params" : "{\\"name\\":\\"lxl\\",\\"age\\":18}",
    "user_tels" : "13778967890;13278907890",
    "user_emails" : "xiaoming@1com; xiaoming2@1com",
    "user_img":"https://sobot-www.oss-cn-beijing.aliyuncs.com/0019JPG",
    "user_name" : "小明"
    }'

返回示例：

{
  "item": {
    "status": 1,
    "visitorid" :"fdd445a5b10f303297752dc3625db648",
    "agent_name" :"在线客服", 
    "agent_face":"https://sobot-www.oss-cn-beijing.aliyuncs.com/61125123PNG", 
    "agentid":"61673ee8d98d4282a95cdad38ffd5f5b", 
    "cid":"eca9155a77384d64bb64a132e8459b7e"
  },
  "ret_code": "000000",
  "ret_msg": "成功"
}

● 客户咨询客服

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口以用户的身份给客服发送消息。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/chat_send

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
partnerid	String	是	企业自己的用户 id，可自行传值
content	String	是	用户问题
msg_type	String	否	消息类型 （text、image、voice、默认为 text 纯文本，如果为 image 和 voice 的时候，content 传递图片地址或者音频地址,其中音频支持 mp3、wav 两种格式）

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
status	String		状态：1：成功、2：用户没有跟客服建立连接

请求示例：

curl  https://www.sobot.com/api/chat/5/user/chat_send
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d ' {
    "partnerid": "123",
    "content": "https://bbs.sangfor.com.cn/data/attachment/sfchat/image/20687/15719849png",
    "msg_type": "image"
} '

返回示例：

{
  "item": {
    "status": "1"
  },
  "ret_code": "000000",
  "ret_msg": "成功"
}

● 客服消息推送

接口说明：

接口类型：回调型接口

接口作用：智齿将客服发送给用户的消息推送至企业预先配置好的回调地址上。

参数说明：

参数	类型	必填	描述
sys_code	String		系统编码 2：在线业务
type	String		消息类型 chat_user_msg:用户接收消息
is_encrypt	String		是否加密，true:加密、false:不加密
content	Object		消息内容 详见下表

消息内容:

参数	类型	必填	描述
msg_code	String		消息编码： 200:客户接入客服、201:客户收到排队位置变更、202:客户收到客服发送的消息、204:客户离线、209:客户收到客服邀请评价的消息
msgid	String		消息 id
msg_type	String		消息类型：text : 文本（包含html标签）、image : 图片
msg	String		消息内容
agentid	String		客服 id
agent_nick	String		客服昵称
agent_face	String		客服头像
partnerid	String		客户对接 id
params	String		客户对接自定义字段
cid	String		会话 id

请求方式：

POST

类型：

1）用户接入会话：

{
    "sys_code":"2",
    "type":"chat_user_msg",
    "is_encrypt":"false",
    "content":{
        "cid":"a3afd241d1064780a508cbf644fc93bd",
        "agent_nick":"在线客服LS186",
        "msgid":"d25f2bfe4f8f4573af5751f6ab61ea70",
        "agent_face":"https://sobot-test.oss-cn-beijing.aliyuncs.com/coPNG",
        "partnerid":"222",
        "msg_code":"200",
        "params":{
            "name":"xiaoming",
            "age":18
        }
    }
}

2）用户收到排队位置变更：

{
    "sys_code":"2",
    "type":"chat_user_msg",
    "is_encrypt":"false",
    "content":{
        "cid":"a3afd241d1064780a508cbf644fc93bd",
        "msg_code":"201",
        "count":"3",
        "msgid":"5646d04350e84f689ca855153c58c0f9",
        "partnerid":"222",
        "params":"{'name':'xiaoming','age': 18}"
    }
}

3）用户收到客服发送的消息：

{
    "sys_code":"2",
    "type":"chat_user_msg",
    "isEncrypt":"false",
    "content":{
        "cid":"a3afd241d1064780a508cbf644fc93bd",
        "msg":"222",
        "agent_nick":"在线客服LS186",
        "msgid":"ab48f1e755ac766d8732501a3ef1a1161573465172716",
        "msg_type":"text",
        "agent_face":"https://sobot-test.oss-cn-beijing.aliyuncs.com/co123PNG",
        "partnerid":"222",
        "msg_code":"202",
        "params":""
    }
}

4）客户离线：

{
    "sys_code":"2",
    "type":"chat_user_msg",
    "is_encrypt":"false",
    "content":{
        "cid":"a3afd241d1064780a508cbf644fc93bd",
        "msg_code":"204",
        "msgid":"eda5990841fc4f42a8a1ea5ef731a0c6",
        "partnerid":"222",
        "params":""
    }
}

5）客户收到客服邀请评价的消息：

{
    "sys_code":"2",
    "type":"chat_user_msg",
    "is_encrypt":"false",
    "content":{
        "agentid":"61673ee8d98d4282a95cdad38ffd5f5b",
        "msg_code":"209",
        "agent_nick":"在线客服LS186",
        "msgid":"68bab5d926334703a8a8c790aa99dd03",
        "partnerid":"222",
        "params":{
            "name":"xiaoming",
            "age":18
        },
        "cid":"83766ca85b3a4159b05b00b82dc12197"
    }
}

● 客户评价

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口执行用户对会话进行满意度评价。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/comment

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
partnerid	String	是	企业自己的用户 id，可自行传值
type	String	是	评价类型：0：评价机器人、1：评价人工
solved	String	是	评价结果：0：未解决、1：已解决
score	String	否	人工评价分数（1、2、3、4、5）
tag	String	否	评价标签，多个用逗号分隔
remark	String	否	评价内容
comment_type	String	否	评价类型：0：邀请评价、1：主动评价

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
status	Integer		状态：0.失败、1.成功、2-已评价、3-无咨询，不能评价
cid	String		会话 ID

请求示例：

curl  https://www.sobot.com/api/chat/5/user/comment 
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
    "partnerid" : "123", 
    "type" : "1", 
    "solved" : "1"
   }'

返回示例：

{
"item": {
    "status": 1,
    "cid":" eca9155a77384d64bb64a132e8459b7e" 
    },
"ret_code": "000000",
"ret_msg": "成功"
}

● 客户结束会话

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来结束某个用户当前的会话。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/out

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
partnerid	字符串	是	企业自己的用户 id，可自行传值

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
status	Integer		状态：1：成功

请求示例：

curl  https://www.sobot.com/api/chat/5/user/out
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	  
    "partnerid" : "123"
}'

返回示例：

{
    "item": {
        "status":1
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询离线消息数据

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取会话已经结束后，客服发送给用户的消息（即离线消息）。开放平台接口对接的用户，由于所有消息都会推送到消息地址中，没有离线消息数据。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/offline_msg_data

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
visitorid	String	是	访客 id
timezone	String	否	时区

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
size	Integer		离线消息数
msg_data	List		客服列表及对应客服发送的消息列表

msg_data 对象：

参数	类型	必填	描述
sender	String		发送者 id
sender_name	String		发送者昵称
send_face	String		发送者头像
msg_list	List		消息列表

msg_list 对象：

参数	类型	必填	描述
cid	String		会话 id
msg	String		消息体
ts	String		发送消息时间
t	String		发送消息时间戳（毫秒级）

请求示例：

curl  https://www.sobot.com/api/chat/5/user/offline_msg_data
-X POST 
-H 'language: zh'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	  
        "visitorid" : "xx",
        "timezone":"Asia/Shanghai"
}'

返回示例：

{
    "item": {
        "size": 2,
        "msg_data":[
        		 {
       		 "sender ": " 61673ee8d98d4282a95cdad38ffd5f5b",
        	 "sender_name": "在线客服",
  			 "sender_face":" https://sobot-www.oss-cn-beijing.aliyuncs.com/console/25123PNG",
       		 "msg_list": [
         			 {
                        "cid": "c36d04f18b4e48eaa88e7a5c93212a0a",
                        "msg": "111",
                        "ts": "2019-10-31 19:13:57",
                        "t": "1572520437000"
                    },
                    {
                        "cid": "c36d04f18b4e48eaa88e7a5c93212a0a",
                        "msg": "222",
                        "ts": "2019-10-31 19:13:59",
                        "t": "1572520437000"
                    }
       			 ]
     		 }
   		 ]
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询客户会话列表

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取某个用户在系统中的会话记录列表（ cid 列表）。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/query_cids

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
visitorid	String	是	访客 id： visitorid 与 partnerid 选择其一
partnerid	String	否	企业自己的用户 id，可自行传值
from	Integer	否	来源：0：开放平台、1：pc/h5/sdk、2：微信
start_time	String	否	开始时间
end_time	String	否	结束时间

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
items	List	否	对象列表

items 对象：

参数	类型	必填	描述
cid	String		会话 ID
start_date_time	Long		会话时间：毫秒
visitorid	String		访客 id

请求示例：

curl  https://www.sobot.com/api/chat/5/user/query_cids
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	  
       "visitorid" : "xx"
}'

返回示例：

{
    "items": [
        {
            "cid": "825a57e755a240559e03deec267e6463",
            "start_date_time": 1568603119126,
            "visitorid": "7f27b999bbe94274ab1a738568aba137"
        },
        {
            "cid": "1874cbc483b64d4b9f1b7f06de083638",
            "start_date_time": 1568613840540,
            "visitorid": "7f27b999bbe94274ab1a738568aba137"
        }    
],
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询客户会话记录

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取某条会话的详细会话记录。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/get_detail_by_cid

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
cid	String	是	会话 id
partnerid	String	否	企业自己的用户 id ：供开放平台用户使用
from	Integer	否	来源：0：开放平台、1-pc/h5/sdk
visitorid	String	否	智齿平台用户 id ：所有来源用户都可使用
name_flag	Integer	否	客服名字类型：0：昵称（默认）、 1：真实姓名

说明：

1. cid、visitorid、partnerid + from 为三种查询模式，优先级为：cid、visitorid、partnerid + from;

2. 传入 visitorid 或者 partnerid + from 时，表示查询用户的最后一次会话记录。

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
items	List	否	对象列表

items 对象：

参数	类型	必填	描述
sender_name	String		发送者昵称
sender_type	Integer		发送者类型： 0：用户、1：机器人、2：客服
sender_face	String		发送者头像
receiver_name	String		接收者昵称
receiver_type	Integer		接收者类型：0：用户、1：机器人、2：客服
receiver_face	String		接收者头像
leave_msg_flag	String		用户留言 1-留言(1是留言，0为默认)
sender	String		发送者ID
receiver	String		接收者ID
msgid	String		消息ID
ts	String		发送时间 格式：yyyy-MM-dd HH:mm:ss
t	String		发送时间 格式：毫秒级时间戳
msg	String		会话消息
msg_type	Integer		消息类型：0：文本、1：图片、2：音频、3：富文本
cid	String		会话 ID

请求示例：

curl  https://www.sobot.com/api/chat/5/user/get_detail_by_cid
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	  
    "cid" : "49142902cfa74f2d9af8e7c1b546221d",
    "name_flag" : 1
    }'

返回示例：

{
    "items": [{
            "cid": "49142902cfa74f2d9af8e7c1b546221d",
            "msg":"<img src='http://bbs.sangfor.com.cn/data/attachment/sfchat/image/201910/154687/15719849png' class='webchat_img_upload upNowImg uploadedFile'>",
            "msg_type": 1,
            "msgid": "ab221eb4fbde4ea0b9fa728448470503",
            "receiver": "61673ee8d98d4282a95cdad38ffd5f5b",
            "receiver_name": "在线客服",
            "receiver_type": 2,
            "sender": "fdd445a5b10f303297752dc3625db648",
                "sender_face": "https://sobot-www.oss-cn-beijing.aliyuncs.com/console/7e20834c439748c780ca9648ca6c0cde/userImage/20161207150019JPG",
            "sender_name": "小明",
            "sender_type": 0,
            "t": "1572514382820",
            "ts": "2019-10-31 17:33:02"            
        }],
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询客服上下班时间

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取某个在线客服组当前是否处于系统设置的上班时间或下班时间。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/admin_is_work

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
groupid	String	否	技能组 id

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
is_work	Boolean		上下班状态：true：上班、false：下班

请求示例：

curl --location --request POST 'https://www.sobot.com/api/chat/5/user/admin_is_work?groupid=1d89fad9e31d4498b1196f7580666e52' \
--header 'language: zh' \
--header 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
--header 'content-type: application/json' \
--data-raw ''

返回示例：

{
    "item": {
        "is_work": true

    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询客服实时数据

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取当前登录的在线客服的列表以及状态等信息。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/get_once_data

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：无

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
admin_list	List		在线客服列表，详见下文
admin_size	Integer		在线客服数量
online_user_size	Integer		在线用户数量
wait_user_size	Integer		排队用户数量
robot_user_size	Integer		与机器人会话数量

admin_list 对象：

参数	类型	必填	描述
agentid	String		客服 id
group_name	List		客服所在技能组名称列表
groupid	List		客服所在技能组 id 列表
count	Integer		客服实时接待用户数量
agent_email	String		客服邮箱
status	Integer		客服状态(1：在线、2：忙碌)
status_code	Integer		自定义状态：3.小休 4.培训 5.会议 6.用餐 7.活动
agent_name	String		客服姓名
agent_face	String		客服头像
remark	String		客服备注
agent_nick	String		客服昵称
max_count	Integer		客服最大接待量
status_time	String		状态持续时长 格式：hh:mm:ss

请求示例：

curl  https://www.sobot.com/api/chat/5/user/get_once_data
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802'

返回示例：

{
    "item": {
        "wait_user_size": 0,
        "admin_size": 1,
        "online_user_size": 0,
        "robot_user_size": 0,
        "admin_list": [
            {
                "agentid": "61673ee8d98d4282a95cdad38ffd5f5b",
                "status_code": 0,
                "agent_name": "真是改了名字了",
                "agent_email": "123456@1com",
                "group_name": [
                    "销售",
                    "售后",
                    "售前"
                ],
                "groupid": [
                    "c4a3a9b8bc5742079d57d154ef2e2cc2",
                    "ef06c796d2b64218afc511dab1cd1283",
                    "a457f4dfe92842f8a11d1616c1c58dc1"
                ],
                "count": 0,
                "agent_face": "https://sobot-www.oss-cn-beijing.aliyuncs.com/console/7e25123PNG",
                "remark": "hello",
                "max_count": 10,
                "service_no": "1",
                "status_time": "06:53:56",
                "agent_nick": "在线客服",
                "status": 1
            }
        ]
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询在线技能组列表

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来查询当前系统下所有在线客服技能组的详情。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/query_group

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：无

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
items	List	否	对象列表

items对象：

参数	类型	必填	描述
groupid	String		技能组 id
group_name	String		技能组名称
create_time	Long		创建时间（秒级时间戳）

请求示例：

curl  https://www.sobot.com/api/chat/5/user/query_group
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802'

返回示例：

{
    "items": [{
        "groupid" : "c4a3a9b8bc5742079d57d154ef2e2cc2",
        "group_name" : "售前",
        "create_time" : 1540176885
    }],
    "ret_code": "000000",
    "ret_msg": "成功"
}

● 查询在线客服列表

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来查询当前系统下所有在线客服的详情。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/chat/5/user/query_agent

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
timezone	String	否	时区

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
items	List	否	对象列表

items 对象：

参数	类型	必填	描述
agentid	String		客服 id
group_name	List		客服所在技能组名称列表
groupid	List		客服所在技能组 id 列表
agent_email	String		客服邮箱
agent_name	String		客服姓名
role_name	String		角色
agent_no	String		客服工号
agent_status	String		客服状态
create_time	String		创建时间（yyyy-MM-dd）
department_name	String		部门名称
create_timeabs	String		创建时间（毫秒级时间戳）

请求示例：

curl  https://www.sobot.com/api/chat/5/user/query_agent
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802'

返回示例：

{
  "items": [
    {
      "agent_email": "123456@1com",
      "agent_name": "在线客服",
      "agent_no": "1",
      "agent_status": "启用",
      "agentid": "61673ee8d98d4282a95cdad38ffd5f5b",
      "create_time": "2016-04-19",
      "create_timeabs": "1676459190000",
      "department_name": "总公司",
      "group_name":  [
        "销售",
        "售后",
        "售前"
      ],
      "groupid": [
        "c4a3a9b8bc5742079d57d154ef2e2cc2",
        "ef06c796d2b64218afc511dab1cd1283",
        "a457f4dfe92842f8a11d1616c1c58dc1"
      ],
      "role_name": "超级管理员"
    }
  ],
  "ret_code": "000000",
  "ret_msg": "成功"
}

● 查询服务总结记录

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取服务总结记录。

请求方式：

POST

请求地址：

 https://www.sobot.com/api/wb/5/data/query_summary

headers 请求头：

参数	类型	必填	描述
language	String	是	语言标识：en-英文，zh-中文

请求参数：

参数	类型	必填	描述
cid	字符串	是	会话 id：cid

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item对象：

服务总结

参数	类型	必填	描述
summary_new_or_old_flag	Integer		0.未提交服务总结 1.提交了在线旧版服务总结 2.提交了服务总结
summary_classify_codes	String		服务分类编码
summary_classify_names	String		服务分类
summary_classify_paths	String		服务分类路径
summary_template_name	String		服务模板
summary_handle_progress	Integer		处理进度
summary_handle_progress_name	String		处理进度名称
remark	String		备注
customer_fields	List		自定义字段
summary_staff_name	String		总结客服
update_time	String		总结时间
cid	String		会话 id

在线旧版服务总结

参数	类型	必填	描述
summary_new_or_old_flag	Integer		0.未提交服务总结 1.提交了在线旧版服务总结 2.提交了服务总结
summary_flag	String		总结状态：1：已总结、0：未总结
update_time	String		总结时间
operation_name	String		业务单元
req_type_name	String		业务类型
question_status	String		解决状态：1：已解决、0：未解决
question_description	String		备注说明
invalid_session	String		无效会话：1：无效、0：有效
fields	List		自定义字段列表
summary_staff_name	String		总结客服
cid	String		会话 id

fields对象：

参数	类型	必填	描述
fieldid	String		字段 id
field_name	String		字段名称
field_value	String		字段值

请求示例：

curl  https://www.sobot.com/api/wb/5/data/query_summary
-X POST 
-H 'language: zh'
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{	  
"cid": "xx"
}'

返回示例：

服务总结

{
    "item": {
            "cid": "3cd40201989943df8cd1ed845efcb043",
            "summary_new_or_old_flag": 2,
            "summary_classify_codes": "0003,0002",
            "summary_classify_names": "0003A,0002B",
            "summary_classify_paths": "AAA/0003A,AAA/0002B",
            "summary_template_name": "默认分类1",
            "summary_staff_name": "客服1",
            "summary_handle_progress": "2",
            "summary_handle_progress_name": "已解决",
            "remark": "新版服务总结",
            "customer_fields": [
            {
            "fieldid": "28f002c873c344d9a8f9b3606830dfbb",
            "field_name": "业务单元字段1",
            "field_value": "值1"
            },
            {
            "fieldid": "9b9086c5bed84016af5adf273d41110e",
            "field_name": "业务单元字段2",
            "field_value": "值2"
            }
            ],
            "update_time": "1554716281854"
        },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

在线旧版服务总结

{
    "item": {
            "cid": "3cd40201989943df8cd1ed845efcb043",
            "summary_flag": "1",
            "summary_new_or_old_flag": 1,
            "operation_name": "业务单元",
            "req_type_name": "业务类型1,业务类型2",
            "summary_staff_name": "客服1",
            "question_status": "1",
            "question_description": "问题描述",
            "fields": [
            {
            "fieldid": "28f002c873c344d9a8f9b3606830dfbb",
            "field_name": "业务单元字段1",
            "field_value": "值1"
            },
            {
            "fieldid": "9b9086c5bed84016af5adf273d41110e",
            "field_name": "业务单元字段2",
            "field_value": "值2"
            }
            ],
            "invalid_session": "0",
            "update_time": "1554716281854"
        },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

错误编码

● 操作成功

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

● 系统异常

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

● 业务异常

错误编码	错误说明
200001	partnerid 未传入
200002	公司信息不存在
200003	访客信息不存在
200004	参数不能为空
200005	词条 id 或词条名称未传入
200006	访客已离线，无法评价
200007	该消息已被评价，无法评价
200008	消息内容未传入
200009	评价类型未传入
200010	评价结果未传入
200011	会话 id 未传入
200012	消息 id 未传入
200013	评价状态未传入
200014	机器人信息未传入
200026	不能发送空白消息
210001	该邮箱未注册
210002	邮箱不能为空