通话记录查询
服务描述
本接口,可用于查询租户下通话记录,并分页返回通话的数据
开发须知
调用本接口前,请先获取appId
服务地址
GET https://{您的专属域名}/speech/openapi/v1/communicate/pageQuery
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
queryMode |
param |
Integer |
N |
查询模式(1:所有;2:待提交话务的通话记录,3:已提交话务的通话记录),默认:1 |
userId |
param |
Long |
N |
坐席id;不传时查询租户所有通话记录 |
callType |
param |
Integer |
N |
呼叫类型(1:呼入,2:呼出,3:自动外呼) |
startDate |
param |
String |
N |
开始日期,例如20200227 |
endDate |
param |
String |
N |
结束日期,例如20200227 |
callResult |
param |
Integer |
N |
呼叫结果(0:未知,1:无法接通,2:已接通,3:无人应答,4:队列放弃,5:非服务时间,6:振铃未接,7:客户速挂,8:IVR中放弃) |
evaluationScore |
param |
Integer |
N |
满意度(0,1,2,3,4,5) |
skillsetName |
param |
String |
N |
技能组 |
searchInfo |
param |
String |
N |
坐席、主叫号码或被叫号码,模糊查询 |
nameOrPhoneOrRelay |
param |
String |
N |
客户姓名、客户号码或中继号 |
summaryId |
param |
String |
N |
会话小结id |
name |
param |
String |
N |
客户姓名/客服姓名 |
customerPhone |
param |
String |
N |
客户号码 |
taskId |
param |
Long |
N |
外呼任务id,callType=3时有效 |
pageNum |
param |
Integer |
N |
页号,由0开始(默认1) |
pageSize |
param |
Integer |
N |
每页数据条数(默认20) |
请求示例数据:
GET https://abc.xyz/speech/openapi/v1/communicate/pageQuery?pageNum=0&pageSize=10
sign: fo1OWX+JnfeonAFSGau2gwP1GvFa+RTw5czoBWoz+k3AjV8scDl6JnvFRDj8Lgt1nQxLlmcOhIBN4j7pEE/NAzYjXUFSGo308f5V9dHBnmGLYsqKmgma4cQZLBqHp9T43IZfRX8Zh2/Hp2HOmfTgos/L8GN6YPA8fQ2d5tbtJZrrkBuwA/LEezjOJxSRRRCrcS1ZFVvTZ+cIjYeO4QdC5r5I67LLY/nLbFAFUdQsCzUIytO09vUCLGlKierNhPfCtMzTgZSE9dWO5zJ3L2uCsXM7Od6mPROVpddVafF+BueKjtbL10PwDc9f1eBpGTpgmbOy8Bbx3NIyCjDvhc9Mag==
appId: 99845aaaaebd4d61acccc9b776208f12
timestamp: 1586314097995
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
PageInfo |
分页对象 |
PageInfo
参数 |
类型 |
说明 |
pageNum |
String |
当前页码 |
pageSize |
String |
页大小 |
size |
Integer |
当前页记录数 |
total |
Integer |
总记录数 |
pages |
Integer |
总页数 |
list |
CommunicateBaseVo |
数据集合 |
CommunicateBaseVo
参数 |
类型 |
说明 |
communicateId |
String |
通话记录ID |
callId |
String |
icc通话记录ID |
callType |
Integer |
通话类型(1:呼入,2:呼出,3:自动外呼) |
taskName |
String |
外呼任务 |
customerId |
String |
客户ID |
customerName |
String |
客户姓名 |
noteStatus |
Integer |
话务小结状态(1:待提交,2:已提交) |
callTimeStr |
String |
通话时间(2019-12-17 10:25:56) |
relayNumber |
String |
中继号 |
customerNumber |
String |
客户号码 |
speechCallResult |
Integer |
呼叫中心自定义通话结果0:默认值(无意义) 1:无法接通 2:已接通 3:无人应答,4:队列放弃 5:非服务时间 6:坐席振铃未接 7:客户速挂 8:IVR中放弃 9:客户振铃坐席挂机 10:禁止呼叫 |
summaryTitles |
String |
通话小结 |
communicateDuration |
String |
通话时长,格式:3分18秒 |
communicateDurationNum |
String |
通话时长,格式:00:00:00 |
staffId |
Integer |
坐席ID |
staffName |
String |
坐席姓名 |
skillsetName |
String |
技能组名称 |
communicateNote |
String |
服务记录 |
iccRecordDate |
String |
ICC时间戳,接通后有值 |
communicateVoiceId |
String |
通话录音ID,接通后有值 |
custNumberAttribution |
String |
客户手机号归属地 |
custIspName |
String |
客户手机号运营商 |
evaluationScore |
Integer |
满意度 |
transferId |
String |
转接(0:无转接;1:有转接) |
hangUpDirectionType |
String |
挂机方向 |
realCustomerNo |
String |
真实号码 |
expansionFields |
String |
小结及扩展字段 |
expansionFields说明:
参数 |
类型 |
说明 |
type |
Integer |
类型(0 - 通话小节,1 - 服务备注,2 - 单行文本,3 - 多行文本,4 - 下拉框,5 - 选框,6 - 数字,7 - 日期和时间) |
name |
String |
自定义字段名 |
required |
boolean |
是否必填 |
otherRules |
String |
规则 |
otherRules说明:
参数 |
类型 |
说明 |
fieldInnerType |
Integer |
1、下拉框 OR 选框(0 - 单选项;1 - 多选项)2、数字(0 - 数值;1 - 百分比)3、日期和时间(0 - 仅日期;1 - 日期和时间) |
data |
object |
自定义选项等 |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": {
"pageNum": 1,
"pageSize": 20,
"size": 20,
"orderBy": null,
"startRow": 1,
"endRow": 20,
"total": 55,
"pages": 3,
"list": [{
"communicateId": "000042c3-03ce-4ee7-9c85-0f74e7a53a62",
"callId": "80a365c4-7f6e-41b5-857b-58041e82a60f",
"callType": 3,
"taskName": "测试任务",
"customerId": "080d2bcfedac41c9a0ecc409ab70db3e",
"customerName": "18328597414",
"noteStatus": 1,
"callTimeStr": "2020-03-28 11:18:24",
"relayNumber": "86073759",
"customerNumber": "18328597414",
"callResult": 2,
"speechCallResult": 2,
"summaryTitles": "",
"communicateDuration": "8秒",
"communicateDurationNum": "00:00:08",
"staffId": 19881238,
"staffName": "test156-300003",
"skillsetName": "呼出技能组",
"communicateNote": null,
"iccRecordDate": "1569289519432",
"communicateVoiceId": "08079d97-e0e5-4f07-a943-e504118e47cc",
"custNumberAttribution": "四川成都",
"custIspName": "中国移动",
"evaluationScore": 0,
"transferId": "0",
"hangUpDirectionType": "AGENT_DROPPED_CALL",
"realCustomerNo": "15308228114",
"expansionFields": "[{\"id\":121,\"type\":0,\"name\":\"通话小结\",\"required\":false,\"otherRules\":{},\"value\":[{\"id\":\"5ae13e0487284f7282c2cda41aa07a1c\",\"summary\":\"业务咨询\"}]},{\"id\":153,\"type\":4,\"name\":\"紧急程度\",\"required\":false,\"otherRules\":{\"data\":[{\"value\":\"一般\",\"selected\":true},{\"value\":\"加急\",\"selected\":false},{\"value\":\"暂缓\",\"selected\":false}],\"fieldInnerType\":0},\"value\":\"一般\"},{\"id\":122,\"type\":1,\"name\":\"服务备注\",\"required\":false,\"otherRules\":{},\"value\":\"客户告知健康宝没有更新,已告知客户联系健康宝客服\"}]"
}],
"firstPage": 1,
"prePage": 0,
"nextPage": 2,
"lastPage": 3,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [1, 2, 3]
}
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
10001 |
鉴权失败 |
10002 |
找不到对应的公钥,请先上传公钥 |
20001 |
请求失败 |
29002 |
参数错误 |
29008 |
系统异常 |
FAQ: