开发者文档
智齿科技
2022-05-19
目录

质检 API

# 质检 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
1

请求参数：

参数 类型 必填 描述
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 为密钥

请求示例：

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

返回参数：

参数 类型 必填 描述
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。

返回示例：

{
   "item": {
       "token": "4ac37cb2e9c740dba4b75a34d5358802",
       "expires_in": "86400"
   },
   "ret_code": "000000",
   "ret_msg": "操作成功"
}
1
2
3
4
5
6
7
8
# ● 获取呼叫质检结果

接口说明：

获取系统中呼叫质检结果信息(仅支持新版)

请求方式：

GET

请求地址：

 https://www.sobot.com/api/newQuality/5/quality/call_result
1

请求参数：

参数 类型 必填 描述
start_datetime Long 是 开始时间，示例:1724913355445
end_datetime Long 是 结束时间，示例:1724913355445
page_no Integer 否 当前页码，默认从第一页开始
page_size Integer 否 每页条数，默认每页100条，最大可传入10000

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/newQuality/5/quality/call_result?start_datetime=1724913355445&end_datetime=1724913355445&page_no=1&page_size=100
1

返回参数：

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
items List 是 对象列表
page_count Integer 是 共几页
page_no Integer 是 起始页
page_size Integer 是 每页展示的条数
total_count Integer 是 总共的数据条数

items集合：

参数 类型 必填 描述
agentid String 是 坐席id
agent_name String 是 坐席名称
agent_email String 是 坐席邮箱
call_start_datetime String 是 通话开始时间
call_log_jestid String 是 通话id
schemeid String 是 质检方案id
quality_datetime String 是 质检时间
total_score_max String 是 质检满分
standard_score_max String 是 质检标准分满分
pulse_max String 是 质检加分项满分
minus_max String 是 质检减分项满分
total_score String 是 质检得分
standard_score String 是 质检标准分得分
pulse String 是 质检加分项得分
minus String 是 质检减分项得分

返回示例：

{
    "items": [
        {
            "standard_score_max": "15",
            "pulse_max": "0",
            "minus": "0",
            "agent_email": "132@sobot.com",
            "quality_datetime": "1554971786077",
            "call_start_datetime": "1553594283000",
            "agent_name": "testxx",
            "total_score": "132",
            "call_log_jestid": "b212d432-ea8f-4701-9637-d01c8a5d9945",
            "schemeid": "2856580f156a4f9ea73dd4e9ac86896e",
            "total_score_max": "0",
            "pulse": "10",
            "agentid": "2856580f156a4f9ea73dd4e9ac86896e",
            "standard_score": "0",
            "minus_max": "0"
        }],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "ret_code": "000000",
    "ret_msg": "操作成功",
    "total_count": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# ● 获取在线质检结果

接口说明：

获取在线质检结果

请求方式：

GET

请求地址：

 https://www.sobot.com/api/newQuality/5/quality/chat_result
1

请求参数：

参数 类型 必填 描述
start_datetime Long 是 开始时间，示例:1724913355445
end_datetime Long 是 结束时间，示例:1724913355445
page_no Integer 否 当前页码，默认从第一页开始
page_size Integer 否 每页条数，默认每页100条，最大可传入10000

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/newQuality/5/quality/chat_result?start_datetime=1724913355445&end_datetime=1724913355445&page_no=1&page_size=100
1

返回参数：

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
items List 是 对象列表
page_count Integer 是 共几页
page_no Integer 是 起始页
page_size Integer 是 每页展示的条数
total_count Integer 是 总共的数据条数

items集合：

参数 类型 必填 描述
agentid String 是 坐席id
agent_name String 是 坐席名称
agent_email String 是 坐席邮箱
chat_start_datetime String 是 会话开始时间
cid String 是 会话id
schemeid String 是 质检方案id
quality_datetime String 是 质检时间
total_score_max String 是 质检满分
standard_score_max String 是 质检标准分满分
pulse_max String 是 质检加分项满分
minus_max String 是 质检减分项满分
total_score String 是 质检得分
standard_score String 是 质检标准分得分
pulse String 是 质检加分项得分
minus String 是 质检减分项得分

返回示例：

{
     "items": [
          {
           "standard_score_max": "15",
           "pulse_max": "0",
           "minus": "0",
           "agent_email": "132@sobot.com",
           "quality_datetime": "1554971786077",
           "chat_start_datetime": "1553594283000",
           "agent_name": "testxx",
           "total_score": "132",
           "cid": "2856580f156a4f9ea73dd4e9ac86896e",
           "schemeid": "2856580f156a4f9ea73dd4e9ac86896e",
           "total_score_max": "0",
           "pulse": "10",
           "agentid": "2856580f156a4f9ea73dd4e9ac86896e",
           "standard_score": "0",
           "minus_max": "0"
          }],
     "page_count": 1,
     "page_no": 1,
     "page_size": 15,
     "ret_code": "000000",
     "ret_msg": "操作成功",
     "total_count": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 接口返回状态编码

# ● 操作成功
返回编码 编码说明
000000 操作成功（除此编码以外的编码为错误编码）
# ● 系统异常
返回编码 编码说明
900001 token 为空
900002 token 已失效，请重新获取
900003 signature 错误
900004 没有找到公司的 api 配置信息
999999 系统未知异常
# ● 业务异常
返回编码 编码说明
700001 公司 id 不允许为空
700002 坐席 id 不允许为空
700003 客服昵称不允许为空
700004 客服真实姓名不允许为空
700005 客服角色 id 不允许为空
700006 客服角色不允许为空
700007 客服邮箱不允许为空
700008 客服邮箱格式不正确
700009 客服邮箱已存在
上次更新: 2024/8/30 14:10:19

←

最近更新
01
CRM 对接方案
12-05
02
大模型机器人API
09-09
03
LINE API
06-25
更多文章>
Theme by Vdoing