DescribeGroupExecutingInfo-阿里云帮助中心

Returns the execution status of tasks in a task 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:DescribeGroupExecutingInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4
JobGroupId	string	Yes	Task group ID	3640dda7-e5b1-4b3e-9ccf-da4fc5402e11

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
GroupId	string	Task group ID	b24d321a-2a74-4dd1-a0ba-4ab09cef6652
Success	boolean	Indicates whether the request succeeded	true
Code	string	API status code	OK
Message	string	API message	Success
InstanceId	string	Instance ID	c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4
ExecutingInfo	object	Execution information	{}
EndTime	integer	End time	1640087774563
StartTime	integer	Start time	1640087774563
HangUpByClientNum	integer	Number of calls hung up by customers	5
CreatorName	string	Deprecated	xxx
TransferByNoAnswer	integer	No answer	5
FinishedNum	integer	Number of completed executions	5
TransferByIntentNum	integer	Intent recognition	5
CallNum	integer	Number of outbound calls	5
CallFailedNum	integer	Number of failed calls	5
NoInteractionNum	integer	Number of calls with no interaction	1
JobsProgress	object	Execution progress	{}
SchedulingNum	integer	Number of tasks being scheduled	5
TotalCompletedNum	integer	Total number of completed tasks	5
FailedNum	integer	Number of failed tasks	5
PausedNum	integer	Number of paused tasks	5
CancelledNum	integer	Number of canceled tasks	5
TotalJobs	integer	Total number of jobs	5
TotalNotAnsweredNum	integer	Number of unanswered calls	5
ExecutingNum	integer	Number of executing jobs	5
TalkTurnsDistribution	string	Distribution of conversation rounds total: total number of conversation rounds involved number: specific round number Note Example: {"total":"5","5":"1"} means 5 conversation rounds were involved, and 1 call had 5 user turns.	{"total":"5","5":"4"}
DurationDistribution	string	Call duration distribution	{"max":"40","1":"1","total":"40","min":"40"}
AvgTalkTime	integer	Average talk time	258

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "GroupId": "b24d321a-2a74-4dd1-a0ba-4ab09cef6652",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "InstanceId": "c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4",
  "ExecutingInfo": {
    "EndTime": 1640087774563,
    "StartTime": 1640087774563,
    "HangUpByClientNum": 5,
    "CreatorName": "xxx",
    "TransferByNoAnswer": 5,
    "FinishedNum": 5,
    "TransferByIntentNum": 5,
    "CallNum": 5,
    "CallFailedNum": 5,
    "NoInteractionNum": 1,
    "JobsProgress": {
      "SchedulingNum": 5,
      "TotalCompletedNum": 5,
      "FailedNum": 5,
      "PausedNum": 5,
      "CancelledNum": 5,
      "TotalJobs": 5,
      "TotalNotAnsweredNum": 5,
      "ExecutingNum": 5
    },
    "TalkTurnsDistribution": "{\"total\":\"5\",\"5\":\"4\"}\n",
    "DurationDistribution": "{\"max\":\"40\",\"1\":\"1\",\"total\":\"40\",\"min\":\"40\"}",
    "AvgTalkTime": 258
  }
}

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.