NXLINK AI deleteOrder - nxtele/http-api-document GitHub Wiki
在任务中删除号码名单
- URL：
https://api-hk.nxlink.ai/openapi/aiagent/order/delete - Method：
POST - Content-Type：
application/json - 需要鉴权：
是
🌐 服务接入点
NXLink 在全球部署了多个服务区域，请根据您的业务所在地选择对应的服务接入点。不同区域的网站域名和API网关域名不同。
| 代号 | 区域 | NXLink网站 | API网关 |
|---|---|---|---|
| APAC | 香港 | https://app.nxlink.ai |
https://api-hk.nxlink.ai |
| AMER | 美洲 | https://chl-nxlink.nxcloud.com |
https://chl-api.nxlink.ai |
| APAC(IDN) | 印尼 | https://idn.nxlink.ai |
https://api-idn.nxlink.ai |
请求参数
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，服务系统内部任务id；与 userTaskId 二选一至少传一个；同时传时优先使用 userTaskId |
| userTaskId | String | 否 | "EXT-TASK-202603250001" | 调用方任务id；建议优先传入；与 taskId 二选一至少传一个 |
| contactId | String | 是 | "52145b00-abc9-4a87-94c2-56hu4rfo" | 名单id |
注意：只能删除待开始类型的通话。
说明
taskId为服务系统内部任务id，userTaskId为调用方任务id；如果同时传入两者，优先使用userTaskId定位任务。taskId和userTaskId二选一至少传一个。
请求示例
body（application/json） 参数：
{
"userTaskId": "EXT-TASK-202603250001",
"contactId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c"
}
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 结果编码 |
| message | String | 请求结果说明 |
| traceId | String | 链路追踪ID |
| data | Array | 响应数据，返回UUID数组 |
data元素
| 参数名 | 类型 | 说明 |
|---|---|---|
| -- | Integer | callId |
响应示例
成功示例
{
"code": 0,
"message": "success",
"traceId": "e84a7ee05c7248029828e59ddf725d75",
"data": null
}
错误码
| 值 | 说明 |
|---|---|
| 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 |