-
Notifications
You must be signed in to change notification settings - Fork 6
NXLINK AI callBack
henryou edited this page May 15, 2025
·
1 revision
通话记录回调
- URL:nxlink中在管理菜单中填写的ai agent通话记录回调地址
- 接口描述:接收通话记录的回调通知
- 请求方式:POST
- Content-Type:application/json
- 是否需要鉴权:可选(由客户自行决定)
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
accessKey | String | 否 | AK-6230339248928541113-2133 | 用户身份标识 |
ts | String | 否 | 1655710885431 | 请求时间戳(毫秒) |
bizType | String | 否 | 100 | 业务类型,固定值"100" |
action | String | 否 | nxai | 业务操作,固定值"nxai" |
sign | String | 否 | 6e9506557d1f289501d333ee2c365826 | API参数签名 |
Body参数
参数名 | 类型 | 说明 |
---|---|---|
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 |
sipAddr | String | 线路地址 |
sipCode | String | sip code |
hangupReason | String | 挂断原因 |
attributes | Array | 变量信息 |
autoFlowName | String | ai agent 名称 |
值 | 说明 |
---|---|
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 | 线路服务不可用 |
值 | 说明 |
---|---|
1 | 正常结束-已沟通 |
2 | 人声 |
3 | 正常结束-AI坐席挂断 |
6 | 呼出未接-坐席速挂 |
7 | 呼出未接-用户速挂 |
8 | 呼出未接-用户响铃拒接 |
9 | 呼出未接-超时未接 |
10 | 呼出未接-黑名单号码 |
11 | 呼出未接-呼叫限制号码 |
12 | 无法接通-无法接通 |
13 | 无法接通-呼叫拒绝 |
14 | 无法接通-暂时无法接通 |
15 | 无法接通-线路繁忙 |
16 | 无法接通-呼叫异常 |
17 | 正常结束-用户挂断 |
18 | 语音信箱 |
19 | 正常结束-早媒体语音信箱 |
20 | 静音 |
21 | 系统异常 |
{
"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": "",
"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"
}
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
code | int | 是 | 返回业务码 | 0:成功 |
data | object | 否 | 业务数据 |
{
"code": 0,
"data": "",
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席状态信息查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 异步创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
- 封锁用户
- 业务主页
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent