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.
CreatePhoneNumberOrder
Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Request Syntax
POST /phone-number-orders HTTP/1.1
Content-type: application/json
{
"E164PhoneNumbers": [ "string
" ],
"ProductType": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- E164PhoneNumbers
-
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern:
^\+?[1-9]\d{1,14}$
Required: Yes
- ProductType
-
The phone number product type.
Type: String
Valid Values:
BusinessCalling | VoiceConnector | SipMediaApplicationDialIn
Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"PhoneNumberOrder": {
"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 201 response.
The following data is returned in JSON format by the service.
- PhoneNumberOrder
-
The phone number order details.
Type: PhoneNumberOrder object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation.
HTTP Status Code: 403
- 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
- ResourceLimitExceededException
-
The request exceeds the resource limit.
HTTP Status Code: 400
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
Examples
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)
Example
This example creates an order for phone numbers to be provisioned.
Sample Request
POST /phone-number-orders HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T175735Z Authorization: AUTHPARAMS Content-Length: 88 {"ProductType": "BusinessCalling", "E164PhoneNumbers": ["+12065550100", "+12065550101"]}
Sample Response
HTTP/1.1 201 Created x-amzn-RequestId: 7ac7b213-6e5d-4b2a-a142-ce9a7bb7e455 Content-Type: application/json Content-Length: 366 Date: Wed, 18 Sep 2019 17:57:43 GMT Connection: keep-alive {"PhoneNumberOrder":{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":[{"E164PhoneNumber":"+12065550100","Status":"Processing"},{"E164PhoneNumber":"+12065550101","Status":"Processing"}],"PhoneNumberOrderId":"abc12345-de67-89f0-123g-h45i678j9012","ProductType":"BusinessCalling","Status":"Processing","UpdatedTimestamp":"2019-09-18T17:57:43.110Z"}}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: