ListPhoneNumberOrders - Amazon Chime

The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.


Lists the phone number orders for the administrator's Amazon Chime account.

Request Syntax

GET /phone-number-orders?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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

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


The token to use to retrieve the next page of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "PhoneNumberOrders": [ { "CreatedTimestamp": "string", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "string", "Status": "string" } ], "PhoneNumberOrderId": "string", "ProductType": "string", "Status": "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.


The token to use to retrieve the next page of results.

Type: String


The phone number order details.

Type: Array of PhoneNumberOrder objects


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


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

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401


In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


This example lists the phone number orders for the administrator's Amazon Chime account.

Sample Request

GET /phone-number-orders HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T175325Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6e79c3b2-a0e4-443e-a280-9057b0edd4e8 Content-Type: application/json Content-Length: 770 Date: Wed, 18 Sep 2019 17:53:26 GMT Connection: keep-alive {"NextToken":null,"PhoneNumberOrders":[{"CreatedTimestamp":"2019-08-12T22:10:20.504Z","OrderedPhoneNumbers":[{"E164PhoneNumber":"+12065550100","Status":"Acquired"},{"E164PhoneNumber":"+12065550101","Status":"Acquired"}],"PhoneNumberOrderId":"abc12345-de67-89f0-123g-h45i678j9012","ProductType":"Voice Connector","Status":"Successful","UpdatedTimestamp":"2019-08-12T22:10:31.186Z"}]}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: