get_phone_number_order

get_phone_number_order(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number_order(
    PhoneNumberOrderId='string'
)

Parameters

PhoneNumberOrderId (string) --

[REQUIRED]

The ID for the phone number order.

Return type

dict

Returns

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial',
        '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 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.

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

• Chime.Client.exceptions.UnauthorizedClientException
• Chime.Client.exceptions.NotFoundException
• Chime.Client.exceptions.ForbiddenException
• Chime.Client.exceptions.BadRequestException
• Chime.Client.exceptions.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException