AWS API Changes

2025/04/03 - Amazon Chime SDK Voice - 3 updated api methods

Changes Added FOC date as an attribute of PhoneNumberOrder, added AccessDeniedException as a possible return type of ValidateE911Address

CreatePhoneNumberOrder (updated)

Link ¶
Changes (response)

{'PhoneNumberOrder': {'FocDate': 'timestamp'}}

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

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

type ProductType:

string

param ProductType:

[REQUIRED]

The phone number product type.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

List of phone numbers, in E.164 format.

(string) --

type Name:

string

param Name:

Specifies the name assigned to one or more phone numbers.

rtype:

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),
        'FocDate': 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.
  - FocDate (datetime) --
    
    The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

GetPhoneNumberOrder (updated)

Link ¶
Changes (response)

{'PhoneNumberOrder': {'FocDate': 'timestamp'}}

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

client.get_phone_number_order(
    PhoneNumberOrderId='string'
)

type PhoneNumberOrderId:

string

param PhoneNumberOrderId:

[REQUIRED]

The ID of the phone number order .

rtype:

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),
        'FocDate': 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.
  - FocDate (datetime) --
    
    The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

ListPhoneNumberOrders (updated)

Link ¶
Changes (response)

{'PhoneNumberOrders': {'FocDate': 'timestamp'}}

Lists the phone numbers for an administrator's Amazon Chime SDK account.

See also: AWS API Documentation

Request Syntax

client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

The token used to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberOrders': [
        {
            '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),
            'FocDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PhoneNumberOrders (list) --
  
  The phone number order details.
  - (dict) --
    
    The details of an Amazon Chime SDK phone number order.
    - 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.
    - FocDate (datetime) --
      
      The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.
- NextToken (string) --
  
  The token used to retrieve the next page of results.