[ aws . chime ]

create-phone-number-order

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-phone-number-order
--product-type <value>
--e164-phone-numbers <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--product-type (string)

The phone number product type.

Possible values:

• BusinessCalling

• VoiceConnector

• SipMediaApplicationDialIn

--e164-phone-numbers (list)

List of phone numbers, in E.164 format.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a phone number order

The following create-phone-number-order example creates a phone number order for the specified phone numbers.

aws chime create-phone-number-order \
    --product-type VoiceConnector \
    --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102"

Output:

{
    "PhoneNumberOrder": {
        "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012",
        "ProductType": "VoiceConnector",
        "Status": "Processing",
        "OrderedPhoneNumbers": [
            {
                "E164PhoneNumber": "+12065550100",
                "Status": "Processing"
            },
            {
               "E164PhoneNumber": "+12065550101",
               "Status": "Processing"
            },
            {
              "E164PhoneNumber": "+12065550102",
              "Status": "Processing"
            }
        ],
        "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
        "UpdatedTimestamp": "2019-08-09T21:35:22.408Z"
    }
}

For more information, see Working with Phone Numbers in the Amazon Chime Administration Guide.

Output

PhoneNumberOrder -> (structure)

The phone number order details.

PhoneNumberOrderId -> (string)

The phone number order ID.

ProductType -> (string)

The phone number order product type.

Status -> (string)

The status of the phone number order.

OrderedPhoneNumbers -> (list)

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

(structure)

A phone number for which an order has been placed.

E164PhoneNumber -> (string)

The phone number, in E.164 format.

Status -> (string)

The phone number status.

CreatedTimestamp -> (timestamp)

The phone number order creation time stamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated phone number order time stamp, in ISO 8601 format.