GetPhoneNumberOrder - Amazon Chime SDK


Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Request Syntax

GET /phone-number-orders/phoneNumberOrderId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID for the phone number order.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "PhoneNumberOrder": { "CreatedTimestamp": number, "OrderedPhoneNumbers": [ { "E164PhoneNumber": "string", "Status": "string" } ], "PhoneNumberOrderId": "string", "ProductType": "string", "Status": "string", "UpdatedTimestamp": number } }

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 phone number order details.

Type: PhoneNumberOrder object


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


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


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 retrieves details for the specified phone number order.

Sample Request

GET /phone-number-orders/abc12345-de67-89f0-123g-h45i678j9012 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: 20190918T175948Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 2cac62a6-cdda-43fe-9053-d11f85cbc7e9 Content-Type: application/json Content-Length: 362 Date: Wed, 18 Sep 2019 17:59:49 GMT Connection: keep-alive {"PhoneNumberOrder":{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":[{"E164PhoneNumber":"+12065550100","Status":"Acquired"},{"E164PhoneNumber":"+12065550101","Status":"Acquired"}],"PhoneNumberOrderId":"abc12345-de67-89f0-123g-h45i678j9012","ProductType":"BusinessCalling","Status":"Successful","UpdatedTimestamp":"2019-09-18T17:57:47.090Z"}}

See Also

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