ChimeSDKVoice / Client / get_phone_number_order

get_phone_number_order#

ChimeSDKVoice.Client.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.

Request Syntax

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

Parameters:

PhoneNumberOrderId (string) –

[REQUIRED]

The ID of the phone number order .

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

ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.NotFoundException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException