ListOutboundCallNumbers-阿里云帮助中心

List outbound call numbers.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID of the instance.	af81a389-91f0-4157-8d82-720edd02b66a
PageNumber	integer	Yes	Page number.	1
PageSize	integer	Yes	Number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	API status code.	OK
Message	string	API message.	Success
RequestId	string	Request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the call was successful.	true
OutboundCallNumbers	object	List of outbound call numbers.
PageNumber	integer	Page number.	1
PageSize	integer	Number of entries on the page.	10
TotalCount	integer	Total number of entries.	10
List	array<object>	List of outbound call number data.
	object
Number	string	Phone number.	10088
OutboundCallNumberId	string	ID of the phone number.	fa0e21e9-caab-4629-9121-1e341243d599
RateLimitCount	string	Time window for rate limiting, in seconds.	10
RateLimitPeriod	string	Maximum number of calls allowed in the time window.	100

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "OutboundCallNumbers": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "Number": "10088",
        "OutboundCallNumberId": "\tfa0e21e9-caab-4629-9121-1e341243d599",
        "RateLimitCount": "10",
        "RateLimitPeriod": "100"
      }
    ]
  }
}

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.
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.