AssignJobs - 批量创建外呼任务

更新时间:
复制为 MD 格式

批量创建外呼任务。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:AssignJobs

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

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

JobGroupId

string

任务组 ID。

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

StrategyJson

string

作业组执行策略

  • 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"}

RosterType

string

名单类型。

接口对接方式下发外呼任务默认 JSON,可不填。 通过名单上传,填入 excel。

json

JobDataParsingTaskId

string

解析外呼任务数据的任务 ID。

接口对接方式下发外呼任务可不填。

说明

若使用文件上传的形式,则需要调用 CreateJobDataParsingTask 来获取对应参数值,

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

IsAsynchrony

boolean

是否异步。

接口对接方式下发外呼任务可不填,默认为 false。

false

CallingNumber

array

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

说明

若不填,则默认全选

string

主叫号码。

4008013260

JobsJson

array

重要 此参数为必填。

作业数据,格式是一个 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

返回信息。

HttpStatusCode

integer

HTTP 状态码。

200

JobGroupId

string

任务组 ID。

390515b5-6115-4ccf-83e2-52d5bfaf2ddf

RequestId

string

请求 ID。

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

Success

boolean

是否成功。

true

Code

string

接口状态码。

OK

Message

string

接口提示信息。

Success

JobsId

array

作业 ID 列表。

string

作业 ID。

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

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "JobGroupId": "390515b5-6115-4ccf-83e2-52d5bfaf2ddf",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "JobsId": [
    "12f3dd08-0c55-44ce-9b64-e69d35ed3a76"
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试,如果多次重试报错请提交工单。
404 NotExist.Instance The specified Instance does not exist. 指定的实例不存在。

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

变更历史

更多信息,参考变更详情