Skip to content

NXCC API createAutoCallTask

henryou edited this page Mar 5, 2024 · 1 revision

新建AI外呼任务并添加号码

  • URL:https://api2.nxcloud.com/saas/cc/openapi/ai/createandcall
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:

鉴权机制

鉴权规则请参考地址:API 接口调用约定

请求参数

header 参数:

参数名 类型 必选 示例值 说明
accessKey String fme2na3kdi3ki 用户身份标识
ts String 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为 60 秒
bizType String 6 业务类型,取固定值“8”
action String cc 业务操作,取固定值“cc”
sign String 6e9506557d1f289501d333ee2c365826 API 入参参数签名,签名算法

body 参数:

参数名 类型 必选 示例值 说明
country String "CN" 国家二字码
taskName String "任务名称" 任务名称
taskDesc String "任务描述" 任务描述
strategyName String "默认策略" 拨打策略名称,例如:"拨一重一", "默认策略"
dispatchType Integer 0 外呼类型 0:none,2 预测试外呼,1:比例式外呼
agentGroupNo String "NXXXXXXXG0000001" 坐席组编号
predictCallRate Double 1.0 呼叫倍率 小数点后两位
ratioCallRate Double 1.0 坐席呼叫倍率 小数点后一位
startCount Integer 1 算法启动值
callList Array of CallListItem [] 用户手机号码
startupType Integer 0 任务启动方式,0:none,1:手动启动,2:定时启动,3:立即开启

CallListItem参数:

参数名 类型 必选 示例值 说明
orderID String "FFDD1791E22F4D9DBA967C245C58E544" 唯一ID,默认UUID
userPhone String "86156xxxxxxxx" 号码
other String "ebd0788c-a592-49a6-a0e8-3205e0492f54" 客户透传字段

请求示例

body(application/json) 参数:

{
    "taskDesc": "描述",
    "callList": [
        {
            "userPhone": "85235757581",
            "other": "OTHER",
            "orderID": "ORDER_ID"
        }
    ],
    "country": "HK",
    "dispatchType": 0,
    "predictCallRate": 1.0,
    "agentGroupNo": "NX09445G000025",
    "taskName": "任务名称",
    "strategyName": "默认策略",
    "startCount": 1,
    "ratioCallRate": 1.0,
    "startupType": 3
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
msg String 请求结果说明

响应示例

成功示例

{
  "reqId": "9834904964284198A05BE414383621E8",
  "code": 0,
  "msg": "请求成功",
  "data": null
}

失败示例

{
    "reqId": "78db27d91ebd46e1e52135e2239b03bc",
    "code": 41000,
    "msg": "参数错误或为空",
    "data": {}
}

响应码说明

code message 解决办法
0 请求成功
88 请求失败 请联系技术人员排除问题
99 系统错误 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看 API 鉴权部分

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally