修改作业组信息,仅草稿、挂起状态下,才支持调用该接口,其他状态不允许修改作业组信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyJobGroup | 系统规定参数。取值:ModifyJobGroup。 |
InstanceId | String | 是 | 174952ab-9825-4cc9-a5e2-de82d7fa4cdd | 实例id |
JobGroupId | String | 是 | 3edc0260-6f7c-4de4-8535-09372240618b | 作业组id |
Name | String | 是 | 修改后的作业组 | 作业组名字 |
ScenarioId | String | 是 | c6a668d1-3145-4048-9101-cb3678bb8884 | 场景id,为了兼容旧版外呼功能,可不填。 |
Description | String | 否 | 修改后的作业组 | 作业组描述 |
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,"id":"689fc584-7f9f-4dc2-933d-8711beef7b15"} | 作业组执行策略 name:策略名称 maxAttemptsPerDay:号码每天最大呼叫次数 minAttemptInterval:未接通情况下的重试时间间隔,单位为分钟 startTime:开始时间戳 endTime:结束时间戳 workingTime:可呼出的时间窗口,24小时制 id:策略id,对于该接口为必填 |
RecallStrategyJson | String | 否 | {\"emptyNumberIgnore\":true,\"inArrearsIgnore\":true,\"outOfServiceIgnore\":true} | 重拨策略,json格式。
|
ScriptId | String | 否 | 5a3940ce-a12f-4222-9f0f-605a9b89ea7c | 话术id,必填 |
JobGroupStatus | String | 否 | Draft | 作业组状态,取值范围:
|
RingingDuration | Long | 否 | 25 | 最优振铃时长 |
MinConcurrency | Long | 否 | 1 | 并发保障值 任务启动时,最低保障N个并发; 同一优先级的任务并发保障值加和不能大于实例并发; 若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。 |
Priority | String | 否 | Daily | 作业组优先级,取值范围
|
CallingNumber.N | RepeatList | 否 | ["95187"] | 主叫号码列表 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK | 接口状态码 |
HttpStatusCode | Integer | 200 | http 状态码 |
JobGroup | Struct | 作业组信息 |
|
CallingNumbers | List | ["95187"] | 主叫号码列表 |
CreationTime | Long | 1578550074361 | 创建时间 |
ExportProgress | Struct | 导出信息 |
|
FileHttpUrl | String | https://***.oss-cn-shanghai.aliyuncs.com/sample | 文件地址 |
Progress | String | 1 | 导出进度 |
Status | String | FINISHED | 状态 |
JobDataParsingTaskId | String | da37319b-6c83-4268-9f19-814aed62e401/0cc1b8f0-2f2f-4815-ad23-696d2de9c0d1_cdecew1.xlsx | 解析上传的任务信息的ID |
JobFilePath | String | da37319b-6c83-4268-9f19-814aed62e401/0cc1b8f0-2f2f-4815-ad23-696d2de9c0d1_cdecew1.xlsx | 作业数据上传后的文件key |
JobGroupDescription | String | 催收的作业组 | 作业组描述 |
JobGroupId | String | c62e6789-28a8-41db-941e-171a01d3b3b9 | 作业组id |
JobGroupName | String | 第一个催收 | 作业组id |
MinConcurrency | Long | 1 | 并发保障值 任务启动时,最低保障N个并发; 同一优先级的任务并发保障值加和不能大于实例并发; 若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。 |
ModifyTime | String | 1628425608429 | 修改时间 |
Priority | String | Daily | 作业组优先级,取值范围 Urgent:紧急任务。 Daily:日常任务。 |
RecallStrategy | Struct | 重拨策略。 |
|
EmptyNumberIgnore | Boolean | true | 空号不再外呼 |
InArrearsIgnore | Boolean | true | 欠费不再外呼 |
OutOfServiceIgnore | Boolean | true | 停机不再外呼 |
RingingDuration | Long | 25 | 振铃时长 |
ScenarioId | String | 6cea9bed-63e6-439e-ae4c-b3333efff53d | 场景id |
ScriptName | String | 话术 | 话术名称 |
ScriptVersion | String | 1628425608429 | 话术版本 |
Status | String | Scheduling | 状态 |
Strategy | Struct | 策略信息 |
|
Customized | String | {} | 自定义策略数据 |
EndTime | Long | 2209702074000 | 结束时间 |
FollowUpStrategy | String | CONTINUE | 执行周期结束后的后续处理方式 |
IsTemplate | Boolean | false | 是否是模板 |
MaxAttemptsPerDay | Integer | 3 | 失败后的最大重试次数 |
MinAttemptInterval | Integer | 10 | 重复拨打间隔时间 |
RepeatBy | String | Once | 重复方式 |
RepeatDays | List | [1,2,3,4,5] | 重复执行的天 |
RoutingStrategy | String | LocalFirst | 号码路由策略 |
StartTime | Long | 1578550074000 | 开始时间 |
StrategyDescription | String | 催收作业执行策略 | 策略描述 |
StrategyId | String | f718798d-96be-40e4-bef6-317b54855708 | 策略id |
StrategyName | String | 催收策略 | 策略名字 |
Type | String | Repeatable | 策略类型 |
WorkingTime | Array of TimeFrame | 策略执行时间段 |
|
BeginTime | String | 09:00:00 | 开始时间 |
EndTime | String | 12:00:00 | 结束时间 |
Message | String | Success | 接口提示消息 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求id |
Success | Boolean | true | 是否成功 |
示例
请求示例
http(s)://[Endpoint]/?Action=ModifyJobGroup
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&JobGroupId=3edc0260-6f7c-4de4-8535-09372240618b
&Name=修改后的作业组
&ScenarioId=c6a668d1-3145-4048-9101-cb3678bb8884
&<公共请求参数>
正常返回示例
XML
格式
<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<JobGroup>
<CallingNumbers>95187</CallingNumbers>
<JobGroupName>第一个作业组</JobGroupName>
<ScriptId>63cc3b45-feb2-4676-a7d7-f717001fa1e1</ScriptId>
<Strategy>
<MaxAttemptsPerDay>2</MaxAttemptsPerDay>
<MinAttemptInterval>60</MinAttemptInterval>
<StrategyName>策略名字</StrategyName>
<WorkingTime>
<BeginTime>09:00:00</BeginTime>
<EndTime>12:00:00</EndTime>
</WorkingTime>
<WorkingTime>
<BeginTime>13:00:00</BeginTime>
<EndTime>18:30:00</EndTime>
</WorkingTime>
</Strategy>
</JobGroup>
<Success>true</Success>
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"JobGroup": {
"CallingNumbers": ["95187"],
"JobGroupName": "第一个作业组",
"ScriptId": "63cc3b45-feb2-4676-a7d7-f717001fa1e1",
"Strategy": {
"MaxAttemptsPerDay": 2,
"MinAttemptInterval": 60,
"StrategyName": "策略名字",
"WorkingTime": [
{
"BeginTime": "09:00:00",
"EndTime": "12:00:00"
},
{
"BeginTime": "13:00:00",
"EndTime": "18:30:00" }
]
}
},
"Success": true
}
错误码
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. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。