ChimeSDKVoice / Client / create_phone_number_order

create_phone_number_order#

ChimeSDKVoice.Client.create_phone_number_order(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_phone_number_order(
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    E164PhoneNumbers=[
        'string',
    ],
    Name='string'
)
Parameters:

  • ProductType (string) –

    [REQUIRED]

    The phone number product type.

  • E164PhoneNumbers (list) –

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) –

  • Name (string) – Specifies the name assigned to one or more phone numbers.

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
        'OrderType': 'New'|'Porting',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • PhoneNumberOrder (dict) –

      The phone number order details.

      • PhoneNumberOrderId (string) –

        The ID of the phone order.

      • ProductType (string) –

        The phone number order product type.

      • Status (string) –

        The status of the phone number order.

      • OrderType (string) –

        The type of phone number being ordered, local or toll-free.

      • OrderedPhoneNumbers (list) –

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

        • (dict) –

          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 (datetime) –

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

      • UpdatedTimestamp (datetime) –

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

Exceptions