修改智能外呼任务组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:ModifyJobGroup |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
174952ab-9825-4cc9-a5e2-de82d7fa4cdd |
| JobGroupId |
string |
是 |
任务 ID。 |
3edc0260-6f7c-4de4-8535-09372240618b |
| Name |
string |
是 |
任务名字。 |
修改后的作业组 |
| ScenarioId |
string |
否 |
场景 ID。(历史参数,后续使用 ScriptId) 说明
当前参数已为历史参数,可传任意值,建议与 scriptid 保持一致 |
c6a668d1-3145-4048-9101-cb3678bb8884 |
| Description |
string |
否 |
任务描述。 |
修改后的作业组 |
| 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":false,"inArrearsIgnore":false,"outOfServiceIgnore":false} |
| ScriptId |
string |
否 |
场景话术 ID。 |
5a3940ce-a12f-4222-9f0f-605a9b89ea7c |
| CallingNumber |
array |
否 |
主叫号码。 |
|
|
string |
否 |
主叫号码。 |
4008013260 |
|
| JobGroupStatus |
string |
是 |
任务状态,取值范围:
|
Draft |
| RingingDuration |
integer |
否 |
最优振铃时长。 |
25 |
| MinConcurrency |
integer |
是 |
并发保障值 任务启动时,最低保障 N 个并发; 同一优先级的任务并发保障值加和不能大于实例并发; 若配置并发保障值为 0,则依赖系统内空闲并发进行智能分配。 |
1 |
| Priority |
string |
否 |
作业组优先级,取值范围
|
Daily |
| FlashSmsExtras |
string |
否 |
闪信推送的配置参数,JSON 格式,包含第三方闪信的配置信息。 templateId:闪信模板 ID。 |
{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"} |
| RecallCallingNumber |
array |
否 |
重呼主叫号码列表 |
|
|
string |
否 |
重呼主叫号码 |
4008013260 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Code |
string |
接口状态码。 |
OK |
| Message |
string |
接口提示消息。 |
Success |
| RequestId |
string |
请求 ID。 |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
是否成功。 |
true |
| JobGroup |
object |
任务信息。 |
|
| Status |
string |
状态。 |
Scheduling |
| ScenarioId |
string |
场景 ID。 说明
该参数返回的为历史参数,具体 ScrpitID 可通过 DescribeJobGroup 接口返回 |
6cea9bed-63e6-439e-ae4c-b3333efff53d |
| JobGroupId |
string |
任务 ID。 |
c62e6789-28a8-41db-941e-171a01d3b3b9 |
| CreationTime |
integer |
创建时间 说明
可通过 DescribeJobGroup 接口返回 |
1578550074361 |
| JobGroupName |
string |
任务名字。 |
第一个催收 |
| JobFilePath |
string |
任务文件 OSS 存储路径。【已废弃】 |
UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx |
| JobGroupDescription |
string |
任务描述。 |
催收的作业组 |
| JobDataParsingTaskId |
string |
解析外呼任务文件对应的解析任务 ID。【已废弃】 |
e37d28cb-0413-4816-85ed-fd354d025ea3 |
| ScriptName |
string |
话术名称。 |
话术 |
| ScriptVersion |
string |
话术版本。 |
1628425608429 |
| ModifyTime |
string |
修改时间。 说明
可通过 DescribeJobGroup 接口返回 |
1628425608429 |
| CallingNumbers |
array |
主叫号码列表。 |
|
|
string |
主叫号码列表。 |
["4008013260"] |
|
| ExportProgress |
object |
导出信息(历史参数,不再使用)。 |
|
| Status |
string |
状态 |
FINISHED |
| FileHttpUrl |
string |
文件地址 |
https://***.oss-cn-shanghai.aliyuncs.com/sample |
| Progress |
string |
进度 |
1 |
| Strategy |
object |
外呼策略。 |
|
| Type |
string |
策略类型。 |
Repeatable |
| StrategyName |
string |
策略名称。 |
催收策略 |
| MaxAttemptsPerDay |
integer |
最大尝试次数。 |
3 |
| FollowUpStrategy |
string |
执行周期结束后的处理方式(历史参数,不再使用)。 |
CONTINUE |
| EndTime |
integer |
结束时间。 |
2209702074000 |
| Customized |
string |
自定义策略数据(历史参数,不再使用)。 |
{} |
| IsTemplate |
boolean |
是否是模板(历史参数,不再使用)。 |
false |
| StartTime |
integer |
开始时间。 |
1578550074000 |
| StrategyId |
string |
策略 ID。 |
f718798d-96be-40e4-bef6-317b54855708 |
| RoutingStrategy |
string |
号码路由策略。 |
LocalFirst |
| MinAttemptInterval |
integer |
失败后重复拨打的间隔时间。 |
10 |
| StrategyDescription |
string |
策略描述。 |
催收作业执行策略 |
| RepeatBy |
string |
重复执行方式,Once 不重复,Day 每天重复,Week 每周重复,Month 每月重复。 |
Once |
| WorkingTime |
array<object> |
允许外呼的时间段。 |
|
|
object |
工作时间段。 |
||
| EndTime |
string |
结束时间。 |
12:00:00 |
| BeginTime |
string |
开始时间。 |
09:00:00 |
| RepeatDays |
array |
重复的执行天。 若重复周期 RepeatBy 为周,0 表示周日,1-6 分别表示周一至周六 若重复周期 RepeatBy 为月,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行 |
|
|
string |
重复执行的天。 |
[1,2,3,4,5] |
|
| RecallStrategy |
object |
重呼策略 |
|
| EmptyNumberIgnore |
boolean |
空号不再外呼。 |
false |
| InArrearsIgnore |
boolean |
欠费不再外呼。 |
false |
| OutOfServiceIgnore |
boolean |
停机不再外呼。 |
false |
| RingingDuration |
integer |
振铃时长。 |
25 |
| Priority |
string |
作业组优先级,取值范围 Urgent:紧急任务。 Daily:日常任务。 |
Daily |
| MinConcurrency |
integer |
并发保障值 任务启动时,最低保障 N 个并发; 同一优先级的任务并发保障值加和不能大于实例并发; 若配置并发保障值为 0,则依赖系统内空闲并发进行智能分配。 |
1 |
| FlashSmsExtras |
string |
闪信推送的配置参数,JSON 格式,包含第三方闪信的配置信息。 templateId: 闪信模板 ID。 configId: 闪信配置 ID。 |
{"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"} |
示例
正常返回示例
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/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx",
"JobGroupDescription": "催收的作业组",
"JobDataParsingTaskId": "e37d28cb-0413-4816-85ed-fd354d025ea3",
"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": "f718798d-96be-40e4-bef6-317b54855708",
"RoutingStrategy": "LocalFirst",
"MinAttemptInterval": 10,
"StrategyDescription": "催收作业执行策略",
"RepeatBy": "Once",
"WorkingTime": [
{
"EndTime": "12:00:00",
"BeginTime": "09:00:00"
}
],
"RepeatDays": [
"[1,2,3,4,5]"
]
},
"RecallStrategy": {
"EmptyNumberIgnore": false,
"InArrearsIgnore": false,
"OutOfServiceIgnore": false
},
"RingingDuration": 25,
"Priority": "Daily",
"MinConcurrency": 1,
"FlashSmsExtras": "{\"configId\":\"3157b3c8-3a3e-4ea9-894b-9c8a6\", \"templateId\":\"1234\"}"
}
}
错误码
|
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. | 指定的实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。