GetSummaryInfo-阿里云帮助中心

Summary information for outbound call instances.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceIdList	array	No	List of instance IDs.	[]
	string	No	Instance ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	Response code.	OK
Message	string	Response message.	Success
RequestId	string	Request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request succeeded.	true
AgentBotInstanceSummaryList	array<object>	List of instances.	[]
	object
TotalCallCount	integer	Total number of outbound calls.	12
InstanceId	string	Instance ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
TotalCallTime	integer	Total call duration, in seconds.	10
UsedRecordingStorageSpace	integer	Used recording storage space, in MB.	10

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "AgentBotInstanceSummaryList": [
    {
      "TotalCallCount": 12,
      "InstanceId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "TotalCallTime": 10,
      "UsedRecordingStorageSpace": 10
    }
  ]
}

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.