ModifyBatchJobs
Modifies batch jobs. This operation is deprecated.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:ModifyBatchJobs |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
174952ab-9825-4cc9-a5e2-de82d7fa4cdd |
| JobGroupId |
string |
Yes |
The job group ID. |
c6a668d1-3145-4048-9101-cb3678bb8884 |
| BatchJobName |
string |
Yes |
The job name. |
催收作业组 |
| Description |
string |
No |
The description of the job group. |
这是催收作业组-01 |
| ScenarioId |
string |
No |
The scenario ID. |
c6a668d1-3145-4048-9101-cb3678bb8884 |
| StrategyJson |
string |
No |
The policy in the JSON format. |
{"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60} |
| JobFilePath |
string |
No |
The download URL of the Excel file for the job. |
52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx |
| Submitted |
boolean |
Yes |
Specifies whether to submit the job. `false` submits the job. `true` saves the job as a draft. |
false |
| ScriptId |
string |
No |
The script ID. |
7d820242-f4f0-4d2e-ae35-b424c41cbc5b |
| CallingNumber |
array |
No |
The calling numbers. |
["95187"] |
|
string |
No |
A calling number. |
["0591***212"] |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
The status code of the API call. |
OK |
| Message |
string |
The message returned for the API call. |
Success |
| RequestId |
string |
The request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
Indicates whether the call was successful. |
true |
| JobGroup |
object |
The information about the job group. |
|
| CreationTime |
integer |
The time when the job group was created. |
1579068424000 |
| JobGroupId |
string |
The job group ID. |
5a7e8b09-baf9-4cab-b540-c971f47a7146 |
| ScenarioId |
string |
The scenario ID. |
6cea9bed-63e6-439e-ae4c-b3333efff53d |
| JobGroupName |
string |
The name of the job group. |
第一个催收作业组 |
| JobFilePath |
string |
The key of the job file after it is uploaded. |
52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx |
| JobGroupDescription |
string |
The description of the job group. |
第一个催收作业组 |
| CallingNumbers |
array |
The list of calling numbers. |
|
|
string |
A list of calling numbers. |
["1****6"] |
|
| Strategy |
object |
The execution policy. |
|
| Type |
string |
The policy type. |
Repeatable |
| StrategyName |
string |
The policy name. |
催收策略 |
| MaxAttemptsPerDay |
integer |
The maximum number of redials after a call fails. |
3 |
| FollowUpStrategy |
string |
The follow-up action after an execution epoch ends. |
CONTINUE |
| EndTime |
integer |
The end time. |
2209702074000 |
| Customized |
string |
The custom data for the policy. |
{} |
| IsTemplate |
boolean |
Indicates whether the policy is a template. |
false |
| StartTime |
integer |
The start time. |
1578550074000 |
| StrategyId |
string |
The policy ID. |
f718798d-96be-40e4-bef6-317b54855708 |
| RoutingStrategy |
string |
The number routing policy. |
LocalFirst |
| MinAttemptInterval |
integer |
The interval between redials. |
10 |
| StrategyDescription |
string |
The policy description. |
催收作业执行策略 |
| RepeatBy |
string |
The repeat mode. |
Once |
| WorkingTime |
array<object> |
The time frames during which the policy is executed. |
|
|
object |
A time frame during which the policy is executed. |
||
| EndTime |
string |
The end time. |
1581997093000 |
| BeginTime |
string |
The start time. |
1581937093000 |
| RepeatDays |
array |
The days of the week on which to repeat the execution. |
|
|
string |
A day of the week on which to repeat the execution. |
[1,2,3,4,5] |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"JobGroup": {
"CreationTime": 1579068424000,
"JobGroupId": "5a7e8b09-baf9-4cab-b540-c971f47a7146",
"ScenarioId": "6cea9bed-63e6-439e-ae4c-b3333efff53d",
"JobGroupName": "第一个催收作业组",
"JobFilePath": "52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx",
"JobGroupDescription": "第一个催收作业组",
"CallingNumbers": [
"[\"1****6\"]"
],
"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": "1581997093000",
"BeginTime": "1581937093000"
}
],
"RepeatDays": [
"[1,2,3,4,5]"
]
}
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.