通话记录查询
- URL:
https://api-westus.nxlink.ai/openapi/aiagent/call/list
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
请求参数
header参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
accessKey |
String |
是 |
AK-6230339248928541113-2133 |
用户身份标识 |
ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType |
String |
是 |
100 |
业务类型,取固定值“100” |
action |
String |
是 |
nxai |
业务操作,取固定值“nxai” |
sign |
String |
是 |
6e9506557d1f289501d333ee2c365826 |
API入参参数签名 查看公共约定 |
请求参数:
请求参数
参数名 |
类型 |
必选 |
示例值 |
说明 |
taskId |
String |
是 |
"52145b00-abc9-4a87-94c2-ed1e1e42ec1c" |
任务ID(从AI Agent外呼接口中返回的数据获取) |
startTs |
Integer |
否 |
1736215928 |
开始时间戳(单位秒) |
endTs |
Integer |
否 |
1746583929 |
结束时间戳(单位秒) |
callId |
String |
否 |
"call_2023112501234" |
通话ID |
phone |
String |
否 |
"1380xxxxx" |
电话号码 |
callResult |
Integer |
否 |
1 |
通话结果:1-正常结束-已沟通,2-人声,3-正常结束-AI坐席挂断,6-呼出未接-坐席速挂,7-呼出未接-用户速挂,8-呼出未接-用户响铃拒接,9-呼出未接-超时未接,10-呼出未接-黑名单号码,11-呼出未接-呼叫限制号码,12-无法接通-无法接通,13-无法接通-呼叫拒绝,14-无法接通-暂时无法接通,15-无法接通-线路繁忙,16-无法接通-呼叫异常,17-正常结束-用户挂断,18-语音信箱,19-正常结束-早媒体语音信箱,20-静音,21-系统异常 |
userIntent |
String |
否 |
"感兴趣" |
会话标签(当callResult为1,3,17,21时会有数据) |
pageNumber |
Integer |
是 |
1 |
页码 |
pageSize |
Integer |
是 |
10 |
每页大小 |
minElapsed |
Long |
否 |
60 |
最小通话时长(秒) |
maxElapsed |
Long |
否 |
300 |
最大通话时长(秒) |
请求示例
请求body:
{
"taskId": "8bdf2a84-fc89-483e-ba1e-35a54285c7d0",
"startTs": 1736238951,
"endTs": 1746606952,
"callId": "",
"phone": "",
"callResult": "",
"userIntent": "",
"pageNumber": 1,
"pageSize": 10,
"minElapsed": 0,
"maxElapsed": 3000
}
响应参数
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
结果编码 |
message |
String |
请求结果说明 |
traceId |
String |
链路追踪ID |
data |
Object |
响应数据主体 |
data对象
参数名 |
类型 |
说明 |
total |
Integer |
总记录数 |
pageNumber |
Integer |
当前页码 |
pageSize |
Integer |
每页大小 |
list |
Array |
通话记录列表 |
list元素
参数名 |
类型 |
说明 |
id |
Long |
id |
taskId |
String |
任务id |
contactId |
String |
名单id |
autoFlowId |
Long |
机器人id |
orderHead |
Integer |
标识,首通的标识,0:no,1:yes |
orderTail |
Integer |
标识,最后一通的标识,0:no,1:yes |
callerPhone |
String |
主叫号码 |
calleePhone |
String |
号码 |
realPhone |
String |
真实号码 |
callId |
String |
通话ID |
callStatus |
Integer |
通话状态:1-待拨打,2-调度中,3-拨打中,4-响铃中,5-正在通话,6-TTS 语音合成中,7-暂停,10-完成通话,11-不合法号码,12-无法接通,13-用户占线,14-用户忙线并拒接,15-用户拒接,16-调度出错,17-TTS 语音合成失败,18-未知原因,19-黑名单号码,20-叫停:主动叫停或者余额不足,21-客户余额不足,22-号码方向非法,23-无效号码,24-响铃未接,25-拨打没响应,26-早媒体-语音信箱,27-响铃过长,28-路由无线路可用,29-线路服务不可用 |
callResult |
Integer |
通话结果:1-正常结束-已沟通,2-人声,3-正常结束-AI坐席挂断,6-呼出未接-坐席速挂,7-呼出未接-用户速挂,8-呼出未接-用户响铃拒接,9-呼出未接-超时未接,10-呼出未接-黑名单号码,11-呼出未接-呼叫限制号码,12-无法接通-无法接通,13-无法接通-呼叫拒绝,14-无法接通-暂时无法接通,15-无法接通-线路繁忙,16-无法接通-呼叫异常,17-正常结束-用户挂断,18-语音信箱,19-正常结束-早媒体语音信箱,20-静音,21-系统异常 |
createTs |
Long |
创建秒级时间戳 |
opTs |
Integer |
操作秒级时间戳 |
callStart |
Long |
开始通话秒级时间戳 |
callAnswer |
Long |
接听通话秒级时间戳 |
callEnd |
Long |
结束通话秒级时间戳 |
callRingTime |
Long |
振铃时长 |
callElapsed |
Long |
通话时长,单位为秒 |
lineId |
String |
通话选择的线路 |
routeId |
String |
通话选择的路由 |
callAudioUrl |
String |
通话url |
userIntent |
String |
用户意图 |
callSummary |
String |
通话摘要 |
turnTime |
Integer |
对话轮次 |
manualCallStart |
Integer |
人工通话开始秒级时间戳 |
manualCallAnswer |
Integer |
人工通话接通秒级时间戳 |
manualCallEnd |
Integer |
人工通话结束秒级时间戳 |
manualCallStatus |
Integer |
人工通话状态 |
manualElapsed |
Integer |
人工通话时长 |
agentName |
String |
座机账号 |
agentId |
String |
座机账号Id |
agentGroupName |
String |
坐席组 |
agentGroupId |
String |
坐席组Id |
callCallbackUrl |
String |
通话结束回调url |
orderCallbackUrl |
String |
订单结束回调url |
sipAddr |
String |
线路地址 |
sipCode |
String |
sip code |
hangupReason |
String |
挂断原因 |
attributes |
Array |
变量信息 |
autoFlowName |
String |
ai agent 名称 |
attributes元素 (ParamsInfo)
参数名 |
类型 |
说明 |
name |
String |
参数名称 |
key |
String |
参数键 |
value |
String |
参数值 |
通话状态(callStatus)详细说明
值 |
说明 |
1 |
待拨打 |
2 |
调度中 |
3 |
拨打中 |
4 |
响铃中 |
5 |
正在通话 |
6 |
TTS 语音合成中 |
7 |
暂停 |
10 |
完成通话 |
11 |
不合法号码 |
12 |
无法接通 |
13 |
用户占线 |
14 |
用户忙线并拒接 |
15 |
用户拒接 |
16 |
调度出错 |
17 |
TTS 语音合成失败 |
18 |
未知原因 |
19 |
黑名单号码 |
20 |
叫停:主动叫停或者余额不足 |
21 |
客户余额不足 |
22 |
号码方向非法 |
23 |
无效号码 |
24 |
响铃未接 |
25 |
拨打没响应 |
26 |
早媒体-语音信箱 |
27 |
响铃过长 |
28 |
路由无线路可用 |
29 |
线路服务不可用 |
通话结果(callResult)详细说明
值 |
说明 |
1 |
正常结束-已沟通 |
2 |
人声 |
3 |
正常结束-AI坐席挂断 |
6 |
呼出未接-坐席速挂 |
7 |
呼出未接-用户速挂 |
8 |
呼出未接-用户响铃拒接 |
9 |
呼出未接-超时未接 |
10 |
呼出未接-黑名单号码 |
11 |
呼出未接-呼叫限制号码 |
12 |
无法接通-无法接通 |
13 |
无法接通-呼叫拒绝 |
14 |
无法接通-暂时无法接通 |
15 |
无法接通-线路繁忙 |
16 |
无法接通-呼叫异常 |
17 |
正常结束-用户挂断 |
18 |
语音信箱 |
19 |
正常结束-早媒体语音信箱 |
20 |
静音 |
21 |
系统异常 |
响应示例
成功示例
{
"code": 0,
"message": "success",
"traceId": null,
"data": {
"total": 4,
"pageNumber": 1,
"pageSize": 10,
"list": [
{
"id": 125279,
"taskId": "972e65ad-bfa5-4f35-845f-1867009b2c34",
"contactId": "fde45ccd-9902-43a4-8e2e-ca4dba5a93e0",
"autoFlowId": 207,
"orderHead": 1,
"orderTail": 1,
"callerPhone": "00000",
"calleePhone": "852385xxxx",
"realPhone": "85xxxx",
"callId": "fe90a9af-e14c-4330-8faa-2631e761124a",
"callStatus": 10,
"callResult": 17,
"createTs": 1742378329,
"opTs": 1742378340,
"callStart": 1742378340,
"callAnswer": 1742378343,
"callEnd": 1742378480,
"callRingTime": 3,
"callElapsed": 137,
"lineId": "lineID",
"routeId": "routeID",
"callAudioUrl": "https://nxai-gz-1259196162.cos.ap-guangzhou.myqcloud.com/20250319/xxxxxx.wav",
"userIntent": "",
"callSummary": "",
"turnTime": 0,
"manualCallStart": 0,
"manualCallAnswer": 0,
"manualCallEnd": 0,
"manualCallStatus": 0,
"manualElapsed": 0,
"agentName": "",
"agentId": "",
"agentGroupName": "",
"agentGroupId": "",
"callCallbackUrl": "",
"orderCallbackUrl": "",
"sipAddr": "xxxxx",
"sipCode": "200",
"hangupReason": "NORMAL_CLEARING",
"attributes": [
{
"name": "Name",
"key": "sys.name",
"value": "haier"
},
{
"name": "Phone Number",
"key": "sys.phoneNumber",
"value": "85238531065"
}
],
"autoFlowName": "test-ai agent"
}
]
}
}
错误码
值 |
说明 |
1001 |
Authentication failed (missing public parameters) |
1002 |
Authentication failed (parameter error) |
1003 |
Authentication failed (invalid signature) |
1004 |
Authentication failed (timestamp expired) |
1005 |
Authentication failed (insufficient authority) |
20000 |
Business Error |