外呼任务添加号码
给创建的外呼任务添加外呼号码
请求地址
https://{baseURL}/api/v1/aicall/set-number?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
请求方式:
POST
请求参数:
属性 | 类型 | 约束 | 描述 | 举例说明 |
---|---|---|---|---|
task_id | string | 必填 | 任务id | 机器人ID |
vars | array | 必填 | 字符串数组,基于JSON格式表示。 | vars中参数依据任务定义的变量而定,phone为必填项。[“{"name":"xx","phone":"13012345678", "userdata":"123456\ “,"sex":"","addre ss":"xxxxxxxx"}”] |
vars.phone | string | 必填 | 手机号 | 长度为11位的手机号码 |
vars.name | string | 选填 | 姓名 | 长度(32) |
vars.userdata | string | 选填 | 透传字段 | 123456 |
vars.sex | string | 选填 | 性别 | 先生/女士 |
vars.address | string | 选填 | 地址 | xx省xx市xx县xx |
vars.…… | string | 选填 | ||
count | int | 必填 | 号码数量 | 1 |
请求示例
POST /api/v1/aicall/set-number?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
{
"task_id": "15260201958387204985",
"vars": [
"{\"name\":\"xx\",\"phone\":\"13012345678\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"xx\",\"phone\":\"13012345679\",\"userdata\":\"123123\",\"email\":\"email2@mail.com\",\"address\":\" xx省xx市xx县xx\"}"
],
"count": 2
}
Body 请求参数示例:
{
"task_id": "2024052400003",
"vars": [
"{\"name\":\"sd\",\"phone\":\"13201859631\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859632\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859633\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859634\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859635\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859636\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859637\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}",
"{\"name\":\"sd\",\"phone\":\"13201859638\",\"userdata\":\"123456\",\"email\":\"email@mail.com\",\"address\":\"x x省xx市xx县xx\"}"
],
"count": 8
}
响应包体:
属性 | 类型 | 说明 |
---|---|---|
code | integer | 请求状态码,此时为0 |
msg | string | 请求状态码描述,此时为空 |
data | object | 结果集 |
data.total | int | 送号总数 |
data.successNums | int | 送号成功数 |
data.jsonInvalidNums | int | json格式错误,无法解析的个数 |
data.variableError | array | 变量异常的号码。变量异常:号码为空、号码 格式异常、变量缺失、变量 不合法。 |
data.repeatInfo | map | 符合条件的号码中,重复号 码的信息<号码,重复次数> |
data.blackNumber | array | 过滤黑名单号码 |
data.overNumber | array | 超出上线号码 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"total": 0,
"successNums": 1,
"jsonInvalidNums": 0,
"variableError": null,
"blackNumber": null,
"overNumber": null,
"repeatInfo": {
"18409166300": 1
}
}
}
文档更新时间: 2024-06-05 13:34 作者:admin