Skip to content

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
  • 需要鉴权:

请求参数

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
countryCode String "86" 国码
list Array 追加号码用户信息

list元素

参数名 类型 必选 示例值 说明
contactId String "52145b00-abc9-4a87-94c2-ed1e1e42x4rfvmh" 名单id(全局唯一)
name String "Jones" 用户名称
phoneNumber String "86130XXXX" 用户号码
params Array 变量信息

params元素

参数名 类型 必选 示例值 说明
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

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally