DocsICP FilingConsole
Documentation

CreateJobGroup

Updated at:
Copy as MD
Product
My Favorites

Creates a job group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:CreateJobGroup

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

The instance ID.

174952ab-9825-4cc9-a5e2-de82d7fa4cdd
JobGroupName

string

Yes

The task name.

第一个任务
JobGroupDescription

string

No

The task description.

任务描述
ScenarioId

string

No

Deprecated.

b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

ScriptId

string

No

The scenario ID.

b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
StrategyJson

string

No

The task execution strategy.

  • repeatBy: the repeat type. Valid values: Once (no repeat), Week (repeat weekly), and Month (repeat monthly).

  • startTime: the strategy start time for time-based execution.

  • endTime: the strategy end time for time-based execution.

Note

The execution mode is determined as follows:

  • If no strategy start time or end time is specified, the task is executed immediately.

  • If a strategy time is specified, the task is executed based on the schedule. You must also specify the repeat type repeatBy.

  • workingTime: the time window during which outbound calls can be made.

  • maxAttemptsPerDay: the maximum number of call attempts per day for each number in the task.

  • minAttemptInterval: the retry interval for a number, in minutes.

  • routingStrategy: the number strategy. Valid values: None (not specified), LocalFirst (local city numbers preferred), and LocalProvinceFirst (local province numbers preferred).

  • repeatDays: the execution days corresponding to the repeat type. If RepeatBy is set to Week, 0 indicates Sunday and 1-6 indicate Monday through Saturday. If RepeatBy is set to Month, 1-31 indicate the 1st through 31st day. The task is not executed in months that do not have the specified day. For example, if the 30th is selected, the task is not executed in February.

  • repeatable: specifies whether to enable cyclic tasks. Valid values: true and false.

{"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

No

The redial strategy in JSON format. Parameter values default to false.

  • emptyNumberIgnore: does not call nonexistent numbers.

  • inArrearsIgnore: does not call numbers with overdue payments.

  • outOfServiceIgnore: does not call numbers that are out of service.

{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}
CallingNumber

array

No

The list of calling numbers. If not specified, all numbers bound to the instance are selected by default.

string

No

The calling number.

4008013260
RingingDuration

integer

No

The optimal ringing duration. Default value: 25.

25
Priority

string

No

The job group priority. Valid values:

  • Urgent: urgent task.

  • Daily: daily task.

Daily
MinConcurrency

integer

No

The guaranteed concurrency value.

  • When the task starts, a minimum of N concurrent calls are guaranteed.

  • The sum of guaranteed concurrency values for tasks with the same priority cannot exceed the instance concurrency.

  • If the guaranteed concurrency value is set to 0, the system intelligently allocates idle concurrency.

1
FlashSmsExtras

string

No

The configuration parameters for flash SMS in JSON format, including third-party flash SMS configuration information.

  • templateId: the flash SMS template ID.

  • configId: the flash SMS configuration ID.

  • templateContent: the flash SMS content.

Note

Obtain the value of templateContent from the corresponding flash SMS capability provider.

{"templateId":"104xx","configId":"8037f524-6fxxxxx", "templateContent": "【智能外呼机器人】给您来电，敬请接听！"}
RecallCallingNumber

array

No

The list of redial calling numbers.

string

No

The list of redial calling numbers. These are the calling numbers used for redialing when the first call attempt fails. If not specified, the default calling number list is used.

["4008013260"]

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
Code

string

The response code.

OK
Message

string

The prompt message.

Success
RequestId

string

The request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success

boolean

Indicates whether the request was successful.

true
JobGroup

object

The task information.

Status

string

The task status.

Scheduling
ScenarioId

string

The scenario ID.

6cea9bed-63e6-439e-ae4c-b3333efff53d
JobGroupId

string

The task ID.

c62e6789-28a8-41db-941e-171a01d3b3b9
CreationTime

integer

The creation time.

1578550074361
JobGroupName

string

The task name.

第一个作业组
JobFilePath

string

The OSS path of the task file.

Note

No value is returned if this field is empty.

UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx
JobGroupDescription

string

The task description.

第一个的作业组
JobDataParsingTaskId

string

The ID of the background asynchronous parsing operation for the uploaded task file.

Note

No value is returned if this field is empty.

744ff448-2b4c-40d4-94ca-51f246905b0f
ScriptName

string

The dialog flow scenario name.

话术
ScriptVersion

string

The dialog flow scenario version.

1628425608429
ModifyTime

string

The modification time.

1628425608429
CallingNumbers

array

The list of calling numbers.

string

The calling number.

["4008013260"]
ExportProgress

object

The export progress.

Note

This field is deprecated.

Status

string

Job export status. [Deprecated]

FINISHED
FileHttpUrl

string

File URL. [Deprecated]

https://***.oss-cn-shanghai.aliyuncs.com/sample
Progress

string

Progress. [Deprecated]

1
Strategy

object

The task scheduling strategy.

Type

string

Policy Type.

Repeatable
StrategyName

string

Policy Name.

催收策略
MaxAttemptsPerDay

integer

The maximum number of attempts per day when a call in the job fails to connect.

3
FollowUpStrategy

string

Post-execution handling method after the epoch ends (this field is deprecated).

CONTINUE
EndTime

integer

End Time

2209702074000
Customized

string

Custom policy data

{}
IsTemplate

boolean

Indicates whether it is a template.

false
StartTime

integer

Start Time.

1578550074000
StrategyId

string

Policy ID.

cc9a436e-03b0-4ada-8364-77ec2290aa39
RoutingStrategy

string

Number routing policy.

  • None: No special rule.

  • LocalFirst: Local city numbers are prioritized.

  • LocalProvinceFirst: Numbers from the same province are prioritized.

LocalFirst
MinAttemptInterval

integer

Calling interval.

3
StrategyDescription

string

Policy Description

催收策略
RepeatBy

string

Repetition mode: "once" for no repetition, "day" for daily repetition, "week" for weekly repetition, and "month" for monthly repetition.

Once
WorkingTime

array<object>

Time window for policy execution.

object

Time window for policy execution.

EndTime

string

Start Time of the window.

12:00:00
BeginTime

string

End Time of the window.

09:00:00
RepeatDays

array

Days on which execution repeats.

  • If the recurrence RepeatBy is set to Week, 0 represents Sunday, and 1–6 represent Monday through Saturday, respectively.

  • If the recurrence RepeatBy is set to Month, values 1–31 represent the 1st through the 31st day of the month. Months that do not contain the specified date will not execute the task. For example, if the 30th is selected, the task will not run in February.

string

Days on which execution repeats.

[1,2,3,4,5]
RecallStrategy

object

The redial strategy.

EmptyNumberIgnore

boolean

Do not make outbound calls to nonexistent numbers.

true
InArrearsIgnore

boolean

Do not make outbound calls to numbers with overdue payment.

true
OutOfServiceIgnore

boolean

Do not make outbound calls to numbers that are out of service.

true
RingingDuration

integer

The ringing duration.

30
Priority

string

The job group priority. Valid values:

  • Urgent: urgent task.

  • Daily: daily task.

Daily
MinConcurrency

integer

The guaranteed concurrency value. When the task starts, a minimum of N concurrent calls are guaranteed. The sum of guaranteed concurrency values for tasks with the same priority cannot exceed the instance concurrency. If the guaranteed concurrency value is set to 0, the system intelligently allocates idle concurrency.

1
RecallCallingNumbers

array

The list of redial calling numbers.

string

The list of redial calling numbers. These are the calling numbers used for redialing when the first call attempt fails. If not specified, the default calling number list is used.

["4008013260"]

Examples

Success response

JSON format

{
  "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\"]"
    ]
  }
}

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.
404 NotExist.Instance The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.