批量创建外呼任务

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String AssignJobs

系统规定参数。取值:AssignJobs。

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

实例id

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

批量创建作业归属的作业组id,如不传这个参数,系统自动将新建的作业归属到一个新生成的作业组

StrategyJson String {"maxAttemptsPerDay":1,"name":"策略名字","startTime":1631503815256,"workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"14:00:00","endTime":"16:00:00"}],"endTime":1631521815256,"minAttemptInterval":1}

作业组执行策略

name:策略名称

maxAttemptsPerDay:号码每天最大呼叫次数

minAttemptInterval:未接通情况下的重试时间间隔,单位为分钟

startTime:开始时间戳

endTime:结束时间戳

workingTime:可呼出的时间窗口,24小时制

Strategy优先级为: AssignJobs > CreateJobGroup.

CallingNumber.N RepeatList ["95187"]

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

JobsJson.N RepeatList [{"extras":[{"value":"2019-08-21 09:49:59.0","key":"businessParamOne"},{"value":"办理事件","key":"businessParamTwo"}],"contacts":[{"phonenumber":"1851*******,"name":"张三","referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed","honorific":"张先生"}]}]

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

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

RosterType String json

名单类型。

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

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

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

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

IsAsynchrony Boolean false

是否异步。

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

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码

HttpStatusCode Integer 200

http状态码

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

作业组id

JobsId List ["12f3dd08-0c55-44ce-9b64-e69d35ed3a76"]

任务ID列表

Message String Success

接口提示信息

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

请求id

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=AssignJobs
&InstanceId=12f3dd08-0c55-44ce-9b64-e69d35ed3a76
&JobGroupId=d004cfd2-6a81-491c-83c6-cbe186620c95
&<公共请求参数>

正常返回示例

XML格式

<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<JobGroupId>390515b5-6115-4ccf-83e2-52d5bfaf2ddf</JobGroupId>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>

JSON格式

{
    "RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "JobGroupId":"390515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "HttpStatusCode":200,
    "Code":"OK",
    "Success":true
}

错误码

HttpCode 错误码 错误信息 描述
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. 指定的实例不存在。

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