创建作业组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID | 174952ab-9825-4cc9-a5e2-de82d7fa4cdd |
JobGroupName | string | 是 | 任务名字。 | 第一个任务 |
JobGroupDescription | string | 否 | 任务描述。 | 任务描述 |
ScenarioId | string | 否 | 业务场景。旧版画布参数,公共云客户场景使用 ScriptId 即可。 | b9ff4e88-65f9-4eb3-987c-11ba51f3f24d |
ScriptId | string | 否 | 话术场景 ID。该参数不能和 ScenarioId 同时为空。 | b9ff4e88-65f9-4eb3-987c-11ba51f3f24d |
StrategyJson | string | 否 | 任务执行策略。
| {"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"} |
RecallStrategyJson | string | 否 | 重拨策略,JSON 格式。
| {"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true} |
CallingNumber | array | 否 | 主叫号码列表。 | |
string | 否 | 主叫号码。 | ["4008013260"] | |
RingingDuration | long | 否 | 最优振铃时长。 | 25 |
Priority | string | 否 | 作业组优先级,取值范围如下
| Daily |
MinConcurrency | long | 否 | 并发保障值。
| 1 |
FlashSmsExtras | string | 否 | 闪信推送的配置参数,JSON 格式,包含第三方闪信的配置信息。
| {"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"} |
RecallCallingNumber | array | 否 | ||
string | 否 | 重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。 | ["4008013260"] |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"JobGroup": {
"Status": "Scheduling",
"ScenarioId": "6cea9bed-63e6-439e-ae4c-b3333efff53d",
"JobGroupId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
"CreationTime": 1578550074361,
"JobGroupName": "第一个作业组",
"JobFilePath": "UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx",
"JobGroupDescription": "第一个的作业组",
"JobDataParsingTaskId": "744ff448-2b4c-40d4-94ca-51f246905b0f",
"ScriptName": "话术",
"ScriptVersion": "1628425608429",
"ModifyTime": "1628425608429",
"CallingNumbers": [
"[\"4008013260\"]"
],
"ExportProgress": {
"Status": "FINISHED",
"FileHttpUrl": "https://***.oss-cn-shanghai.aliyuncs.com/sample",
"Progress": "1"
},
"Strategy": {
"Type": "Repeatable",
"StrategyName": "催收策略",
"MaxAttemptsPerDay": 3,
"FollowUpStrategy": "CONTINUE",
"EndTime": 2209702074000,
"Customized": "{}",
"IsTemplate": false,
"StartTime": 1578550074000,
"StrategyId": "cc9a436e-03b0-4ada-8364-77ec2290aa39",
"RoutingStrategy": "LocalFirst",
"MinAttemptInterval": 3,
"StrategyDescription": "催收策略",
"RepeatBy": "Once",
"WorkingTime": [
{
"EndTime": "12:00:00",
"BeginTime": "09:00:00"
}
],
"RepeatDays": [
"[1,2,3,4,5]"
]
},
"RecallStrategy": {
"EmptyNumberIgnore": true,
"InArrearsIgnore": true,
"OutOfServiceIgnore": true
},
"RingingDuration": 30,
"Priority": "Daily",
"MinConcurrency": 1,
"RecallCallingNumbers": [
"[\"4008013260\"]"
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |