CreateJobGroup

Updated at:

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 job name.

First job

JobGroupDescription

string

No

The job description.

Job description

ScenarioId

string

No

[Deprecated]

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

ScriptId

string

No

The script ID.

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

StrategyJson

string

No

The job execution strategy.

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

  • startTime: the start time of the strategy when executed by time.

  • endTime: the end time of the strategy when executed by time.

Note

Execution methods are divided into:

  • If the start and end times are not specified, the job is executed immediately.

  • If the start and end times are specified, the job is executed by time, and the repeatBy recurrence type must be selected.

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

  • maxAttemptsPerDay: the maximum number of call attempts per day for numbers in this job.

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

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

  • repeatDays: the execution days corresponding to the recurrence type. If the repeatBy recurrence type is Week, 0 indicates Sunday, and 1 to 6 indicate Monday to Saturday. If the repeatBy recurrence type is Month, 1 to 31 indicate the 1st to the 31st day. Months without the specified date are not executed. For example, if the 30th is selected, the job is not executed in February.

  • repeatable: specifies whether to enable recurring jobs. 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 recall strategy in JSON format. The default value of parameters in the JSON string is false.

  • emptyNumberIgnore: does not call nonexistent numbers.

  • inArrearsIgnore: does not call numbers with overdue payments.

  • outOfServiceIgnore: does not call suspended numbers.

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

CallingNumber

array

No

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

string

No

The caller number.

4008013260

RingingDuration

integer

No

The optimal ringing duration. Default value: 25.

25

Priority

string

No

The job group priority. Valid values:

  • Urgent: urgent job.

  • Daily: daily job.

Valid values:

  • Daily :

    Daily job.

  • Urgent :

    Urgent job.

Daily

MinConcurrency

integer

No

The guaranteed concurrency value.

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

  • The sum of guaranteed concurrency values for jobs of 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 push in JSON format, including the configuration information of third-party flash SMS.

  • templateId: the flash SMS template ID.

  • configId: the flash SMS configuration ID.

  • templateContent: the flash SMS content.

Note

To obtain the value of templateContent, contact the partner that provides the corresponding flash SMS capability.

{"templateId":"104xx","configId":"8037f524-6fxxxxx", "templateContent": "[Outbound Robot] is calling you. Please answer!"}

RecallCallingNumber

array

No

The list of caller numbers for recall.

string

No

The list of caller numbers for recall, which refers to the caller numbers used for recall when the first call fails. If not specified, the default is the same as the caller number list.

["4008013260"]

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Code

string

The response code.

OK

Message

string

The message.

Success

RequestId

string

The request ID.

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

Success

boolean

Indicates whether the request is successful.

true

JobGroup

object

The job information.

Status

string

The job status.

Scheduling

ScenarioId

string

The script ID.

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

JobGroupId

string

The job ID.

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

CreationTime

integer

The creation time. The value is a UNIX timestamp in milliseconds.

1578550074361

JobGroupName

string

The job name.

First job group

JobFilePath

string

The OSS path of the job file.

Note

If no value exists, this parameter is not returned.

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

JobGroupDescription

string

The job description.

First job group

JobDataParsingTaskId

string

The ID of the background asynchronous parsing operation corresponding to the uploaded job file.

Note

If no value exists, this parameter is not returned.

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

ScriptName

string

The script name.

Script

ScriptVersion

string

The script version.

1628425608429

ModifyTime

string

The modification time. The value is a UNIX timestamp in milliseconds.

1628425608429

CallingNumbers

array

The list of caller numbers.

string

The caller number.

["4008013260"]

ExportProgress

object

[Deprecated] The export progress.

Status

string

[Deprecated] The job export status.

FINISHED

FileHttpUrl

string

[Deprecated] The file URL.

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

Progress

string

[Deprecated] The progress.

1

Strategy

object

The job scheduling strategy.

Type

string

The strategy type.

Repeatable

StrategyName

string

The strategy name.

Collection strategy

MaxAttemptsPerDay

integer

The maximum number of call attempts per day when calls are not connected in the job.

3

FollowUpStrategy

string

[Deprecated] The follow-up processing method after the execution cycle ends.

CONTINUE

EndTime

integer

The end time. The value is a UNIX timestamp in milliseconds.

2209702074000

Customized

string

The custom strategy data.

{}

IsTemplate

boolean

Indicates whether it is a template.

false

StartTime

integer

The start time. The value is a UNIX timestamp in milliseconds.

1578550074000

StrategyId

string

The strategy ID.

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

RoutingStrategy

string

The number routing strategy. Valid values:

  • None: no special rules.

  • LocalFirst: local city numbers first.

  • LocalProvinceFirst: local province numbers first.

LocalFirst

MinAttemptInterval

integer

The call interval.

3

StrategyDescription

string

The strategy description.

Collection strategy

RepeatBy

string

The recurrence type. Valid values: once (no recurrence), day (daily recurrence), week (weekly recurrence), and month (monthly recurrence).

Once

WorkingTime

array<object>

The strategy execution time window.

object

The strategy execution time window.

EndTime

string

The end time of the window. Format: HH:mm:ss.

12:00:00

BeginTime

string

The start time of the window. Format: HH:mm:ss.

09:00:00

RepeatDays

array

The execution days for recurrence.

  • If the RepeatBy recurrence type is week, 0 indicates Sunday, and 1 to 6 indicate Monday to Saturday.

  • If the RepeatBy recurrence type is month, 1 to 31 indicate the 1st to the 31st day. Months without the specified date are not executed. For example, if the 30th is selected, the job is not executed in February.

string

The execution day for recurrence.

[1,2,3,4,5]

RecallStrategy

object

The recall strategy.

EmptyNumberIgnore

boolean

Specifies whether to skip nonexistent numbers.

true

InArrearsIgnore

boolean

Specifies whether to skip numbers with overdue payments.

true

OutOfServiceIgnore

boolean

Specifies whether to skip suspended numbers.

true

RingingDuration

integer

The ringing duration.

30

Priority

string

The job group priority. Valid values:

  • Urgent: urgent job.

  • Daily: daily job.

Daily

MinConcurrency

integer

The guaranteed concurrency value. When the job starts, a minimum of N concurrent calls are guaranteed. The sum of guaranteed concurrency values for jobs of 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 caller numbers for recall.

string

The list of caller numbers for recall, which refers to the caller numbers used for recall when the first call fails. If not specified, the default is the same as the caller number list.

["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": "First job group",
    "JobFilePath": "UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx",
    "JobGroupDescription": "First job group",
    "JobDataParsingTaskId": "744ff448-2b4c-40d4-94ca-51f246905b0f",
    "ScriptName": "Script",
    "ScriptVersion": "1628425608429",
    "ModifyTime": "1628425608429",
    "CallingNumbers": [
      "[\"4008013260\"]"
    ],
    "ExportProgress": {
      "Status": "FINISHED",
      "FileHttpUrl": "https://***.oss-cn-shanghai.aliyuncs.com/sample",
      "Progress": "1"
    },
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "Collection strategy",
      "MaxAttemptsPerDay": 3,
      "FollowUpStrategy": "CONTINUE",
      "EndTime": 2209702074000,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578550074000,
      "StrategyId": "cc9a436e-03b0-4ada-8364-77ec2290aa39",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 3,
      "StrategyDescription": "Collection strategy",
      "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.