ListAIAgentPhoneNumber-阿里云帮助中心

Operation description

This API allows a User to query phone resources based on the number of records per page (PageSize) and the current page number (PageNumber). The Return Result includes phone numbers and their corresponding status.

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

ice:ListAIAgentPhoneNumber

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	Page size, indicating the number of records displayed per page. Default Value is 50, with a maximum value of 100.	50
PageNumber	integer	No	Page number. Default Value is 1.	1
Number	string	No	Phone number. Specify Number to directly query the corresponding phone number.	139xxxxxxxxx
Status	integer	No	Status of the target phone number to query. 1: "Activation in progress". 2: "Normal". 3: "Deactivation in progress". 4: "Deactivated".	2

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	array<object>	Array of returned Data.
	object	Returned Data.
PhoneNumber	string	Phone number.	132*****683
Status	integer	Phone number status. 1: "Activation in progress". 2: "Normal". 3: "Deactivation in progress". 4: "Deactivated".	1
RequestId	string	Request ID.	**********16-412C-B127-****
TotalNumber	integer	Total number of phone numbers found in the query.	186
PageNumber	integer	Page number.	1
PageSize	integer	Number of records returned per page.	10

Examples

Success response

JSON format

{
  "Data": [
    {
      "PhoneNumber": "132*****683",
      "Status": 1
    }
  ],
  "RequestId": "************16-412C-B127-******",
  "TotalNumber": 186,
  "PageNumber": 1,
  "PageSize": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.