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

对已有任务追加号码名单

URL：https://api-hk.nxlink.ai/openapi/aiagent/call/append
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` 二选一至少传一个
countryCode	String	否	"86"	国码
callCallbackUrl	String	否	"https://example.com/webhook/call"	通话结束回调地址
list	Array	是		追加号码用户信息

list元素

参数名	类型	必选	示例值	说明
contactId	String	是	"52145b00-abc9-4a87-94c2-ed1e1e42x4rfvmh"	名单id(全局唯一)
other	String	否	"contact-ext-001"	名单透传字段，会在通话记录回调中原样返回
name	String	是	"Jones"	用户名称
phoneNumber	String	是	"86130XXXX"	用户号码
params	Array	否		变量信息

params元素

参数名	类型	必选	示例值	说明
name	String	是	"key1"	变量名称(必须和流程中已存在的变量名称一致)
value	object	否	"value1"	变量值

说明

callCallbackUrl 优先使用本次API请求传入的值；如果未传，则使用页面配置；如果页面也未配置，则不回调。
taskId 为服务系统内部任务id，userTaskId 为调用方任务id；如果同时传入两者，优先使用 userTaskId 定位任务。
taskId 和 userTaskId 二选一至少传一个。

请求示例

body参数：

{
    "userTaskId": "EXT-TASK-202603250001",
    "countryCode": "86",
    "callCallbackUrl": "https://example.com/webhook/call",
    "list": [
        {
            "contactId": "52145b00-abc9-4a87-94c2-ed1e1e42xki093",
            "other": "contact-ext-001",
            "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元素

参数名	类型	说明
contactId	String	导入失败的名单id，作为错误记录的唯一标识
name	String	用户名称
phoneNumber	String	导入失败的电话号码
errMsg	String	失败原因

响应示例

成功示例

{
    "code": 0,
    "message": null,
    "traceId": null,
    "data": {
        "errList": [
            {
                "contactId": "52145b00-abc9-4a87-94c2-ed1e1e42xki093",
                "name": "lucy",
                "phoneNumber": "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