AssignJobsAsync - 异步创建外呼任务

异步创建外呼任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:AssignJobsAsynccreate
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

12f3dd08-0c55-44ce-9b64-e69d35ed3a76
JobGroupIdstring

任务组 ID。

d004cfd2-6a81-491c-83c6-cbe186620c95
StrategyJsonstring

作业组执行策略

  • repeatBy

重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复);

  • startTime

策略开始时间。

  • endTime

策略结束时间。

  • workingTime

可外呼时间段。

  • maxAttemptsPerDay

每天该任务下号码最大可尝试呼叫次数。

  • minAttemptInterval

号码重试呼叫时间间隔,单位分钟。

  • routingStrategy

号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。

  • repeatDays

对应重复类型下的执行日期。若重复类型 RepeatBy 为周,0 表示周日,1-6 分别表示周一至周六;若重复周期 RepeatBy 为月,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行。

  • repeatable

是否开启循环任务,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"}
CallingNumberarray

主叫号码列表(给客户拨打电话时候的显示号码)。

说明 若不填,则默认全选
string

主叫号码。

4008013260
JobsJsonarray

作业数据,格式是一个 JSON 数组,具体格式参考示例值。

JobsJson.N 是个 List,每个 JobJson 对应一个联系人(contact)。

string

extras //额外信息,非必填

  • key //自定义变量名称 key

  • value //自定义变量内容 value

contacts // 必填字段,被叫人联系信息

  • phoneNumber // 必填字段,被叫人电话号码

  • referenceId // 必填字段,联系人 ID(用户自定义),主要是避免重名现象

  • role //非必填字段,该联系人在此外呼业务中的角色,不指定则不区分

  • honorific //非必填字段,联系人尊称

  • name //非必填字段,联系人姓名

{ "extras": [{ "value": "测试", "key": "测试" }, { "key": "ServiceId", "value": null }, { "key": "TenantId", "value": null }], "contacts": [{ "phoneNumber": "134*******", "name": "张三", "referenceId": "C01", "role": "客户1", "honorific": "老张" }] }

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
HttpStatusCodeinteger

HTTP 状态码。

200
Successboolean

是否成功。

true
Codestring

接口状态码。

OK
Messagestring

接口提示信息。

Success
AsyncTaskIdstring

异步任务 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"
}

错误码

访问错误中心查看更多错误码。