Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPhoneNumbers

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

Request Syntax


GET /phone-numbers?filter-name=FilterName&filter-value=FilterValue&max-results=MaxResults&next-token=NextToken&product-type=ProductType&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FilterName

The filter to limit the number of results.

Valid Values: VoiceConnectorId | VoiceConnectorGroupId | SipRuleId

FilterValue

The filter value.

MaxResults

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token used to return the next page of results.

ProductType

The phone number product types.

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Status

The status of your organization's phone numbers.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PhoneNumbers": [ 
      { 
         "Associations": [ 
            { 
               "AssociatedTimestamp": "string",
               "Name": "string",
               "Value": "string"
            }
         ],
         "CallingName": "string",
         "CallingNameStatus": "string",
         "Capabilities": { 
            "InboundCall": boolean,
            "InboundMMS": boolean,
            "InboundSMS": boolean,
            "OutboundCall": boolean,
            "OutboundMMS": boolean,
            "OutboundSMS": boolean
         },
         "Country": "string",
         "CreatedTimestamp": "string",
         "DeletionTimestamp": "string",
         "E164PhoneNumber": "string",
         "Name": "string",
         "OrderId": "string",
         "PhoneNumberId": "string",
         "ProductType": "string",
         "Status": "string",
         "Type": "string",
         "UpdatedTimestamp": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token used to return the next page of results.

Type: String

PhoneNumbers

The phone number details.

Type: Array of PhoneNumber objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401