批量创建外呼任务。
调试
您可以在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。 |
RosterType | String | 否 | json | 名单类型。 接口对接方式下发外呼任务默认json,可不填。 |
JobDataParsingTaskId | String | 否 | d004cfd2-6a81-491c-83c6-cbe186620c95 | 解析外呼任务数据的任务ID。 接口对接方式下发外呼任务可不填。 |
IsAsynchrony | Boolean | 否 | false | 是否异步。 接口对接方式下发外呼任务可不填,默认为false。 |
CallingNumber.N | String | 否 | 4008013260 | 主叫号码。 |
JobsJson.N | String | 否 | { "extras":[ { "value":"2019-08-21 09:49:59.0", "key":"businessParamOne" }, { "value":"办理事件", "key":"businessParamTwo" } ], "contacts":[ { "phoneNumber":"1851*******", "name":"张三", "referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed", "honorific":"张先生" } ] } | 被叫联系人信息 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码。 |
JobGroupId | String | 390515b5-6115-4ccf-83e2-52d5bfaf2ddf | 作业组ID。 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求ID。 |
Success | Boolean | true | 是否成功。 |
Code | String | OK | 接口状态码。 |
Message | String | Success | 接口提示信息。 |
JobsId | Array of String | 12f3dd08-0c55-44ce-9b64-e69d35ed3a76 | 作业ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=AssignJobs
&InstanceId=12f3dd08-0c55-44ce-9b64-e69d35ed3a76
&JobGroupId=d004cfd2-6a81-491c-83c6-cbe186620c95
&StrategyJson={"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}
&RosterType=json
&JobDataParsingTaskId=d004cfd2-6a81-491c-83c6-cbe186620c95
&IsAsynchrony=false
&CallingNumber=["4008013260"]
&JobsJson=["{ \"extras\":[ { \"value\":\"2019-08-21 09:49:59.0\", \"key\":\"businessParamOne\" }, { \"value\":\"办理事件\", \"key\":\"businessParamTwo\" } ], \"contacts\":[ { \"phoneNumber\":\"1851*******\", \"name\":\"张三\", \"referenceId\":\"2c9a9a7c6caedab6016cb1ddd13325ed\", \"honorific\":\"张先生\" } ] }"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AssignJobsResponse>
<HttpStatusCode>200</HttpStatusCode>
<JobGroupId>390515b5-6115-4ccf-83e2-52d5bfaf2ddf</JobGroupId>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Code>OK</Code>
<Message>Success</Message>
<JobsId>12f3dd08-0c55-44ce-9b64-e69d35ed3a76</JobsId>
</AssignJobsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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" ]
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?