开发者文档
智齿科技
2022-09-13
目录

数据服务 API

# 数据服务 API

# 通话管理

# ● 查询通话主话单

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/maincdrs/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
参数 类型 必填 描述
startTime long 是 开始时间 毫秒
endTime long 是 结束时间 毫秒
pageNum int 是 从1开始的页码
pageSize int 是 每页的记录条目
callID String 否 通话记录主callID
hideNumber int 否 客户号码脱敏 0:未设置,默认为明文; 1:脱敏; 2:明文
operator String 否 请求操作用户; 如果agentType为0，用座席工号；如果为1，用座席id
agent String 否 参与座席; 如果agentType为0，用座席工号；如果为1，用座席id
agentType int 否 接口座席参数类别:0.座席工号; 1.座席id
customerNumber String 否 客户号码
gatewayNumber String 否 中继号码
callType int 否 通话类型 1: 内部通话; 2: 呼入; 3: 外呼;
mainDialType String 否 Inbound:呼入；RegularMakeCall:普通外呼；ClickToCallback:点击拨号；TwoWayToPSTN:双向回呼；Internal:内部通话；PreviewOutbound:预览外呼；PredictiveOutbound:预测外呼
callResult int 否 通话结果: 4.未找到座席侧 5.客户速挂6.座席侧未接听 7.客户未接听 8.双方已接听 21.客户已接听 22.系统未应答
hangupDisposition int 否 挂断方:1.其他 2.座席侧3.客户侧
attachedData String 否 自定义数据
agentCount int 否 经过座席数量 1.未经过；2.经过1个座席 3.经过多个座席
transferCount int 否 发起转移次数 1.无 2.有转移
consultCount int 否 咨询接听次数 1.无 2.有咨询接听
departmentId String 否 查看组织

返回参数 :

参数 类型 必填 描述
list 数组 是 数组元素 参考 客户通话主话单

响应示例：

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "",
  "code": 200,
  "reason": "OK",
  "kind": "MainCDRInfo",
  "data": {
    "currPage": 1, //当前页
    "pageSize": 15, //每页记录数
    "total": 12    //总记录数
    "list":[
      {
        "callID":"6bf3cbb167a14c7521993665adba687b", // callID
        "callType": 2,
        "screenNumber":"18618256606",  //客户屏显号码
        "areaCode":"0871",
        "areaProvince":"云南省",
        "areaCity":"昆明市",
        "gatewayNumber":"95588",  // 客户侧的中继号码
        "gatewayNumberNick":"95588别名",  // 客户侧的中继号码别名
        "startTime":1637068156419,  //开始时间 unix时间戳(毫秒)
        "alertTime":1637068256419, //客户侧的振铃时间 unix时间戳(毫秒)
        "answerTime":1637068356419, //客户侧的接通时间 unix时间戳(毫秒)
        "bridgeTime":1637068456419, //客户和座席桥接时间 unix时间戳(毫秒)
        "endTime":1637068556419, //客户侧的挂断时间 unix时间戳(毫秒)
        "duration":"100", //客户侧从桥接到挂断时长 单位: 秒
        "totalDuration":"120", //客户侧从开始到挂断时长 单位: 秒
        "callResult":, 2, // 客户侧  4.未找到座席侧 5.客户速挂6.座席侧未接听 7.客户未接听 8.双方已接听 21.客户已接听 22.系统未应答
        "earlyDetectCause": "已接听", //客户侧： "", 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听；默认未知； 当呼叫类型为呼入时该值为""
        "hangupDisposition": 1, // 挂机方向 
        "recordUrl":"https://record.soboten.com/recordings/cc3738581df7413da5d3204364943e3d", //录音路径。录音下载需要统一认证
        "platformId":"7d6c1b38caad4a539d92b73d390b664c", // 平台商户ID
        "companyId":"825072edbd914f47aa8704de02f1cdb6", // 公司ID
        "feeSeconds":100, // 计费-计费时长(秒)
        "feeMinutes":2, // 计费-计费时长(分钟)
        "firstRouteId":"3b36d0a056404a48b644c39ed82e22fe", // 第一次路由ID
        "firstRouteName":"", // 第一次路由名称
        "lastAgentUUID":"", // 最后一次接待座席UUID
        "lastAgentName":"", // 最后一次接待座席名称
        "lastAgentID":"", // 最后一次接待座席工号
        "lastAgentDN":"", // 最后一次接待座席分机
        "lastAgentPhoneType":0, // 最后一次接待座席设备类型 1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
        "lastAgentPstn":"", //最后接待的座席使用的手机号码
        "transferCount":1, //发起转接次数
        "consultCount":1, //成功咨询次数
        "sourceType":2,  //来源对象类型 0:默认; 1:通话记录; 2: 工单; 3:会话记录
        "sourceId": "", //来源对象Id
        "firstCallAgentUUID": "", //首次呼叫座席ID
        "firstCallAgentID": "", //首次呼叫座席工号
        "firstAgentUUID": "", //首次接听座席ID
        "firstAgentID": "", //首次接听座席工号
        "firstAgentName": "", //首次接听座席名称
        "attachedData":"{\"customerName\":\"张三\",\"customerDept\":\"宇宙银行\"}",
        "userData":"{\"VIP_CODE\":\"112233\",\"VIP_NAME\":\"VIP客户\"}"
      }]
   }
}
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# ● 查询通话座席子话单

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/maincdrs/{callID}/partycdrs
请求方法：GET

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
参数 类型 必填 描述
callID String 是 主话单。 1通电话有且仅有1个主话单id

返回参数 :

参数 类型 必填 描述
list 数组 是 数组元素 参考 座席通话子话单

响应示例：

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "",
  "code": 200,
  "reason": "OK",
  "kind": "PartyCDRInfo",
  "data": {
    "list":[
        {
            "callID":"6bf3cbb167a14c7521993665adba687b", // callID
            "callType": 2,
            "partyId":"8af8e51f23515fe2a62193e09ceaf0f2",  //子话单ID 除客户外，每个party都是一个子话单
            "dialType":1,  //呼叫类型1.呼叫 2.转移 3.咨询 4.监听 5.抢接 6.强插
            "agentType":1,  //座席类型 0.工号 1.座席uuid
            "phoneType":1,  //接听设备1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
            "agentUUID":"ccc661e374bc5e8b8323af632e77367d",
            "agentDN": "1001",  // 座席使用的话机号码 分机或者pstn号码
            "gatewayNumber":"95588",  // 座席侧外呼的中继号码; 分机号码，可为空字符串
            "startTime":1637068156419,  //座席侧开始时间 unix时间戳(毫秒)
            "alertTime":1637068256419, //座席侧的振铃时间 unix时间戳(毫秒)
            "answerTime":1637068356419, //座席侧的接通时间 unix时间戳(毫秒)
            "bridgeTime":1637068456419, //客户和座席桥接时间 unix时间戳(毫秒)
            "endTime":1637068556419, //座席侧的挂断时间 unix时间戳(毫秒)
            "duration":100, // 座席侧 通话时长 单位:秒
            "callResult":2, // 座席侧 呼叫结果 1.呼叫失败 2.呼叫成功-座席未接听 3.呼叫成功-座席已接听
            "hangupDisposition": 1, // 挂机方向 
            "earlyDetectCause":"已接听", //呼叫座席侧使用手机方式 或者转第三方号码时: 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听； 座席以sip或者网页登录方式时该值为""
            "agentName":"李四",
            "agentID":"1001", //座席工号
            "phoneType": 0,  //1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
            "agentRole": 2,  //  2: 人工座席  4:第三方PSTN  5: 虚拟座席
            "DNIS":"18655668888", //  
            "platformId":"PlatformId", //平台ID
            "departmentId":"aa37b2378e364288963c860edb65c33d|dd72f0cb8a324b59bb172ca571df163d", //所属部门
            "chargeDepartmentId":"aa37b2378e364288963c860edb65c33d|dd72f0cb8a324b59bb172ca571df163d", //计费组织
            "numberType":1, // boss 提供的计费号码类型 1:固话号码 2:手机号码 3:95/96号码 4:1010号码 5:400号码 6:强显号码 7:虚拟号码 8:企业自有号码
            "feeSeconds":9, //计费 单位:秒
            "feeMinutes":1,//计费 单位:分钟
            "fee":0.0,     //计费 费用 小数点后两位
            "companyId": "aa37b2378e364288963c860edb65c33d",  //公司ID
            "fromAgentUUID":"FromAgentUUID",  // 呼叫的来源座席UUID
            "fromAgentID":"FromAgentID",  //呼叫的来源座席工号
            "fromAgentName":"FromAgentName",  //呼叫的来源座席姓名
            "lastAgentFlag":false  // 是否是最后一个服务座席
        }
    ]
  }
}
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# ● 查询通话主子话单

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/cdrs/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
参数 类型 必填 描述
callID String 是 通话记录主callID
hideNumber int 否 客户号码脱敏 0:未设置,默认为明文; 1:脱敏; 2:明文

返回参数 :

参数 类型 必填 描述
call String 是 参考 客户通话主话单
parties 数组 是 数组元素参考 座席通话子话单

响应示例：

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "",
  "code": 200,
  "reason": "OK",
  "kind": "JSONObject",
  "data": {
    "list":[
        "callID":"6bf3cbb167a14c7521993665adba687b", // callID
        "callType": 2,
        "screenNumber":"18618256606",  //客户屏显号码
        "areaCode":"0871",
        "areaProvince":"云南省",
        "areaCity":"昆明市",
        "gatewayNumber":"95588",  // 客户侧的中继号码
        "startTime":1637068156419,  //客户侧的开始时间 unix时间戳(毫秒)
        "alertTime":1637068256419, //客户侧的振铃时间 unix时间戳(毫秒)
        "answerTime":1637068356419, //客户侧的接通时间 unix时间戳(毫秒)
        "bridgeTime":1637068456419, //客户和座席桥接时间 unix时间戳(毫秒)
        "endTime":1637068556419, //客户侧的挂断时间 unix时间戳(毫秒)
        "duration":"100", //客户侧从桥接到挂断时长 单位: 秒
        "totalDuration":"120", //客户侧从开始到挂断时长 单位: 秒
        "callResult": 2, // 客户侧1.其他原因无法应答 2.欠费 3.客户号码黑名单 4.未找到座席侧 5.客户速挂6.座席侧未接听 7.客户未接听 8.双方已接听 9.中继号码停用
        "earlyDetectCause": "已接听", //客户侧： "", 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听；默认未知； 当呼叫类型为呼入时该值为""
        "hangupDisposition": 1, // 挂机方向 
        "recordUrl":"https://record.soboten.com/recordings/cc3738581df7413da5d3204364943e3d", //录音路径
        "platformId":"7d6c1b38caad4a539d92b73d390b664c", // 平台商户ID
        "companyId":"825072edbd914f47aa8704de02f1cdb6", // 公司ID
        "departmentId":"36a3c4866a814065a8a6e01a50cc3ecf", // 部门ID
        "chargeDepartmentId":"b536ef40639a4caab1bba0cd5cf8ebe2", // 计费部门ID
        "feeSeconds":100, // 计费-计费时长(秒)
        "feeMinutes":2, // 计费-计费时长(分钟)
        "fee": 25.66, // 计费-计费金额
        "numberType":1, // boss 提供的计费号码类型 1:固话号码 2:手机号码 3:95/96号码 4:1010号码 5:400号码 6:强显号码 7:虚拟号码 8:企业自有号码
        "firstRouteId":"3b36d0a056404a48b644c39ed82e22fe", // 第一次路由ID
        "firstRouteName":"", // 第一次路由名称
        "firstAgentUUID":"", // 第一次接待座席UUID
        "firstAgentName":"", // 第一次接待座席名称
        "firstAgentID":"", // 第一次接待座席工号
        "firstAgentDN":"", // 第一次接待座席分机
        "firstAgentPhoneType":0, // 第一次接待座席设备类型 1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
        "firstAgentPstn":"", //最先接待的座席使用的手机号码
        "lastAgentUUID":"", // 最后一次接待座席UUID
        "lastAgentName":"", // 最后一次接待座席名称
        "lastAgentID":"", // 最后一次接待座席工号
        "lastAgentDN":"", // 最后一次接待座席分机
        "lastAgentPhoneType":0, // 最后一次接待座席设备类型 1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
        "lastAgentPstn":"", //最后接待的座席使用的手机号码
        "transferCount":1, //发起转接次数
        "consultCount":1, //成功咨询次数
        "firstCallAgentUUID": "", //首次呼叫座席ID
        "firstCallAgentID": "", //首次呼叫座席工号
        "firstAgentUUID": "", //首次接听座席ID
        "firstAgentID": "", //首次接听座席工号
        "firstAgentName": "", //首次接听座席名称
        "attachedData":"{\"customerName\":\"张三\",\"customerDept\":\"宇宙银行\"}",
        "userData":"{\"VIP_CODE\":\"112233\",\"VIP_NAME\":\"VIP客户\"}"
        "parties":[
            {
              "partyId":"8af8e51f23515fe2a62193e09ceaf0f2",  //子话单ID 除客户外，每个party都是一个子话单
              "agentUUID":"ccc661e374bc5e8b8323af632e77367d",
              "agentDN": "1001",  // 座席使用的话机号码 分机或者pstn号码
              "gatewayNumber":"95588",  // 座席侧外呼的中继号码; 分机号码，可为空字符串
              "startTime":1637068156419,  //座席侧开始时间 unix时间戳(毫秒)
              "alertTime":1637068256419, //座席侧的振铃时间 unix时间戳(毫秒)
              "answerTime":1637068356419, //座席侧的接通时间 unix时间戳(毫秒)
              "bridgeTime":1637068456419, //客户和座席桥接时间 unix时间戳(毫秒)
              "endTime":1637068556419, //座席侧的挂断时间 unix时间戳(毫秒)
              "afterworkEndTime":1637068756419, // 座席 整理结束时间 unix时间戳(毫秒)
              "duration":100, // 座席侧 通话时长 单位:秒
              "callResult":2, // 座席侧 呼叫结果 1.呼叫失败 2.呼叫成功-座席未接听 3.呼叫成功-座席已接听
              "hangupDisposition": 1, // 挂机方向 
              "earlyDetectCause":"已接听", //呼叫座席侧使用手机方式 或者转第三方号码时: 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听； 座席以sip或者网页登录方式时该值为""
              "agentName":"李四",
              "agentID":"1001", //座席工号
              "phoneType": 0,  //1.webrtc 2.wechat 3.pstn 4.sip 5.sobotapp
              "agentRole": 2,  // 2: 人工座席  4:第三方PSTN  5: 虚拟座席
              "DNIS":"18655668888", //  
              "platformId":"PlatformId", //平台ID
              "departmentId":"aa37b2378e364288963c860edb65c33d|dd72f0cb8a324b59bb172ca571df163d", //所属部门
              "chargeDepartmentId":"aa37b2378e364288963c860edb65c33d|dd72f0cb8a324b59bb172ca571df163d", //计费组织
              "numberType":1, // boss 提供的计费号码类型 1:固话号码 2:手机号码 3:95/96号码 4:1010号码 5:400号码 6:强显号码 7:虚拟号码 8:企业自有号码
              "feeSeconds":9, //计费 单位:秒
              "feeMinutes":1,//计费 单位:分钟
              "fee":0.0,     //计费 费用 小数点后两位
              "companyId": "aa37b2378e364288963c860edb65c33d",  //公司ID
              "fromAgentUUID":"FromAgentUUID",  // 呼叫的来源座席UUID
              "fromAgentID":"FromAgentID",  //呼叫的来源座席工号
              "fromAgentName":"FromAgentName",  //呼叫的来源座席姓名
              "lastAgentFlag":false  // 是否是最后一个服务座席
              "dialType":1 // 1.呼叫 2.转移 3.咨询 4.监听 5.抢接 6.强插
            }
          ]
       ]
   }
}
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# 推送管理

# ● 推送数据结构参考

请求参数(header) :

参数 类型 必填 描述
X-Log-TimeStamp String 是 时间戳（取服务器时间：毫秒）
X-Log-RandomCode String 是 随机码
X-Log-Sign String 是 sign 签名，对 companyId，时间戳（取服务器时间），随机码 ，appKey（配置消息转发时使用的密钥）按照顺序进行字符串拼接，使用 MD5 摘要算法（32 位小写）所得值

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明

  1. 加密场景 body示例 如:

    注意：此场景下 被推送的消息会被加密后放到content对应的value下

     {"content":"LuB+VCYAKuhhkZ27SyQmemjwFUYO"}
    1

  2. 不加密场景 body示例 如:

    注意：此场景下 body 推送的消息将为明文 且不会放在 content 对应的value 下 ，详细的明文内容 请看下面具体的推送

# ● 推送通话记录(主话单)

接口地址：租户配置推送接口地址
请求方法：POST

返回参数 :

参数 类型 必填 描述
人工主话单 JSON 是 参考 人工通话主话单
机器人主话单 JSON 是 参考 机器人通话主话单
# ● 推送座席通话明细(子话单)

接口地址：租户配置推送接口地址
请求方法：POST

返回参数 :

参数 类型 必填 描述
人工子话单 JSON 是 参考 人工通话子话单
机器人子话单 JSON 是 参考 机器人通话子话单
# ● 座席状态回调

说明：需要申请开通后方可生效
请求方法：POST

返回参数 :

参数 类型 必填 描述
companyId String 是 企业id
messageID String 是 事件ID. 值：AgentHistoryLogES
msgType String 是 事件类型. 值： agent_working_status_changed_successfully
creationTime long 是 事件时间
agentUUID String 否 目标座席ID
agentID String 否 目标座席工号
agentName String 否 目标座席姓名
loginStatus int 否 目标座席登录状态: -1.未定义0.离线1.在线2.置忙98.系统锁定
notReadyStatus int 否 目标座席置忙原因: 0未知 2勿扰 4话后整理 11小休 12培训 13会议 14用餐 16活动 16-18自定义 97 自己强制置忙 98系统置忙 99班长强制置忙
workStatus int 否 目标座席工作状态: 0未知 1就绪 2忙碌 98锁定 4后处理 6振铃 7通话 8保持
startTime long 是 目标座席状态开始时间
callID String 否 通话记录的ID
callType String 否 呼叫方向类型: 2.呼入3.外呼
attachedData String 否 通话记录的自定义数据
partyId String 否 座席通话明细的ID
dialType int 否 座席通话明细的呼叫类型： 1呼叫 2被转移 3被咨询 4监听 5抢接 6强插
# ● 呼叫事件推送

说明：需要申请开通后方可生效
请求方法：POST

事件名称 事件编码 返回结果
来电响铃 EventRinging 请参考 呼叫事件
外呼振铃 EventDialing 请参考 呼叫事件
电话接通 EventEstablished 请参考 呼叫事件
电话挂断 EventReleased 请参考 呼叫事件
随路数据变化 EventAttachedDataChanged 请参考 呼叫事件
电话保持 EventHeld 请参考 呼叫事件
电话取消保持 EventRetrieved 请参考 呼叫事件
通话成员增加 EventPartyAdded 请参考 呼叫事件
通话成员离开 EventPartyDeleted 请参考 呼叫事件
通话成员变更 EventPartyChanged 请参考 呼叫事件
DTMF发送 EventDtmfSent 请参考 呼叫事件
电话创建 EventCallCreated 请参考 呼叫事件
电话销毁 EventCallDeleted 请参考 呼叫事件
话务错误事件 EventPartyError 请参考 呼叫事件
座席错误事件 EventAgentError 请参考 呼叫事件

# 录音管理

# ● 通过通话主话单的字段(recordUrl)获取真正的录音

接口地址：https://openapi.soboten.com/callservice/v6/cc-audios/recordings/e4d15cfb03ad5N4b7639244F8782000fb764
请求方法：GET

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

返回参数 :
返回MP3的语音流

# 日志管理

# ● 查询座席工作状态日志

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/agent-histories/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

请求参数(body) :

参数 类型 必填 描述
startTime String 是 开始时间,格式:yyyy-MM-dd HH:mm,例如:2022-07-07 01:00
endTime String 是 结束时间,格式:yyyy-MM-dd HH:mm,例如:2022-07-07 23:59
pageNum int 是 从1开始的页码
pageSize int 是 每页的记录条目
departmentId String[] 否 组织结构, 部门ID
agent String[] 否 如果agentType为0，用座席工号；如果为1，用座席UUID
agentType int 否 0:工号; 1: 座席UUID
loginStatus int[] 否 登录操作状态
noReadyStatus int[] 否 座席置忙原因
workStatus int[] 否 工作状态

返回参数 :

参数 类型 必填 描述
id String 是 操作日志Id
companyId String 是 企业id
agentUUID String 否 座席UUID
agentID String 否 座席工号
agentName String 否 座席姓名
loginStatus int 否 座席登录状态: 0:离线; 1: 在线; 2: 置忙; 98:系统锁定
noReadyStatus int 否 座席置忙原因: 2:勿扰; 11:小休; 12:培训; 13:会议; 14:用餐; 15:活动; 16:自定义1; 17:自定义2； 18：自定义3
workStatus int 否 座席工作状态 1:就绪中；2:置忙中; 4：整理中; 5:呼叫中; 6:响铃中; 7: 通话中; 8:保持中; 98:锁定中
startTime String 否 座席状态开始时间
endTime String 否 座席状态结束时间
duration 秒 否 座席状态持续时长

响应示例：

{
  "apiVersion": "6.2",
  "status": "Success",
  "message": "",
  "code": 200,
  "reason": "OK",
  "kind": "AgentHistory",
  "data": {
    "currPage": 1, //当前页
    "pageSize": 15, //每页记录数
    "total": 12    //总记录数
    "pageData":[
      {
        "id": "d097d27d0a89dB58ad7bce250e0f875a2e19",
        "companyId":"825072edbd914f47aa8704de02f1cdb6", // 公司ID
        "agentUUID":"9a0c9b5fdcca5d1fbe206593dc058788", //座席UUID
        "agentID":"1001", //座席工号
        "agentName": "张三",  // 座席姓名
        "agentType":1,//如果agentType为0，用座席工号；如果为1，用座席UUID
        "thisDN": "1001", // 座席使用的电话号码 包括分机和外线
        "startTime":"2022-07-07 01:00",//开始时间
        "endTime":"2022-07-07 23:59",//结束时间
        "duration":"100", //持续时长 单位: 秒
        "loginStatus":0, //座席登录状态  0:离线; 1: 在线; 2: 置忙; 98:系统锁定
        "noReadyStatus":1,// 座席置忙原因 2:勿扰; 11:小休; 12:培训; 13:会议; 14:用餐; 15:活动; 16:自定义1; 17:自定义2； 18：自定义3// 
        "workStatus":2, //工作状态  1:就绪中；2:置忙中; 4：整理中; 5:呼叫中; 6:响铃中; 7: 通话中; 8:保持中; 98:锁定中
      }
    ]
  }
}
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
27
28
29
30

# 监控管理

# ● 推送座席指标

接口地址：https://openapi.soboten.com/callservice/v6/webmsg/monitoring/_watch/agents-metrics?product=scc&departmentIds={departmentIds}&agentType={agentType}&agents={agents}&agentWorkStatuses={agentWorkStatuses}&agentLoginStatuses={agentLoginStatuses}&agentBusyReasonCodes={agentBusyReasonCodes}&delay={delay}&pageNum={pageNum}&pageSize={pageSize}&sort={sort}
请求方法：Server-sent events (opens new window)
说明: 第一次都是全量消息， 以后都是增量消息.

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权token
Idempotency-Key String 是 UUID,幂等性

请求参数(query parameters) :

参数 类型 必填 描述
departmentIds String 否 部门集合; 例如 departmentIds=5b660b7cdb445ea0ba973a0032b3c47f,ba973a00325b660b7cdb445ea0b3c47f;
agentType int 否 0:agents是工号集合; 1: agents是座席UUID集合
agents String 否 座席UUID或座席工号集合; 工号例子: agents=1005,1006 ; 座席UUID例子: agents=1543a84ef0994426a5a8f6eb3ebf7e0f,f43481698368489d9bd6b63f8fdd3c45
agentWorkStatuses int 否 默认是所有的; 工作状态集合: 就绪中(1),置忙中(2),整理中(4),振铃中(5),响铃中(6),通话中(7),保持中(8) ; 例如 agentWorkStatuses=5,6
agentBusyReasonCodes int 否 默认是所有的; 置忙原因:11-18 ; 例如 agentBusyReasonCodes=11,15
agentLoginStatuses int 否 默认是所有的; 登录状态集合: 离线(0),在线(1),置忙(2),系统锁定中(98); 例如 agentLoginStatuses=1,2
sort String 否 排序字段和顺序; 默认格式是 sort=agentNumber,asc
pageNum int 否 页码; 默认从1开始的页码
pageSize int 否 每页的记录条目; 默认为15
operatorUserId String 否 操作人id；当使用座席级token时，可不传值。当使用公司级token时，需传值。使用座席级token并且该参数也赋值时，则以token中id为主
product String 是 产品

返回值 :

参数 类型 必填 描述
agentsSummary Object 是 座席列表汇总情况
agentsMetrics 数组 是 数组元素参考 座席列表

响应示例：

200 OK
Transfer-Encoding: chunked
Content-Type: text/event-stream;charset=utf-8
1
2
3
4

全量响应消息:

{
  "MessageID": "EventAgentsMetricsWatch",
  "companyId":"6da9c206557b5381a70919907fcf1b02",
  "creationTime": 433111010800,
  "agentsSummary":{
    "inboundAbandonCallsCountToday":10, // 今日呼入接听次数
    "inboundEstablishedCallsCountToday":1, // 今日呼入未接次数
    "outboundCallsCountToday":10, // 今日外呼电话个数
    "outboundEstablishedCallsCountToday":1 // 今日外呼电话接听个数
  },
  "agentsMetrics":{
    "pageNum":1,
    "pageSize":15,
    "total": 12,    //总记录数
    "list":[
      {
          "agentUUID": "8d477de896c148d89ee71eeffc67a7ad",
          "agentName":"张三",
          "phoneType":1,  //1: 网页; 2: 微信; 3: PSTN号码; 4: SIP话机
          "thisDN":"801", // 座席电话号码
          "agentWorkStatus":6,//工作状态集合: 就绪中(1),置忙中(2),整理中(4),振铃中(5),响铃中(6),通话中(7),保持中(8)
          "agentLoginStatus":2,//离线(0),在线(1),置忙(2),系统锁定中(98)
          "agentBusyReasonCode":11,//置忙原因 11-18
          "lastWorkStatusChangedTime": 1638944241704, // 当前座席工作状态13位时间戳(毫秒级)
          "lastLoginStatusChangedTime":1706176912305, // 当前座席登录状态13位时间戳(毫秒级)
          "callType": 2,  // 2: 呼入  3: 呼出  0: 没有通话
          "customerNumber":"18688889999", // 客户电话号码 没有则为""
          "customerPrivacyNumber": "", // 客户号码加密
          "inboundEstablishedCallsCountToday":10, // 今天呼入接听次数
          "inboundAbandonCallsCountToday":1, // 今天呼入未接次数
          "outboundCallsCountToday":10, // 今日外呼电话个数
          "outboundEstablishedCallsCountToday":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
27
28
29
30
31
32
33
34
35
36
37
38

增量通知消息:

{
  "MessageID": "EventAgentsMetricsChanged",
  "companyId":"6da9c206557b5381a70919907fcf1b02",
  "creationTime": 433111010800,
  "list",[
    {
      "op": "replace",
      "id": "8d477de896c148d89ee71eeffc67a7ad",  //座席UUID
      "path": "agentsMetrics/list/agentWorkStatus",  //更新 agentsMetrics/list 中 agentUUID=8d477de896c148d89ee71eeffc67a7ad 工作状态 指标
      "value": 7
    },
    {
      "op": "replace",
      "id": "",  //非数组ID为空
      "path": "agentsSummary/readyAgentsCount",  //更新 工作状态（就绪中）座席数 指标
      "value": 7
    },
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# ● 查看座席指标

接口地址：https://openapi.soboten.com/callservice/v6/webmsg/monitoring/agents-metrics?product=scc&departmentIds={departmentIds}&agentType={agentType}&agents={agents}&agentWorkStatuses={agentWorkStatuses}&agentLoginStatuses={agentLoginStatuses}&agentBusyReasonCodes={agentBusyReasonCodes}&delay={delay}&pageNum={pageNum}&pageSize={pageSize}&sort={sort}
请求方法：GET

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权token
Idempotency-Key String 是 UUID,幂等性

请求参数(query parameters) :

参数 类型 必填 描述
departmentIds String 否 部门集合; 例如 departmentIds=5b660b7cdb445ea0ba973a0032b3c47f,0b1eb5f5459259a4a50bbac11db2b3dd;
agentType int 否 0:agents是工号集合; 1: agents是座席UUID集合
agents String 否 座席UUID或座席工号集合; 工号例子: agents=1001,=1002 ; 座席UUID例子: agents=1543a84ef0994426a5a8f6eb3ebf7e0f,f43481698368489d9bd6b63f8fdd3c45
agentWorkStatuses int 否 默认是所有的; 工作状态集合: 就绪中(1),置忙中(2),整理中(4),振铃中(5),响铃中(6),通话中(7),保持中(8) ; 例如 agentWorkStatuses=5,6
agentBusyReasonCodes int 否 默认是所有的; 置忙原因:11-18 ; 例如 agentBusyReasonCodes=11,15
agentLoginStatuses int 否 默认是所有的; 登录状态集合: 离线(0),在线(1),置忙(2),系统锁定中(98); 例如 agentLoginStatuses=1,2
sort String 否 排序字段和顺序; 默认格式是 sort=agentNumber,asc
pageNum int 否 页码; 默认从1开始的页码
pageSize int 否 每页的记录条目; 默认为15
operatorUserId String 否 操作人id；当使用座席级token时，可不传值。当使用公司级token时，需传值。使用座席级token并且该参数也赋值时，则以token中id为主
product String 是 产品

返回值 :

参数 类型 必填 描述
agentsSummary Object 是 座席列表汇总情况
agentsMetrics 数组 是 数组元素参考 座席列表

响应示例:

{
  "MessageID": "EventAgentsMetricsWatch",
  "companyId":"6da9c206557b5381a70919907fcf1b02",
  "creationTime": 433111010800,
  "agentsSummary":{
    "inboundAbandonCallsCountToday":10, // 今日呼入接听次数
    "inboundEstablishedCallsCountToday":1, // 今日呼入未接次数
    "outboundCallsCountToday":10, // 今日外呼电话个数
    "outboundEstablishedCallsCountToday":1 // 今日外呼电话接听个数
  },
  "agentsMetrics":{
    "pageNum":1,
    "pageSize":15,
    "total": 12,    //总记录数
    "list":[
      {
          "agentUUID": "8d477de896c148d89ee71eeffc67a7ad",
          "agentName":"张三",
          "phoneType":1,  //1: 网页; 2: 微信; 3: PSTN号码; 4: SIP话机
          "thisDN":"801", // 座席电话号码
          "agentWorkStatus":6,//工作状态集合: 就绪中(1),置忙中(2),整理中(4),振铃中(5),响铃中(6),通话中(7),保持中(8)
          "agentLoginStatus":2,//离线(0),在线(1),置忙(2),系统锁定中(98)
          "agentBusyReasonCode":11,//置忙原因 11-18
          "lastWorkStatusChangedTime": 1638944241704, // 当前座席工作状态13位时间戳(毫秒级)
          "lastLoginStatusChangedTime":1706176912305, // 当前座席登录状态13位时间戳(毫秒级)
          "callType": 2,  // 2: 呼入  3: 呼出  0: 没有通话
          "customerNumber":"18688889999", // 客户电话号码 没有则为""
          "customerPrivacyNumber": "", // 客户号码加密
          "inboundEstablishedCallsCountToday":10, // 今天呼入接听次数
          "inboundAbandonCallsCountToday":1, // 今天呼入未接次数
          "outboundCallsCountToday":10, // 今日外呼电话个数
          "outboundEstablishedCallsCountToday":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
27
28
29
30
31
32
33
34
35
36
37
38

# 统计报表

# ● 获取所有指标显示方案

说明：获取报表指标数据时需要使用
接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/gateway_number/check_plan
请求方法：GET

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

请求参数(query parameters) :

参数 类型 必填 描述
planType int 否 1 通话记录 2 中继报表 4 座席报表 24 部门报表

返回参数

参数 类型 必填 描述
id String 否 指标显示方案ID
planName String 是 指标显示方案名称
planType int 是 1 通话记录 2 中继报表 4 座席报表 24 部门报表

响应示例:

{
    "apiVersion": "string",
    "status": "string",
    "code": 0,
    "message": "string",
    "reason": "string",
    "kind": "string",
    "metaData": {
        "creatorId": "string",
        "creationTime": 0,
        "updateUserId": "string",
        "updatedTime": 0
    },
    "data":{
        "planType": 2,
        "planName": "默认方案", 
        "checked": 1,
        "id": "765b29d607da42a3b57a8e4e868a31dc"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# ● 中继号码报表

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/gateway-number-table/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
参数 类型 必填 描述
dimensions int 是 维度: 1:时间; 2:中继号码; 3:时间+中继号码; 4:中继号码+时间
dateType int 是 时间范围: 11:半小时;12:小时;13:日; 14:周; 15:月
startDate String 是 开始日期: 2021-01-01
startTime String 是 开始时间: 00:00
endDate String 是 结束日期: 2021-01-01
endTime String 是 结束时间: 24:00
callType int 是 呼叫类型: 2:呼入; 3:呼出
customerFields string 否 指标使用逗号隔开 参考指标列表
currPage int 是 默认从1开始的页码
pageSize int 是 默认15
gatewayNumbers String[] 否 中继号码: 以英文逗号分隔的一系列中继号码;例子:["01088881234","01088885678"]
numberScope String 否 查询范围：2.电销 3.机器人 不传默认查询电销类型数据

返回参数

参数 类型 必填 描述
currPage int 否
pageSize int 是
list 数组 是 数组元素 参考指标列表

响应示例:

{
    "apiVersion": "string",
    "status": "string",
    "code": 0,
    "message": "string",
    "reason": "string",
    "kind": "string",
    "metaData": {
        "creatorId": "string",
        "creationTime": 0,
        "updateUserId": "string",
        "updatedTime": 0
    },
    "data": {
      "metric": [
        {
            "result_date":"2022-03-17 16:30 2022-03-17 17:00",  //时间维度
            "gateway_number":"01088881234",  //中继号码维度
            "inbound_calls": 0,  //呼入总数
            "outbound_calls": 0  //外呼电话数
        }
      ],
      "amount": {
            "inbound_calls": 0,  //呼入总数合计
            "outbound_calls": 0  //外呼电话数合计
      },
      "pageSize": 1,
      "currPage": 1,
      "total": 15 
    }
}
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
27
28
29
30
31
# ● 座席报表

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/agent-table/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
参数 类型 必填 描述
dimensions int 是 维度: 1:时间; 8:座席; 9:时间+座席; 10:座席+时间
dateType int 是 时间范围: 11:半小时;12:小时;13:日; 14:周; 15:月
startDate String 是 开始日期: 2021-01-01
startTime String 是 开始时间: 00:00
endDate String 是 结束日期: 2021-01-01
endTime String 是 结束时间: 24:00
agentReportType int 是 座席报表类型: 呼入2 外呼3 工作状态4
customerFields String 是 指标使用逗号隔开 参考座席指标列表
currPage int 是 默认从1开始的页码
pageSize int 是 默认15
agents String[] 否 座席: 字符串数组格式 如: ["aaa","bbb"]，与agentType对应
agentType int 否 座席类型: 1.座席id 2.工号

响应示例:

{
  "apiVersion": "string",
  "status": "string",
  "code": 0,
  "message": "string",
  "reason": "string",
  "kind": "string",
  "metaData": {
      "creatorId": "string",
      "creationTime": 0,
      "updateUserId": "string",
      "updatedTime": 0
  },
  "data": {
    "metric": [
      {
        "result_date": "2024-02-21",//时间
        "serviceNo": "1234",//工号
        "serviceName": "Jon",//座席名称
        "serviceId": "ddb3063ae7544df3a77b4e3912f1b942",//座席ID
        "inbound_agent_partits": 0,//呼入座席次数
        "outbound_calls": 0,//外呼次数
        "agent_login_sum_duration": "15:17:23"//登录总时长
      }
    ],
    "amount": {
        "inbound_agent_partits": 0,//呼入座席次数
        "outbound_calls": 0,//外呼次数
        "agent_login_sum_duration": "15:17:23"//登录总时长
    },
    "total": 1,
    "currPage": 1,
    "pageSize": 15
  }
}
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
27
28
29
30
31
32
33
34
35
# ● 部门报表

接口地址：https://openapi.soboten.com/callservice/tm/tm-reports/depart-table/_search
请求方法：POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，座席级别token，获取方式请参考获取鉴权token

请求参数(body)

  • content-type: application/json;charset=utf-8
  • 参数说明
    参数 类型 必填 描述
    dimensions int 是 维度: 1:时间; 11:部门; 12:时间+部门; 13:部门+时间
    dateType int 是 时间范围: 11:半小时;12:小时;13:日; 14:周; 15:月
    startDate String 是 开始日期: 2021-01-01
    startTime String 是 开始时间: 00:00
    endDate String 是 结束日期: 2021-01-01
    endTime String 是 结束时间: 24:00
    callType int 是 部门报表类型: 呼入2 外呼3
    customerFields String 是 指标使用逗号隔开 参考部门指标列表
    currPage int 是 默认从1开始的页码
    pageSize int 是 默认15
    departIds String[] 否 部门: 字符串数组格式 如: ["aaa","bbb"]

响应示例:

{
  "apiVersion": "string",
  "status": "string",
  "code": 0,
  "message": "string",
  "reason": "string",
  "kind": "string",
  "metaData": {
      "creatorId": "string",
      "creationTime": 0,
      "updateUserId": "string",
      "updatedTime": 0
  },
  "data": {
    "amount": [
      {
        "departId": "73e6f3c96cc74038aea9ff140e68f9b4",  //部门ID
        "departName": "总公司"        //部门名称
        "inbound_agent_ringingAnswer_partits": 0,    // 	直呼座席接听次数
        "inbound_agent_ringing_partits": 0,          // 	直呼座席次数
        "outbound_customer_noAnswer_calls": 0,      // 	客户未接听次数	
        "outbound_customer_answer_calls": 0         // 	客户接听次数        
      }
    ],
    "metric": [
      {
        "inbound_agent_ringingAnswer_partits": 0,    // 	直呼座席接听次数
        "inbound_agent_ringing_partits": 0,          // 	直呼座席次数
        "outbound_customer_noAnswer_calls": 0,      // 	客户未接听次数	
        "outbound_customer_answer_calls": 0         // 	客户接听次数 
      }
    ],
    "total": 1,
    "currPage": 1,
    "pageSize": 15
  }
}
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
27
28
29
30
31
32
33
34
35
36
37

# 公共数据结构

# ● 电话监控指标参数
参数 类型 必填 描述
inboundCallsCount 整型 是 当前正在呼入且未挂断的电话个数。不包含外呼电话
outboundCallsCount 整型 是 当前正在外呼中的电话个数。不包含呼入电话。
inboundAbandonCallsCountToday 整型 是 呼入电话中，未被座席接听的电话呼损个数。
inboundEstablishedCallsCountToday 整型 是 呼入电话中，已被座席接听的电话个数。
outboundEstablishedCallsCountToday 整型 是 外呼电话中，已被客户接听的电话个数。
loginAgentsCount 整型 是 汇总查询条件下，包含座席登录状态为在线、置忙（包含勿扰和各类小休状态）、系统锁定.
onlineAgentsCount 整型 是 汇总查询条件下，包含座席登录状态为在线。
busyAgentsCount 整型 是 汇总查询条件下，包含座席登录状态为置忙（包含勿扰和各类小休状态）
sysLockAgentsCount 整型 是 汇总查询条件下，包含座席登录状态为系统锁定
logoutAgentsCount 整型 是 汇总查询条件下，包含座席登录状态为离线
inCallAgentsCount 整型 是 汇总查询条件下，包含座席工作状态为呼叫中、振铃中、通话中、保持中的数量
readyAgentsCount 整型 是 汇总查询条件下，包含座席工作状态=就绪中的数量
busyingAgentsCount 整型 是 汇总查询条件下，包含座席工作状态=置忙中的数量
dialingAgentsCount 整型 是 企业全部座席范围内，座席工作状态=呼叫中的数量
ringingAgentsCount 整型 是 企业全部座席范围内=振铃中的数量
establishedAgentsCount 整型 是 企业全部座席范围内，座席工作状态=通话中的数量
heldAgentsCount 整型 是 企业全部座席范围内，座席工作状态=保持中的数量
acwAgentsCount 整型 是 企业全部座席范围内，座席工作状态=整理中的数量
sysLockingAgentsCount 整型 是 企业全部座席范围内，座席工作状态=锁定中的数量
# ● 座席列表汇总情况
参数 类型 必填 描述
inboundEstablishedCallsCountToday 整型 是​ 今日呼入来电中，电话锁定座席后，座席接听成功的次数（非电话个数）
inboundAbandonCallsCountToday 整型 是​ 今天呼入未接次数
outboundCallsCountToday 整型 是​ 今日外呼电话个数
outboundEstablishedCallsCountToday 整型 是​ 今日外呼电话接听个数
# ● 座席列表
参数 类型 必填 描述
agentUUID 字符串 否 座席id
agentID 字符串 是 座席工号
agentName 字符串 是 座席姓名
phoneType 整型 是 接听设备 1: 网页; 2: 微信; 3: PSTN号码; 4: SIP话机; 5:sobotapp
thisDN 字符串 否 座席签入时绑定的分机账号
agentLoginStatus 整型 否 登录状态: 离线(0),在线(1),置忙(2),系统锁定中(98)
agentWorkStatus 整型 否 工作状态: 就绪中(1),置忙中(2),整理中(4),振铃中(5),响铃中(6),通话中(7),保持中(8)
agentBusyReasonCode 整型 否 置忙原因
lastLoginStatusChangedTime 毫秒时间戳 否 最近座席登录状态改变时间戳(毫秒)
lastWorkStatusChangedTime 毫秒时间戳 否 最近座席工作状态改变时间戳(毫秒)
customerNumber 字符串 是​ UI显示的客户号码
customerPrivacyNumber 字符串 是​ 客户号码加密
callType 整型 是​ 呼叫类型: 2: 呼入 3: 呼出
inboundEstablishedCallsCountToday 整型 是​ 今日呼入来电中，电话锁定座席后，座席接听成功的次数（非电话个数）
inboundAbandonCallsCountToday 整型 是​ 今天呼入未接次数
outboundCallsCountToday 整型 是​ 今日外呼电话个数
outboundEstablishedCallsCountToday 整型 是​ 今日外呼电话接听个数
clientType 字符串 否 Web; Android; IOS; Unknown;
# ● 机器人通话主话单
参数 类型 描述
callID String 通话记录简称为：主话单; 1通电话有且仅有1个主话单id
mainDialType String Inbound:呼入；RegularMakeCall:普通外呼；ClickToCallback:点击拨号；TwoWayToPSTN:双向回呼；Internal:内部通话；PreviewOutbound:预览外呼；PredictiveOutbound:预测外呼
callType int 1.内部通话；2.呼入；3.外呼；
customerNumber String 客户号码; 仅推送
areaCode String 客户号码区号
areaProvince String 客户号码省
areaCity String 客户号码市
customerId String 客户id
gatewayNumber String 中继号码
inboundTransferedHumanAgent boolean 是否转人工
startTime long 开始时间 毫秒时间戳
userStartTime long 呼叫时间 毫秒时间戳
alertTime long 客户侧振铃时间 毫秒时间戳
answerTime long 客户侧的计费开始时间 毫秒时间戳
waitingForHumanAnswerDuration long 等待人工接听时长 秒
virtualAgentCallDuration long 机器人通话时长 秒
bridgeTime long 通话时间 毫秒时间戳
endTime long 结束时间 毫秒时间戳
alertDuration long 振铃时长 秒
duration int 通话时长 秒
totalDuration int 电话总时长 秒
callResult int 通话结果: 4.未找到座席侧 5.客户速挂6.座席侧未接听 7.客户未接听 8.双方已接听 21.客户已接听 22.系统未应答
reasonOfNotAnswer String 未接原因，OTHER_RINGBACK:其他回铃音；OUT_OF_SERVICE:停机；DOES_NOT_EXIST:空号；POWER_OFF:关机；BUSY_NOW:用户正忙；NOT_ANSWER:无人接听；LINE_INTERCEPTION:线路拦截；CUSTOMER_REJECTION:客户拒接；CUSTOMER_NUM_BLACKLIST:客户号码黑名单；GATEWAY_NUM_DISABLE:中继号码停用；ARREARS:欠费；ROUTE_UNCOMPLETE:呼入路由未完成；NO_ROUTE_MATCH:呼入路由未匹配
intentClassify String 意向标签分类
intentName String 意向标签名称
totalCustomerRepliesToVirtualAgentCount int 累计对话轮次
firstCallAgentUUID String 首次呼叫座席ID
firstCallAgentID String 首次呼叫座席工号
firstCallAgentName String 首次呼叫座席姓名
firstAgentUUID String 首次接听人工座席ID
firstAgentID String 首次接听人工座席工号
firstAgentName String 首次接听人工座席姓名
accumAgentRingingDuration long 累计座席振铃时长 秒
hangupDisposition int 挂断方 1.其他 2.座席挂 3.客户挂
userData String 自定义数据
recordUrl String 录音地址
platformId String 平台id
companyId String 企业id
feeSeconds int 计费时长（秒）
feeMinutes int 计费时长（分钟）
firstRouteId String 首次接待路由id
firstRouteName String 首次接待路由名称
belongAgentUUID String 接听所属人工座席ID
belongAgentID String 接听所属人工座席工号
belongAgentName String 接听所属人工座席姓名
belongAgentDN String 接听所属人工座席分机
belongAgentPhoneType String 座席接听设备
belongAgentPSTN String 接听所属人工座席通话号码
transferCount int 发起转移次数
consultCount int 咨询接听次数
sourceType int 来源记录类型 1:通话记录，2:工单，3:会话记录，4:外呼任务，5:联系计划，6:呼损，7留言
sourceId String 来源记录ID
sourceCode String 来源记录Code
sourceRecordSubId String 来源记录子ID
sourceRecordSubCode String 来源记录子Code
sourceRecordMainId String 来源记录主ID
sourceRecordMainCode String 来源记录主Code
variablesCollectedDuringCall String 通话过程中收集的临时动态变量
transferToThirdPartySystem String 转三方系统，NonTransfer:未转接,TransferNonAnswer:转接未接听,TransferAndAnswer:转接已接听
transferToThirdPartyNumber String 转三方号码，NonTransfer:未转接,TransferNonAnswer:转接未接听, TransferAndAnswer:转接已接听
dialogue JSON 对话记录

dialogue

参数 类型 描述
phaseId String 对话记录ID
phase String 对话阶段，Agent:人工座席，ThirdPSTN:第三方号码，ThirdSystem:第三方系统，VirtualAgent:机器人，System:系统
startTime long 开始时间 毫秒时间戳
endTime long 结束时间 毫秒时间戳
contentList JSON 对话内容

contentList

参数 类型 描述
phaseId String 对话记录ID
contentId String 对话内容ID
partyId String 座席通话明细ID（对应的子话单ID,或者为系统对应的partyId）
startTime long 开始时间 毫秒时间戳
endTime long 结束时间 毫秒时间戳
nodeId String 节点ID
nodeName String 节点名称
dialogueType String 对话类型， NORMAL:普通对话，CRITICAL:关键对话，(CUS_CRITICAL:客户关键对话，即客户对机器人关键问题的回复)
dialogueRole String 对话角色，Agent:人工座席，ThirdPSTN:第三方号码，ThirdSystem:第三方系统，VirtualAgent:机器人，System:系统，Customer:客户
sentenceMessage String 对话文本
matchedLog String 匹配日志
# ● 机器人通话子话单
参数 类型 描述
callID String 通话记录简称为：主话单; 1通电话有且仅有1个主话单id
partyId String 座席通话明细简称为：子话单; 1通电话可以有多个子话单id
callType int 通话类型 1: 内部通话; 2: 呼入; 3: 外呼;
agentRole int 座席类型，2.人工座席 4.第三方号码 5.转第三方系统
phoneType int 接听设备 1: 网页; 3: PSTN号码; 4: SIP话机; 5:sobotapp
agentUUID String 座席id
agentID String 座席工号
agentName String 座席名称
agentDN String 座席分机
DNIS String 座席侧电话号码，当座席类型=人工座席、接听设备=电话号码时，非空;当座席类型=第三方号码时,非空
gatewayNumber String 座席侧中继号码
startTime long 呼叫时间
alertTime long 振铃时间
answerTime long 接听时间
bridgeTime long 桥接通话时间，座席侧加入通话（与用户通话或与其他座席通话）的开始时间
endTime long 结束时间
alertDuration long 振铃时长
duration int 通话时长
callResult int 呼叫结果: 1.呼叫失败 2.座席未接听 3.座席已接听
customerRepliesToVirtualAgentCount int 对话轮次（客户回复机器人座席侧的对话次数）
fromQueueID String 来源技能组编码
fromQueueName String 来源技能组名称
hangupDisposition int 挂断方:1.其他 2.座席侧 3.客户侧
feeSeconds int 计费时长（秒）
feeMinutes int 计费时长（分钟）
platformId String 平台id
companyId String 企业id
belongAgentFlag boolean 电话所属人工座席，1通电话里有且仅最多只有1位所属人工座席。通常为最后一位退出通话的人工座席。true：所属人工座席；false：非所属人工座席。
intentTagClassify String 意向分类
intentTagName String 意向名称
# ● 人工通话主话单
参数 类型 必填 描述
callID String 是 通话记录简称为：主话单; 1通电话有且仅有1个主话单id
callType int 是 1.内部通话；2.呼入；3.外呼；
mainDialType String 是 Inbound:呼入；RegularMakeCall:普通外呼；ClickToCallback:点击拨号；TwoWayToPSTN:双向回呼；Internal:内部通话；PreviewOutbound:预览外呼；PredictiveOutbound:预测外呼
screenNumber String 否 屏显号码; 仅查询
customerNumber String 否 客户号码; 仅推送
encryptCustomerNumber String 否 加密后号码; 仅查询
areaPrefix String 否 客户号码地区前缀(冗余字段)
areaCode String 否 客户号码区号
areaProvince String 否 客户号码所属省
areaCity String 否 客户号码所属市
customerId String 否 客户id
gatewayNumber String 否 中继号码
gatewayNumberNick String 否 中继号码别名
startTime 毫秒时间戳 否 呼叫的开始时间
alertTime 毫秒时间戳 否 客户侧振铃时间
answerTime 毫秒时间戳 否 客户侧的计费开始时间
bridgeTime 毫秒时间戳 否 客户侧的桥接通话时间
endTime 毫秒时间戳 否 客户侧电话挂断时间，包含满意度评价的时间
alertDuration 秒 否 振铃时长
accumAgentRingingDuration 秒 否 累计座席振铃时长
duration 秒 否 结束时间-通话时间
totalDuration 秒 否 电话总时长 结束时间-呼叫时间
callResult int 否 通话结果: 4.未找到座席侧 5.客户速挂6.座席侧未接听 7.客户未接听 8.双方已接听 21.客户已接听 22.系统未应答
earlyDetectCause String 否 客户侧回铃音： "", 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听；默认未知； 当呼叫类型为呼入时该值为""
reasonOfNotAnswer String 否 OTHER_RINGBACK:其他回铃音；OUT_OF_SERVICE:停机；DOES_NOT_EXIST:空号；POWER_OFF:关机；BUSY_NOW:用户正忙；NOT_ANSWER:无人接听；LINE_INTERCEPTION:线路拦截；CUSTOMER_REJECTION:客户拒接；CUSTOMER_NUM_BLACKLIST:客户号码黑名单；GATEWAY_NUM_DISABLE:中继号码停用；ARREARS:欠费；ROUTE_UNCOMPLETE:呼入路由未完成；NO_ROUTE_MATCH:呼入路由未匹配
hangupDisposition int 否 挂断方 1.其他 2.座席侧 3.客户侧
attachedData String 否 随路数据
recordUrl String 否 录音
platformId String 否 平台id
companyId String 否 企业id
feeSeconds int 否 计费时长（秒）
feeMinutes int 否 计费时长（分钟）
firstRouteId String 否 首次接待路由id
firstRouteName String 否 首次接待路由名称
belongAgentUUID String 否 电话所属人工座席id
belongAgentID String 否 座席工号
belongAgentName String 否 座席名称
belongAgentDN String 否 座席分机
belongAgentPhoneType String 否 座席接听设备
belongAgentPSTN String 否 电话所属人工座席通话号码
transferCount int 否 发起转移次数
consultCount int 否 咨询接听次数
summaryHandleProgress int 否 处理进度
summaryHandleProgressName string 否 处理进度名称
callerNumber String 否 主叫号码
callerAgentUUID String 否 主叫座席ID
callerDN String 否 主叫分机
calleeNumber String 否 被叫号码
calleeAgentUUID String 否 被叫座席ID
calleeDN String 否 被叫分机
firstCallAgentUUID String 否 首次呼叫座席ID
firstCallAgentID String 否 首次呼叫座席工号
firstCallAgentName String 否 首次呼叫座席名称
firstAgentUUID String 否 首次接听座席ID
firstAgentID String 否 首次接听座席工号
firstAgentName String 否 首次接听座席名称
userData String 否 自定义数据
sourceType int 否 来源记录类型 1:通话记录，2:工单，3:会话记录，4:外呼任务，5:联系计划，6:呼损，7留言
sourceId String 否 来源记录ID
sourceCode String 否 来源记录Code
sourceRecordSubId String 否 来源记录子ID
sourceRecordSubCode String 否 来源记录子Code
sourceRecordMainId String 否 来源记录主ID
sourceRecordMainCode String 否 来源记录主Code
# ● 人工通话子话单
参数 类型 必填 描述
callID String 是 通话记录简称为：主话单; 1通电话有且仅有1个主话单id
partyId String 是 座席通话明细简称为：子话单; 1通电话可以有多个子话单id
dialType int 是 呼叫类型: 1.呼叫 2.转移 3.咨询 4.监听 5.抢接 6.强插
agentRole int 是 座席类型: 2.人工座席 4.三方号码 5.虚拟座席
phoneType int 是 接听设备: 1.网页 3.电话号码 4.SIP话机
callResult int 是 呼叫结果: 1.呼叫失败 2.座席未接听 3.座席已接听
hangupDisposition int 是 座席侧通话被结束的触发原因； 2：座席 1:其他
companyId String 是 企业id
belongAgentFlag boolean 是 1通电话里有且仅最多只有1位所属人工座席。通常为最后一位退出通话的人工座席。true：所属人工座席；false：非所属人工座席。
agentUUID String 否 计费座席ID; 当座席类型=第三方号码时,为空
agentID String 否 计费座席工号
agentName String 否 计费座席名称
agentDN String 否 计费座席的分机账号
DNIS String 否 当座席类型=人工座席、接听设备=电话号码时，非空;当座席类型=第三方号码时,非空
gatewayNumber String 否 系统呼叫座席侧电话号码时的主叫号码
startTime 毫秒时间戳 否 座席侧发起呼叫的开始时间
alertTime 毫秒时间戳 否 座席侧开始振铃时间
answerTime 毫秒时间戳 否 座席侧的计费开始时间
bridgeTime 毫秒时间戳 否 桥接通话时间，座席侧加入通话（与用户通话或与其他座席通话）的开始时间
endTime 毫秒时间戳 否 座席侧电话挂断时间
duration 秒 否 座席侧桥接加入通话时长=结束时间-通话时间
feeSeconds 秒 否 计费时长(秒) 结束时间-接听时间
feeMinutes 分钟 否 计费时长（分钟） 结束时间-接听时间
platformId String 否 企业id
earlyDetectCause String 否 呼叫座席侧使用手机方式 或者转第三方号码时： 未知，停机，空号，关机，用户正忙，无人接听，线路拦截，已接听； 座席以sip或者网页登录方式时该值为""
totalDuration int 否 呼叫总时长
# ● 错误编码表
错误编码 错误Reason 备注说明
3001 AgentIsInBargedInScene 座席已经在强插中
3002 AgentIsInMonitorScene 座席已经在监听中
3003 AgentIsInInterceptScene 座席已经在强拆中
3004 AgentIsInConsultScene 座席已经在咨询中
3005 AgentIsInConferenceScene 座席已经在会议中
3101 AgentIsInDailingScene 座席正在呼叫中
3102 AgentIsInDailingScene 座席正在响铃中
# ● 中继号码指标列表
指标名 指标含义 指标类型 备注说明
呼入总数 inbound_calls 计数器
系统未应答数 inbound_no_answered_calls 计数器
系统应答数 inbound_answered_calls 计数器
路由座席数 inbound_route_to_agent_calls 计数器
路由第三方号码数 inbound_route_to_thirdPSTN_calls 计数器
路由外呼座席记忆数 inbound_route_to_agentMemory_calls 计数器
转人工数 inbound_toAgent_calls 计数器
呼叫座席侧数 inbound_offer_agent_calls 计数器
呼叫座席侧振铃数 inbound_agent_ring_calls 计数器
呼叫座席侧接听数 inbound_agent_answered_calls 计数器
非人工座席接听数 inbound_notHumanAgent_answered_calls 计数器
人工座席接听数 inbound_humanAgent_answered_calls 计数器
呼入通话时长 inbound_agentTalk_duration 时长
呼入平均通话时长 inbound_agentTalk_average_duration 时长
呼入电话时长 inbound_calls_duration 时长
呼入平均电话时长 inbound_calls_average_duration 时长
外呼电话数 outbound_calls 计数器
外呼号码数 outbound_customer_numbers 计数器
客户未接听数 outbound_customer_noAnswer_calls 计数器
客户接听电话数 outbound_customer_answer_calls 计数器
客户接听号码数 outbound_answer_gateway_numbers 计数器
电话接听率 outbound_answer_ratio 计算
号码接听率 outbound_gateway_numbers_ratio 计算
外呼X秒通话量 outbound_agentTalkXs_ratio 计数器
外呼X秒通话占比 outbound_agentTalkXs_calls 计算
外呼电话时长 outbound_calls_duration 时长
外呼通话时长 outbound_calls_talk_duration 时长
外呼平均通话时长 outbound_calls_average_duration 时长
外呼X秒通话时长 outbound_effective_inXs_sum_duration 时长
外呼X秒平均通话时长 outbound_effective_inXs_average_duration 时长
# ● 座席指标列表
指标名 指标含义 指标类型 备注说明
呼入座席次数 inbound_agent_partits 计数器
呼入座席接听次数 inbound_agent_answer_partits 计数器
呼入座席未接听次数 inbound_agent_unAnswer_partits 计数器
直呼座席次数 inbound_agent_ringing_partits 计数器
直呼座席接听次数 inbound_agent_ringingAnswer_partits 计数器
呼入座席振铃次数 inbound_agent_dialing_partits 计数器
直呼座席未接听次数 inbound_agent_ringingUnAnswer_partits 计数器
转移到座席次数 inbound_agent_transferBy_partits 计数器
转移到座席接听次数 inbound_agent_transferByAnswer_partits 计数器
转移到座席未接听次数 inbound_agent_transferByUnAnswer_partits 计数器
咨询到座席次数 inbound_agent_consultBy_partits 计数器
咨询到座席接听次数 inbound_agent_consultByAnswer_partits 计数器
咨询到座席未接听次数 inbound_agent_consultByUnAnswer_partits 计数器
呼入座席接听电话数 inbound_agent_callByAnswer_partits 计数器
呼入通话时长 inbound_agentTalk_duration 时长
呼入平均通话时长 inbound_agentTalk_average_duration 时长
外呼次数 outbound_calls 计数器
客户未接听次数 outbound_customer_noAnswer_calls 计数器
客户接听次数 outbound_customer_answer_calls 计数器
外呼次数接听率 outbound_answer_ratio 计算
外呼X秒通话次数 outbound_agent_effectiveTalkInXs_partits 计数器
外呼X秒通话占比 outbound_agent_effectiveTalkInXs_radio 计算
外呼电话时长 outbound_calls_duration 时长
外呼通话时长 outbound_calls_talk_duration 时长
外呼平均通话时长 outbound_calls_average_duration 时长
外呼X秒通话时长 outbound_effective_inXs_sum_duration 时长
外呼X秒平均通话时长 outbound_effective_inXs_average_duration 时长
登录总时长 agent_login_sum_duration 时长
登录在线时长 agent_online_sum_duration 时长
登录系统锁定时长 agent_syslock_sum_duration 时长
勿扰和小休时长 agent_busy_sum_duration 时长
勿扰时长 agent_DND_sum_duration 时长
全部小休时长 agent_rest_sum_duration 时长
小休11时长 agent_rest11_sum_duration 时长
小休12时长 agent_rest12_sum_duration 时长
小休13时长 agent_rest13_sum_duration 时长
小休14时长 agent_rest14_sum_duration 时长
小休15时长 agent_rest15_sum_duration 时长
小休16时长 agent_rest16_sum_duration 时长
小休17时长 agent_rest17_sum_duration 时长
小休18时长 agent_rest18_sum_duration 时长
就绪中时长 agent_readying_sum_duration 时长
置忙中时长 agent_busying_sum_duration 时长
整理中时长 agent_acwing_sum_duration 时长
全部电话中时长 agent_calling_sum_duration 时长
呼叫中时长 agent_dialing_sum_duration 时长
振铃中时长 agent_ringing_sum_duration 时长
通话中时长 agent_talking_sum_duration 时长
保持中时长 agent_helding_sum_duration 时长
勿扰-置忙中时长 agent_DND_busy_duration 时长
全部小休-置忙中时长 agent_rest_busy_sum_duration 时长
小休11-置忙中时长 agent_rest11_busy_sum_duration 时长
小休12-置忙中时长 agent_rest12_busy_sum_duration 时长
小休13-置忙中时长 agent_rest13_busy_sum_duration 时长
小休14-置忙中时长 agent_rest14_busy_sum_duration 时长
小休15-置忙中时长 agent_rest15_busy_sum_duration 时长
小休16-置忙中时长 agent_rest16_busy_sum_duration 时长
小休17-置忙中时长 agent_rest17_busy_sum_duration 时长
小休18-置忙中时长 agent_rest18_busy_sum_duration 时长
在线时长占比 agentOnline_percent 计算
勿扰和小休时长占比 agentBusy_percent 计算
勿扰时长占比 agentDND_percent 计算
全部小休时长占比 agentRest_percent 计算
就绪中时长占比 workReady_percent 计算
置忙中时长占比 workBusy_percent 计算
全部电话中时长占比 workinCall_percent 计算
整理中时长占比 workACW_percent 计算
工作占用时长A workReasonCodeA_sum_duration 时长
工作占用时长B workReasonCodeB_sum_duration 时长
工作占用率A workReasonCodeA_percent 计算
工作占用率B workReasonCodeB_percent 计算
勿扰-置忙中时长占比 agent_DND_busy_sum_duration_radio 计算
全部小休-置忙中时长占比 agent_rest_busy_sum_duration_redio 计算
首次签入时间 agentFirstLogin_timestamp 时长
首次置闲时间 agentFirstOnline_timestamp 时长
最后签出时间 agentLastLogout_timestamp 时长
# ● 部门指标列表
指标名 指标含义 指标类型 备注说明
呼入座席次数 inbound_agent_partits 计数器
呼入座席振铃次数 inbound_agent_dialing_partits 计数器
呼入座席接听次数 inbound_agent_answer_partits 计数器
呼入座席未接听次数 inbound_agent_unAnswer_partits 计数器
直呼座席次数 inbound_agent_ringing_partits 计数器
直呼座席接听次数 inbound_agent_ringingAnswer_partits 计数器
直呼座席未接听次数 inbound_agent_ringingUnAnswer_partits 计数器
转移到座席次数 inbound_agent_transferBy_partits 计数器
转移到座席接听次数 inbound_agent_transferByAnswer_partits 计数器
转移到座席未接听次数 inbound_agent_transferByUnAnswer_partits 计数器
咨询到座席次数 inbound_agent_consultBy_partits 计数器
咨询到座席接听次数 inbound_agent_consultByAnswer_partits 计数器
咨询到座席未接听次数 inbound_agent_consultByUnAnswer_partits 计数器
呼入通话时长 inbound_agentTalk_duration 时长
呼入平均通话时长 inbound_agentTalk_average_duration 时长
外呼次数 outbound_calls 计数器
客户未接听次数 outbound_customer_noAnswer_calls 计数器
客户接听次数 outbound_customer_answer_calls 计数器
外呼次数接听率 outbound_answer_ratio 计算
外呼X秒通话次数 outbound_agent_effectiveTalkInXs_partits 计数器
外呼X秒通话占比 outbound_agent_effectiveTalkInXs_radio 计算
外呼电话时长 outbound_calls_duration 时长
外呼通话时长 outbound_calls_talk_duration 时长
外呼平均通话时长 outbound_calls_average_duration 时长
外呼X秒通话时长 outbound_effective_inXs_sum_duration 时长
外呼X秒平均通话时长 outbound_effective_inXs_average_duration 时长
上次更新: 2024/7/8 20:00:22

← 呼叫能力 (https)→

最近更新
01
大模型机器人API
09-09
02
LINE API
06-25
03
Facebook Messenger API
04-28
更多文章>
Theme by Vdoing