-
Notifications
You must be signed in to change notification settings - Fork 6
NXLINK AI callAppend
henryou edited this page May 15, 2025
·
1 revision
对已有任务追加号码名单
- URL:
https://api-westus.nxlink.ai/openapi/aiagent/call/append
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
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 |
countryCode | String | 否 | "86" | 国码 |
list | Array | 是 | 追加号码用户信息 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
contactId | String | 是 | "52145b00-abc9-4a87-94c2-ed1e1e42x4rfvmh" | 名单id(全局唯一) |
name | String | 是 | "Jones" | 用户名称 |
phoneNumber | String | 是 | "86130XXXX" | 用户号码 |
params | Array | 否 | 变量信息 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
name | String | 是 | "key1" | 变量名称(必须和流程中已存在的变量名称一致) |
value | object | 否 | "value1" | 变量值 |
body参数:
{
"taskId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c",
"countryCode": "86",
"list": [
{
"contactId": "52145b00-abc9-4a87-94c2-ed1e1e42xki093",
"name": "name1",
"phoneNumber": "86130XXXXX",
"params": [
{
"name": "key1",
"value": "value1"
}
]
}
]
}
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 结果编码 |
message | String | 请求结果说明 |
traceId | String | 链路追踪ID |
data | Object | 响应数据主体 |
data对象
参数名 | 类型 | 说明 |
---|---|---|
errList | Array | 错误列表,包含导入失败的记录信息 |
successCount | Integer | 成功导入的记录数量 |
totalCount | Integer | 总共处理的记录数量 |
errList元素
参数名 | 类型 | 说明 |
---|---|---|
phoneNumber | String | 导入失败的电话号码 |
reason | String | 失败原因 |
{
"code": 0,
"message": null,
"traceId": null,
"data": {
"errList": [
{
"userName": "lucy",
"userPhone": "1312895-xxx",
"errMsg": "Illegal phone number format:1312895-xxx"
}
],
"successCount": 1,
"totalCount": 2
}
}
{
"code": 20000,
"message": "Duplicate contactIds are not allowed: 52145b00-abc9-4a87-94c2-ed1e1e42xki0931",
"traceId": "dbdd93a9-cb7c-4c0d-8f98-01755b1883b6"
}
错误码
值 | 说明 |
---|---|
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号码绑定
通用
号码检测
- 发送消息
- 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