NXLINK AI callBack - nxtele/http-api-document GitHub Wiki

通话记录回调

  • URL：优先回调到API创建任务或追加名单时传入的 callCallbackUrl；如果未传，则回调到nxlink管理菜单中配置的ai agent通话记录回调地址；如果页面也未配置，则不回调
  • 接口描述：接收通话记录的回调通知
  • 请求方式：POST
  • Content-Type：application/json
  • 是否需要鉴权：可选（由客户自行决定）

请求参数

header参数（可选）：

参数名 类型 必选 示例值 说明
accessKey String 否 AK-6230339248928541113-2133 用户身份标识
ts String 否 1655710885431 请求时间戳（毫秒）
bizType String 否 100 业务类型，固定值"100"
action String 否 nxai 业务操作，固定值"nxai"
sign String 否 6e9506557d1f289501d333ee2c365826 API参数签名

请求参数：

Body参数

参数名 类型 说明
taskId String 任务id，服务系统内部任务id
userTaskId String 调用方任务id
contactId String 名单id
other String 创建任务或追加名单时传入的名单透传字段
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. taskId 为服务系统内部任务id，userTaskId 为调用方任务id。

通话状态(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 系统异常

请求body示例

body示例

          {
                "taskId": "972e65ad-bfa5-4f35-845f-1867009b2c34",
                "userTaskId": "EXT-TASK-202603250001",
                "contactId": "fde45ccd-9902-43a4-8e2e-ca4dba5a93e0",
                "other": "contact-ext-001",
                "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"
            }

返回body参数：

参数名 类型 必选 示例值 说明
code int 是 返回业务码 0:成功
data object 否 业务数据

返回参数实例

body示例


{
    "code": 0,
    "data": "",
}