追加外呼案件
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:AppendCases |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID |
361c8a53-0e29-42f3-8aa7-c7752d010399 |
| CampaignId |
string |
是 |
外呼任务 ID。 |
40ea7fc2-c9d4-47e3-af1e-216bf7f79a44 |
| Cases |
array<object> |
是 |
联系人列表。 |
|
|
object |
否 |
case 数据 |
||
| ReferenceId |
string |
否 |
联系人业务系统 ID。 |
business3-watermark-2704-1776997551 |
| PhoneNumber |
string |
否 |
联系人号码。 |
1331234**** |
| CustomVariables |
string |
否 |
客户自定义变量,格式为 JSON 对象,对象最多包含 10 个属性,每个属性的名称和值均由客户自定义。 |
["key1":"value1"] |
| Priority |
integer |
否 |
优先级。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Code |
string |
响应码 |
OK |
| Message |
string |
接口提示信息 |
Success |
| RequestId |
string |
请求 ID |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
是否成功 |
true |
| Params |
array |
错误信息中的变量值 |
|
|
string |
错误信息中的变量值 |
fc21ccd7-6f0a-4261-ac63-d079bfe3bc2e |
|
| Data |
array<object> |
添加失败联系人列表 |
|
|
object |
添加失败联系人 |
||
| PhoneNumber |
string |
号码 |
133xxxxxxxx |
| ReferenceId |
string |
业务 ID |
bizId-xxxxxx |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"Params": [
"fc21ccd7-6f0a-4261-ac63-d079bfe3bc2e"
],
"Data": [
{
"PhoneNumber": "133xxxxxxxx",
"ReferenceId": "bizId-xxxxxx"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。