-
Notifications
You must be signed in to change notification settings - Fork 5
NXLINK AI taskCallback
曾日强 edited this page May 26, 2026
·
3 revisions
任务状态回调
- URL:优先回调到API创建任务时传入的
taskCallbackUrl;如果未传,则回调到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 |
| userTaskId | String | 用户自定义任务id |
| other | String | 创建任务时传入的任务透传字段 |
| autoFlowId | Long | 机器人id |
| autoFlowName | String | 机器人名称 |
| taskName | String | 任务名称 |
| taskDesc | String | 任务描述 |
| taskStatus | Integer | 任务状态,详见下方枚举说明 |
| pauseReason | Integer | 暂停原因,非暂停状态可能为空 |
| taskKeep | Integer | 任务是否保活,0:不保活,1:保活 |
| startupType | Integer | 启动方式,1:手动启动,2:定时启动,3:立即启动 |
| startupAt | Long | 定时启动时间戳(秒),startupType=2 时有值 |
| shutdownAt | Long | 定时停止时间戳(秒),startupType=2 时有值 |
| routeId | String | 任务选择的路由 |
| createTs | Long | 任务创建秒级时间戳 |
| statInfo | Object | 任务统计信息快照 |
| 参数名 | 类型 | 说明 |
|---|---|---|
| answerOrderCount | Integer | 接通订单数,订单结束时统计 |
| finishOrderCount | Integer | 完成订单数,订单结束时统计 |
| totalOrderCount | Integer | 总订单数,导入时统计 |
| dialedOrderCount | Integer | 已拨打订单数,一个订单打完第一通电话时统计 |
| totalCallElapsed | Integer | 通话总时长,单位秒 |
| answerCallCount | Integer | 接通通话数,通话结束时统计 |
| totalCallCount | Integer | 总通话数,通话结束时统计 |
| manualElapsed | Integer | 转人工通话总时长,单位秒 |
| manualAnswerCount | Integer | 转人工接听通话数量 |
| manualFailCount | Integer | 转人工失败通话数量 |
| createTs | Long | 统计信息创建秒级时间戳 |
| answerRate | String | 接通率 |
| dialProgress | String | 外呼进度 |
| finishRate | String | 完成率 |
| manualAnswerRate | String | 人工转接成功率 |
| avgCallDuration | Integer | 平均通话时长(秒) |
| avgManualDuration | Integer | 平均人工通话时长(秒) |
| 值 | 说明 |
|---|---|
| 1 | 准备就绪 |
| 2 | 进行中 |
| 3 | 已完成 |
| 4 | 失败 |
| 5 | 已暂停 |
| 6 | 余额不足暂停 |
-
taskStatus与查询任务列表接口中的任务状态取值保持一致。 -
statInfo为回调触发时刻的任务统计快照。 - 如果客户开启了签名校验,可按标准 AI Agent OpenAPI 的 header 规则校验本回调请求。
{
"taskId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c",
"userTaskId": "EXT-TASK-202603250001",
"other": "task-batch-20260325",
"autoFlowId": 197,
"autoFlowName": "快速通知",
"taskName": "客户回访任务-0325",
"taskDesc": "针对已下单客户进行满意度回访",
"taskStatus": 2,
"pauseReason": null,
"taskKeep": 0,
"startupType": 2,
"startupAt": 1746583929,
"shutdownAt": 1746670329,
"routeId": "y29ND1X4kkCG_nC576sALEkvg3HjEqde",
"createTs": 1746583800,
"statInfo": {
"answerOrderCount": 120,
"finishOrderCount": 150,
"totalOrderCount": 200,
"dialedOrderCount": 180,
"totalCallElapsed": 5320,
"answerCallCount": 130,
"totalCallCount": 210,
"manualElapsed": 300,
"manualAnswerCount": 5,
"manualFailCount": 1,
"createTs": 1746583800,
"answerRate": "61.90%",
"dialProgress": "90.00%",
"finishRate": "75.00%",
"manualAnswerRate": "83.33%",
"avgCallDuration": 40,
"avgManualDuration": 60
}
}| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| code | int | 是 | 0 | 返回业务码,0 表示成功 |
| data | object | 否 | "" | 业务数据 |
{
"code": 0,
"data": ""
}| 值 | 说明 |
|---|---|
| 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 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
- 二维码管理
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使用说明
NXLINK(HKG)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(IDN)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(CHL)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
AI Agent
RCS