ListJobsByGroup-阿里云帮助中心

Lists jobs by 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:ListJobsByGroup

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	af81a389-91f0-4157-8d82-720edd02b66a
JobGroupId	string	Yes	Job group ID	de48407d-309e-451a-81ec-6fb11f8fdbf3
JobStatus	string	No	Job status	Succeeded
JobFailureReason	string	No	Job failure reason	NoAnswer
PageNumber	integer	Yes	Page number	1
PageSize	integer	Yes	Number of entries per page	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
Code	string	Response code	OK
Message	string	API message	Success
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the call succeeded	true
Jobs	object	Job array
PageNumber	integer	Page number	1
PageSize	integer	Page size	10
TotalCount	integer	Total count	18
List	array<object>	Job list
	array<object>
Status	string	Job status Scheduling (0) Executing (1) Succeeded (2) Paused (3) Failed (4) Cancelled (5) Drafted (6)	Succeeded
ScenarioId	string	Scenario ID (legacy parameter)	ade80092-03d9-4f4d-ad4f-ab8a247d3150
JobGroupId	string	Job ID	fce6c599-8ede-40e3-9f78-0928eda7b4e8
StrategyId	string	Strategy ID	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobId	string	Job ID	b72425bd-7871-4050-838e-033d80d754b7
Priority	integer	Priority	5
SystemPriority	integer	System priority	1
FailureReason	string	The failure reason. Unknown: An unknown error occurred. NoAnswer: The call was not answered. InvalidStrategy: The policy is invalid or incorrectly configured. TimeUp: The task timed out during scheduling. NoStrategy: The policy is empty or was not found. CallFailed: The call failed. PerDayCallCountLimit: The daily call limit for the phone number was reached. ContactBlockList: The phone number is on the blocklist. EmptyNumber: The phone number is nonexistent. JobPerDayCallCountLimit: The daily call limit for the phone number within the job was reached. VerificationCancelled: The call was canceled because it failed pre-call validation. ContactSuspended: Calling to the contact is suspended. InArrears: The account has an overdue payment. OutOfService: The phone number is out of service. NoneRepeatableJobMaxAttemptCountLimit: The non-repeatable job reached the maximum number of attempts.	NoAnswer
ReferenceId	string	Third-party system ID	d5971d98-7312-4f0e-a918-a17d67133e28
Contacts	array<object>	Contact list
	object	Contact information
PhoneNumber	string	Phone number	134********
State	string	Deprecated	Available
ContactId	string	Contact ID (system-generated)	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	Honorific (same as contact name)	张先生
JobId	string	Job ID (deprecated)	72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName	string	Contact name	张三
Role	string	Deprecated	*
ReferenceId	string	Contact third-party system ID (uploaded by customer)	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras	array<object>	Business data Note TenantId and ServiceId are system-generated. All other parameters are custom.
	object
Key	string	Business parameter name	性别
Value	string	Business parameter value	男
Summary	array<object>	Conversation summary (deprecated) Note Use the DescribeJob API to retrieve this data.
	object
SummaryName	string	Summary name	score
JobGroupId	string	Job group ID	88e56cfb-33f8-477a-907c-0fe83292d924
JobId	string	Job ID	f102a853-5f5a-47fb-8869-b31ea74a9620
Category	string	Conversation summary category	{}
TaskId	string	Call ID	b0f35dd1-0337-402e-9c4f-3a6c2426950a
Content	string	Conversation summary content	5
ConversationDetailId	string	Call record ID	62a860f5-a8b3-4b75-9512-c7e04bb7c8bc
SummaryId	string	Summary ID	680f1905-81ae-4aab-99dd-2964dfb767fa
CallingNumbers	array	Caller number list
	string	Caller number	0571****3106

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 18,
    "List": [
      {
        "Status": "Succeeded",
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
        "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
        "Priority": 5,
        "SystemPriority": 1,
        "FailureReason": "NoAnswer",
        "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
        "Contacts": [
          {
            "PhoneNumber": "134********",
            "State": "Available",
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "Honorific": "张先生",
            "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160",
            "ContactName": "张三",
            "Role": "*",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
          }
        ],
        "Extras": [
          {
            "Key": "性别",
            "Value": "男"
          }
        ],
        "Summary": [
          {
            "SummaryName": "score",
            "JobGroupId": "88e56cfb-33f8-477a-907c-0fe83292d924",
            "JobId": "f102a853-5f5a-47fb-8869-b31ea74a9620",
            "Category": "{}",
            "TaskId": "b0f35dd1-0337-402e-9c4f-3a6c2426950a",
            "Content": "5",
            "ConversationDetailId": "62a860f5-a8b3-4b75-9512-c7e04bb7c8bc",
            "SummaryId": "680f1905-81ae-4aab-99dd-2964dfb767fa"
          }
        ],
        "CallingNumbers": [
          "0571****3106"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter %s is invalid.
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.