异步创建外呼任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:AssignJobsAsync |
create |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
12f3dd08-0c55-44ce-9b64-e69d35ed3a76 |
| JobGroupId |
string |
是 |
任务组 ID。 |
d004cfd2-6a81-491c-83c6-cbe186620c95 |
| StrategyJson |
string |
否 |
作业组执行策略
重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复);
策略开始时间。
策略结束时间。
可外呼时间段。
每天该任务下号码最大可尝试呼叫次数。
号码重试呼叫时间间隔,单位分钟。
号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。
对应重复类型下的执行日期。若重复类型 RepeatBy 为周,0 表示周日,1-6 分别表示周一至周六;若重复周期 RepeatBy 为月,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行。
是否开启循环任务,true/false |
{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"} |
| CallingNumber |
array |
否 |
主叫号码列表(给客户拨打电话时候的显示号码)。 说明
若不填,则默认全选 |
|
|
string |
否 |
主叫号码。 |
4008013260 |
|
| JobsJson |
array |
否 |
作业数据,格式是一个 JSON 数组,具体格式参考示例值。 JobsJson.N 是个 List,每个 JobJson 对应一个联系人(contact)。 |
|
|
string |
否 |
extras //额外信息,非必填
contacts // 必填字段,被叫人联系信息
|
{ "extras": [{ "value": "测试", "key": "测试" }, { "key": "ServiceId", "value": null }, { "key": "TenantId", "value": null }], "contacts": [{ "phoneNumber": "134*******", "name": "张三", "referenceId": "C01", "role": "客户1", "honorific": "老张" }] } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息。 |
||
| RequestId |
string |
请求 ID。 |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Success |
boolean |
是否成功。 |
true |
| Code |
string |
接口状态码。 |
OK |
| Message |
string |
接口提示信息。 |
Success |
| AsyncTaskId |
string |
异步任务 ID。 |
12f3dd08-0c55-44ce-9b64-e69d35ed3a76 |
示例
正常返回示例
JSON格式
{
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"HttpStatusCode": 200,
"Success": true,
"Code": "OK",
"Message": "Success",
"AsyncTaskId": "12f3dd08-0c55-44ce-9b64-e69d35ed3a76"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。