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

CreatePhoneNumberOrder

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

Request Syntax


POST /phone-number-orders HTTP/1.1
Content-type: application/json

{
   "E164PhoneNumbers": [ "string" ],
   "Name": "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

Name

Specifies the name assigned to one or more phone numbers.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^$|^[a-zA-Z0-9\,\.\_\-]+(\s+[a-zA-Z0-9\,\.\_\-]+)*$

Required: No

ProductType

The phone number product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "PhoneNumberOrder": { 
      "CreatedTimestamp": "string",
      "OrderedPhoneNumbers": [ 
         { 
            "E164PhoneNumber": "string",
            "Status": "string"
         }
      ],
      "OrderType": "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 the permissions needed to run this action.

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

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

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"}}