ListJobGroups-阿里云帮助中心

Retrieves the list of outbound call task groups.

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:ListJobGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	174952ab-9825-4cc9-a5e2-de82d7fa4cdd
StartTime	integer	No	The start of the time range for the query, based on the creation time of the job group. Specify the time as a UNIX timestamp in milliseconds.	1578965079000
EndTime	integer	No	The end of the time range for the query, based on the creation time of the job group. Specify the time as a UNIX timestamp in milliseconds.	1579965079000
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries to return per page.	10
AsyncQuery	boolean	No	Specifies whether to retrieve the query results asynchronously.	true
SearchText	string	No	The search text.	面试
JobGroupStatusFilter	string	No	Filters results by job status. To specify multiple statuses, separate them with commas. The statuses are combined with a logical OR. Valid values: Draft: The job group is a draft. Scheduling: The job group is being scheduled. Executing: The job group is executing. Completed: The job group has completed. Paused: The job group is paused. Failed: The job group has failed. Cancelled: The job group is canceled. Initializing: The job group is initializing.	Draft
OnlyMinConcurrencyEnabled	boolean	No	Specifies whether to return only job groups with minimum concurrency enabled.	false

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful. Valid values: `true` and `false`.	true
Code	string	The response code.	OK
Message	string	The returned message.	Success
AsyncTaskId	string	The ID of the asynchronous task. You can use this ID to query the status of the task.	6243d904-939d-42ce-a8e4-886a139e77a3
JobGroups	object	The list of job groups.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	100
List	array<object>	The list of job groups.
	array<object>
Status	string	The status of the job group. Valid values: Draft: The job group is a draft. Scheduling: The job group is being scheduled. Executing: The job group is running. Completed: The job group is completed. Paused: The job group is paused. Failed: The job group failed. Cancelled: The job group is canceled. Initializing: The job group is being initialized.	Draft
JobGroupId	string	The ID of the job group.	c62e6789-28a8-41db-941e-171a01d3b3b9
CreationTime	integer	The time when the job group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1578550074361
JobGroupName	string	The name of the job group.	催收作业组
TotalCallNum	integer	The total number of calls.	10
ScriptId	string	The ID of the script.	c62e6789-28a8-41db-941e-171a01d3b3b9
JobGroupDescription	string	The description of the job group.	催收的作业组
JobDataParsingTaskId	string	The ID of the task that parses the job data file. This parameter is deprecated.	c62e6789-28a8-41db-941e-171a01d3b3b9
ScriptName	string	The name of the script.	话术名称
ScriptVersion	string	The script version.	d9e828ac-744b-4dd3-848a-17a3da9167b8
ModifyTime	string	The time when the job group was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1578550074361
Progress	object	The progress of the job group.	{}
TotalNotAnswered	integer	This parameter is deprecated.	1
Status	string	Note This parameter is no longer returned. The status of the job. Valid values: Draft: The job is a draft. Scheduling: The job is being scheduled. Executing: The job is running. Completed: The job is completed. Paused: The job is paused. Failed: The job failed. Cancelled: The job is canceled. Initializing: The job is being initialized.	Scheduling
StartTime	integer	The start time. This parameter is deprecated.	1578550074361
FailedNum	integer	The number of failed jobs.	5
PausedNum	integer	The number of paused jobs.	5
CancelledNum	integer	The number of canceled jobs.	5
TotalJobs	integer	The total number of jobs.	20
TotalCompleted	integer	The number of completed jobs.	3
Duration	integer	The total runtime. This parameter is deprecated.	1578550074361
ExecutingNum	integer	The number of running jobs.	10
Scheduling	integer	The number of jobs that are being scheduled.	10
ExportProgress	object	The progress of the export task.	{}
Status	string	The status of the export task. Valid values: PENDING: The task is pending. IN_PROGRESS: The task is in progress. FINISHED: The task is finished. FAILED: The task failed.	PENDING
FileHttpUrl	string	This parameter is deprecated.	http://www.xxx.com/xxx
Progress	string	The progress of the export task.	1
Strategy	object	The calling strategy. This parameter is deprecated. Note To view the strategy for a job group, call the `DescribeJobGroup` operation.	{}
EndTime	integer	The end time of the calling window.	2209702074000
StartTime	integer	The start time of the calling window.	1578550074000
MinConcurrency	integer	The minimum number of concurrent calls.	1

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "AsyncTaskId": "6243d904-939d-42ce-a8e4-886a139e77a3\n",
  "JobGroups": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "Status": "Draft",
        "JobGroupId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "CreationTime": 1578550074361,
        "JobGroupName": "催收作业组",
        "TotalCallNum": 10,
        "ScriptId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "JobGroupDescription": "催收的作业组",
        "JobDataParsingTaskId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "ScriptName": "话术名称",
        "ScriptVersion": "d9e828ac-744b-4dd3-848a-17a3da9167b8",
        "ModifyTime": "1578550074361",
        "Progress": {
          "TotalNotAnswered": 1,
          "Status": "Scheduling",
          "StartTime": 1578550074361,
          "FailedNum": 5,
          "PausedNum": 5,
          "CancelledNum": 5,
          "TotalJobs": 20,
          "TotalCompleted": 3,
          "Duration": 1578550074361,
          "ExecutingNum": 10,
          "Scheduling": 10
        },
        "ExportProgress": {
          "Status": "PENDING",
          "FileHttpUrl": "http://www.xxx.com/xxx",
          "Progress": "1"
        },
        "Strategy": {
          "EndTime": 2209702074000,
          "StartTime": 1578550074000
        },
        "MinConcurrency": 1
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.