AWS API Changes

2023/08/09 - Amazon Chime SDK Voice - 6 updated api methods

Changes Updating CreatePhoneNumberOrder, UpdatePhoneNumber and BatchUpdatePhoneNumbers APIs, adding phone number name

BatchUpdatePhoneNumber (updated)

Link ¶
Changes (request)

{'UpdatePhoneNumberRequestItems': {'Name': 'string'}}

Updates one or more phone numbers.

See also: AWS API Documentation

Request Syntax

client.batch_update_phone_number(
    UpdatePhoneNumberRequestItems=[
        {
            'PhoneNumberId': 'string',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'CallingName': 'string',
            'Name': 'string'
        },
    ]
)

type UpdatePhoneNumberRequestItems:

list

param UpdatePhoneNumberRequestItems:

[REQUIRED]

Lists the phone numbers in the update request.

(dict) --

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
- PhoneNumberId (string) -- [REQUIRED]
  
  The phone number ID to update.
- ProductType (string) --
  
  The product type to update.
- CallingName (string) --
  
  The outbound calling name to update.
- Name (string) --
  
  The name of the phone number.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  
  A list of failed phone numbers and their error messages.
  - (dict) --
    
    If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.
    - PhoneNumberId (string) --
      
      The phone number ID for which the action failed.
    - ErrorCode (string) --
      
      The error code.
    - ErrorMessage (string) --
      
      The error message.

CreatePhoneNumberOrder (updated)

Link ¶
Changes (request)

{'Name': 'string'}

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)
    }
}

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.

GetPhoneNumber (updated)

Link ¶
Changes (response)

{'PhoneNumber': {'Name': 'string'}}

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

See also: AWS API Documentation

Request Syntax

client.get_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number ID.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string',
        'Name': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  
  The phone number details.
  - PhoneNumberId (string) --
    
    The phone number's ID.
  - E164PhoneNumber (string) --
    
    The phone number, in E.164 format.
  - Country (string) --
    
    The phone number's country. Format: ISO 3166-1 alpha-2.
  - Type (string) --
    
    The phone number's type.
  - ProductType (string) --
    
    The phone number's product type.
  - Status (string) --
    
    The phone number's status.
  - Capabilities (dict) --
    
    The phone number's capabilities.
    - InboundCall (boolean) --
      
      Allows or denies inbound calling for the specified phone number.
    - OutboundCall (boolean) --
      
      Allows or denies outbound calling for the specified phone number.
    - InboundSMS (boolean) --
      
      Allows or denies inbound SMS messaging for the specified phone number.
    - OutboundSMS (boolean) --
      
      Allows or denies outbound SMS messaging for the specified phone number.
    - InboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
    - OutboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
  - Associations (list) --
    
    The phone number's associations.
    - (dict) --
      
      The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - Value (string) --
        
        Contains the ID for the entity specified in Name.
      - Name (string) --
        
        Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - AssociatedTimestamp (datetime) --
        
        The timestamp of the phone number association, in ISO 8601 format.
  - CallingName (string) --
    
    The outbound calling name associated with the phone number.
  - CallingNameStatus (string) --
    
    The outbound calling name status.
  - CreatedTimestamp (datetime) --
    
    The phone number creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated phone number timestamp, in ISO 8601 format.
  - DeletionTimestamp (datetime) --
    
    The deleted phone number timestamp, in ISO 8601 format.
  - OrderId (string) --
    
    The phone number's order ID.
  - Name (string) --
    
    The name of the phone number.

ListPhoneNumbers (updated)

Link ¶
Changes (response)

{'PhoneNumbers': {'Name': 'string'}}

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

client.list_phone_numbers(
    Status='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    FilterName='VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)

type Status:

string

param Status:

The status of your organization's phone numbers.

type ProductType:

string

param ProductType:

The phone number product types.

type FilterName:

string

param FilterName:

The filter to limit the number of results.

type FilterValue:

string

param FilterValue:

The filter value.

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

The token used to return the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            'Country': 'string',
            'Type': 'Local'|'TollFree',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
            'Capabilities': {
                'InboundCall': True|False,
                'OutboundCall': True|False,
                'InboundSMS': True|False,
                'OutboundSMS': True|False,
                'InboundMMS': True|False,
                'OutboundMMS': True|False
            },
            'Associations': [
                {
                    'Value': 'string',
                    'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            'CallingName': 'string',
            'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'DeletionTimestamp': datetime(2015, 1, 1),
            'OrderId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PhoneNumbers (list) --
  
  The phone number details.
  - (dict) --
    
    A phone number used to call an Amazon Chime SDK Voice Connector.
    - PhoneNumberId (string) --
      
      The phone number's ID.
    - E164PhoneNumber (string) --
      
      The phone number, in E.164 format.
    - Country (string) --
      
      The phone number's country. Format: ISO 3166-1 alpha-2.
    - Type (string) --
      
      The phone number's type.
    - ProductType (string) --
      
      The phone number's product type.
    - Status (string) --
      
      The phone number's status.
    - Capabilities (dict) --
      
      The phone number's capabilities.
      - InboundCall (boolean) --
        
        Allows or denies inbound calling for the specified phone number.
      - OutboundCall (boolean) --
        
        Allows or denies outbound calling for the specified phone number.
      - InboundSMS (boolean) --
        
        Allows or denies inbound SMS messaging for the specified phone number.
      - OutboundSMS (boolean) --
        
        Allows or denies outbound SMS messaging for the specified phone number.
      - InboundMMS (boolean) --
        
        Allows or denies inbound MMS messaging for the specified phone number.
      - OutboundMMS (boolean) --
        
        Allows or denies inbound MMS messaging for the specified phone number.
    - Associations (list) --
      
      The phone number's associations.
      - (dict) --
        
        The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
        
        Value (string) --
        
        Contains the ID for the entity specified in Name.
        
        Name (string) --
        
        Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
        
        AssociatedTimestamp (datetime) --
        
        The timestamp of the phone number association, in ISO 8601 format.
    - CallingName (string) --
      
      The outbound calling name associated with the phone number.
    - CallingNameStatus (string) --
      
      The outbound calling name status.
    - CreatedTimestamp (datetime) --
      
      The phone number creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) --
      
      The updated phone number timestamp, in ISO 8601 format.
    - DeletionTimestamp (datetime) --
      
      The deleted phone number timestamp, in ISO 8601 format.
    - OrderId (string) --
      
      The phone number's order ID.
    - Name (string) --
      
      The name of the phone number.
- NextToken (string) --
  
  The token used to return the next page of results.

RestorePhoneNumber (updated)

Link ¶
Changes (response)

{'PhoneNumber': {'Name': 'string'}}

Restores a deleted phone number.

See also: AWS API Documentation

Request Syntax

client.restore_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The ID of the phone number being restored.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string',
        'Name': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  
  The restored phone number.
  - PhoneNumberId (string) --
    
    The phone number's ID.
  - E164PhoneNumber (string) --
    
    The phone number, in E.164 format.
  - Country (string) --
    
    The phone number's country. Format: ISO 3166-1 alpha-2.
  - Type (string) --
    
    The phone number's type.
  - ProductType (string) --
    
    The phone number's product type.
  - Status (string) --
    
    The phone number's status.
  - Capabilities (dict) --
    
    The phone number's capabilities.
    - InboundCall (boolean) --
      
      Allows or denies inbound calling for the specified phone number.
    - OutboundCall (boolean) --
      
      Allows or denies outbound calling for the specified phone number.
    - InboundSMS (boolean) --
      
      Allows or denies inbound SMS messaging for the specified phone number.
    - OutboundSMS (boolean) --
      
      Allows or denies outbound SMS messaging for the specified phone number.
    - InboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
    - OutboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
  - Associations (list) --
    
    The phone number's associations.
    - (dict) --
      
      The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - Value (string) --
        
        Contains the ID for the entity specified in Name.
      - Name (string) --
        
        Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - AssociatedTimestamp (datetime) --
        
        The timestamp of the phone number association, in ISO 8601 format.
  - CallingName (string) --
    
    The outbound calling name associated with the phone number.
  - CallingNameStatus (string) --
    
    The outbound calling name status.
  - CreatedTimestamp (datetime) --
    
    The phone number creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated phone number timestamp, in ISO 8601 format.
  - DeletionTimestamp (datetime) --
    
    The deleted phone number timestamp, in ISO 8601 format.
  - OrderId (string) --
    
    The phone number's order ID.
  - Name (string) --
    
    The name of the phone number.

UpdatePhoneNumber (updated)

Link ¶
Changes (request, response)
Request

{'Name': 'string'}

Response

{'PhoneNumber': {'Name': 'string'}}

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

See also: AWS API Documentation

Request Syntax

client.update_phone_number(
    PhoneNumberId='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    CallingName='string',
    Name='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number ID.

type ProductType:

string

param ProductType:

The product type.

type CallingName:

string

param CallingName:

The outbound calling name associated with the phone number.

type Name:

string

param Name:

Specifies the name assigned to one or more phone numbers.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string',
        'Name': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  
  The updated phone number details.
  - PhoneNumberId (string) --
    
    The phone number's ID.
  - E164PhoneNumber (string) --
    
    The phone number, in E.164 format.
  - Country (string) --
    
    The phone number's country. Format: ISO 3166-1 alpha-2.
  - Type (string) --
    
    The phone number's type.
  - ProductType (string) --
    
    The phone number's product type.
  - Status (string) --
    
    The phone number's status.
  - Capabilities (dict) --
    
    The phone number's capabilities.
    - InboundCall (boolean) --
      
      Allows or denies inbound calling for the specified phone number.
    - OutboundCall (boolean) --
      
      Allows or denies outbound calling for the specified phone number.
    - InboundSMS (boolean) --
      
      Allows or denies inbound SMS messaging for the specified phone number.
    - OutboundSMS (boolean) --
      
      Allows or denies outbound SMS messaging for the specified phone number.
    - InboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
    - OutboundMMS (boolean) --
      
      Allows or denies inbound MMS messaging for the specified phone number.
  - Associations (list) --
    
    The phone number's associations.
    - (dict) --
      
      The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - Value (string) --
        
        Contains the ID for the entity specified in Name.
      - Name (string) --
        
        Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
      - AssociatedTimestamp (datetime) --
        
        The timestamp of the phone number association, in ISO 8601 format.
  - CallingName (string) --
    
    The outbound calling name associated with the phone number.
  - CallingNameStatus (string) --
    
    The outbound calling name status.
  - CreatedTimestamp (datetime) --
    
    The phone number creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated phone number timestamp, in ISO 8601 format.
  - DeletionTimestamp (datetime) --
    
    The deleted phone number timestamp, in ISO 8601 format.
  - OrderId (string) --
    
    The phone number's order ID.
  - Name (string) --
    
    The name of the phone number.