Amazon Chime SDK Voice

2026/07/16 - Amazon Chime SDK Voice - 14 updated api methods

Changes  Marked CreateProxySession, DeleteProxySession, GetProxySession, ListProxySessions, UpdateProxySession, PutVoiceConnectorProxy, DeleteVoiceConnectorProxy, and GetVoiceConnectorProxy as deprecated.

AssociatePhoneNumbersWithVoiceConnector (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

See also: AWS API Documentation

Request Syntax

client.associate_phone_numbers_with_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)
type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Voice Connector ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

List of phone numbers, in E.164 format.

  • (string) --

type ForceAssociate:

boolean

param ForceAssociate:

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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'|'Validation',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and 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.

AssociatePhoneNumbersWithVoiceConnectorGroup (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

client.associate_phone_numbers_with_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)
type VoiceConnectorGroupId:

string

param VoiceConnectorGroupId:

[REQUIRED]

The Amazon Chime SDK Voice Connector group ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

List of phone numbers, in E.164 format.

  • (string) --

type ForceAssociate:

boolean

param ForceAssociate:

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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'|'Validation',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and 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.

BatchDeletePhoneNumber (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

See also: AWS API Documentation

Request Syntax

client.batch_delete_phone_number(
    PhoneNumberIds=[
        'string',
    ]
)
type PhoneNumberIds:

list

param PhoneNumberIds:

[REQUIRED]

List of phone number IDs.

  • (string) --

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'|'Validation',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and 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.

BatchUpdatePhoneNumber (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

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'|'Validation',
            '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.

CreateVoiceConnectorGroup (updated) Link ¶
Changes (request, response)
Request 
{'CallDistributionType': 'PriorityWeightedDistribution | '
                         'LoadBalancedDistribution'}
Response 
{'VoiceConnectorGroup': {'CallDistributionType': 'PriorityWeightedDistribution '
                                                 '| LoadBalancedDistribution'}}

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

See also: AWS API Documentation

Request Syntax

client.create_voice_connector_group(
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ],
    CallDistributionType='PriorityWeightedDistribution'|'LoadBalancedDistribution'
)
type Name:

string

param Name:

[REQUIRED]

The name of the Voice Connector group.

type VoiceConnectorItems:

list

param VoiceConnectorItems:

Lists the Voice Connectors that inbound calls are routed to.

  • (dict) --

    For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

    • VoiceConnectorId (string) -- [REQUIRED]

      The Voice Connector ID.

    • Priority (integer) --

      The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

type CallDistributionType:

string

param CallDistributionType:

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string',
        'CallDistributionType': 'PriorityWeightedDistribution'|'LoadBalancedDistribution'
    }
}

Response Structure

  • (dict) --

    • VoiceConnectorGroup (dict) --

      The details of the Voice Connector group.

      • VoiceConnectorGroupId (string) --

        The ID of a Voice Connector group.

      • Name (string) --

        The name of a Voice Connector group.

      • VoiceConnectorItems (list) --

        The Voice Connectors to which you route inbound calls.

        • (dict) --

          For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

          • VoiceConnectorId (string) --

            The Voice Connector ID.

          • Priority (integer) --

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

      • CreatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • VoiceConnectorGroupArn (string) --

        The ARN of the Voice Connector group.

      • CallDistributionType (string) --

DisassociatePhoneNumbersFromVoiceConnector (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ]
)
type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Voice Connector ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

List of phone numbers, in E.164 format.

  • (string) --

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'|'Validation',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and 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.

DisassociatePhoneNumbersFromVoiceConnectorGroup (updated) Link ¶
Changes (response) 
{'PhoneNumberErrors': {'ErrorCode': {'Validation'}}}

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ]
)
type VoiceConnectorGroupId:

string

param VoiceConnectorGroupId:

[REQUIRED]

The Voice Connector group ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

The list of phone numbers, in E.164 format.

  • (string) --

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'|'Validation',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and 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.

GetPhoneNumber (updated) Link ¶
Changes (response) 
{'PhoneNumber': {'PhoneNumberArn': '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',
        'PhoneNumberArn': '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.

      • PhoneNumberArn (string) --

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

GetVoiceConnectorGroup (updated) Link ¶
Changes (response) 
{'VoiceConnectorGroup': {'CallDistributionType': 'PriorityWeightedDistribution '
                                                 '| LoadBalancedDistribution'}}

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)
type VoiceConnectorGroupId:

string

param VoiceConnectorGroupId:

[REQUIRED]

The Voice Connector group ID.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string',
        'CallDistributionType': 'PriorityWeightedDistribution'|'LoadBalancedDistribution'
    }
}

Response Structure

  • (dict) --

    • VoiceConnectorGroup (dict) --

      The details of the Voice Connector group.

      • VoiceConnectorGroupId (string) --

        The ID of a Voice Connector group.

      • Name (string) --

        The name of a Voice Connector group.

      • VoiceConnectorItems (list) --

        The Voice Connectors to which you route inbound calls.

        • (dict) --

          For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

          • VoiceConnectorId (string) --

            The Voice Connector ID.

          • Priority (integer) --

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

      • CreatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • VoiceConnectorGroupArn (string) --

        The ARN of the Voice Connector group.

      • CallDistributionType (string) --

ListPhoneNumbers (updated) Link ¶
Changes (response) 
{'PhoneNumbers': {'PhoneNumberArn': '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',
            'PhoneNumberArn': '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.

        • PhoneNumberArn (string) --

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

ListVoiceConnectorGroups (updated) Link ¶
Changes (response) 
{'VoiceConnectorGroups': {'CallDistributionType': 'PriorityWeightedDistribution '
                                                  '| LoadBalancedDistribution'}}

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)
type NextToken:

string

param NextToken:

The token used to return 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

{
    'VoiceConnectorGroups': [
        {
            'VoiceConnectorGroupId': 'string',
            'Name': 'string',
            'VoiceConnectorItems': [
                {
                    'VoiceConnectorId': 'string',
                    'Priority': 123
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorGroupArn': 'string',
            'CallDistributionType': 'PriorityWeightedDistribution'|'LoadBalancedDistribution'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VoiceConnectorGroups (list) --

      The details of the Voice Connector groups.

      • (dict) --

        The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

        • VoiceConnectorGroupId (string) --

          The ID of a Voice Connector group.

        • Name (string) --

          The name of a Voice Connector group.

        • VoiceConnectorItems (list) --

          The Voice Connectors to which you route inbound calls.

          • (dict) --

            For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

            • VoiceConnectorId (string) --

              The Voice Connector ID.

            • Priority (integer) --

              The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

        • CreatedTimestamp (datetime) --

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The Voice Connector group's creation time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn (string) --

          The ARN of the Voice Connector group.

        • CallDistributionType (string) --

    • NextToken (string) --

      The token used to return the next page of results.

RestorePhoneNumber (updated) Link ¶
Changes (response) 
{'PhoneNumber': {'PhoneNumberArn': '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',
        'PhoneNumberArn': '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.

      • PhoneNumberArn (string) --

      • 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 (response) 
{'PhoneNumber': {'PhoneNumberArn': 'string'}}

Updates phone number details, such as product type, calling name, or phone number 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, calling name, or phone number 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 updated name assigned to one or more phone numbers.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'PhoneNumberArn': '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.

      • PhoneNumberArn (string) --

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

UpdateVoiceConnectorGroup (updated) Link ¶
Changes (request, response)
Request 
{'CallDistributionType': 'PriorityWeightedDistribution | '
                         'LoadBalancedDistribution'}
Response 
{'VoiceConnectorGroup': {'CallDistributionType': 'PriorityWeightedDistribution '
                                                 '| LoadBalancedDistribution'}}

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ],
    CallDistributionType='PriorityWeightedDistribution'|'LoadBalancedDistribution'
)
type VoiceConnectorGroupId:

string

param VoiceConnectorGroupId:

[REQUIRED]

The Voice Connector ID.

type Name:

string

param Name:

[REQUIRED]

The name of the Voice Connector group.

type VoiceConnectorItems:

list

param VoiceConnectorItems:

[REQUIRED]

The VoiceConnectorItems to associate with the Voice Connector group.

  • (dict) --

    For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

    • VoiceConnectorId (string) -- [REQUIRED]

      The Voice Connector ID.

    • Priority (integer) --

      The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

type CallDistributionType:

string

param CallDistributionType:

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string',
        'CallDistributionType': 'PriorityWeightedDistribution'|'LoadBalancedDistribution'
    }
}

Response Structure

  • (dict) --

    • VoiceConnectorGroup (dict) --

      The updated Voice Connector group.

      • VoiceConnectorGroupId (string) --

        The ID of a Voice Connector group.

      • Name (string) --

        The name of a Voice Connector group.

      • VoiceConnectorItems (list) --

        The Voice Connectors to which you route inbound calls.

        • (dict) --

          For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

          • VoiceConnectorId (string) --

            The Voice Connector ID.

          • Priority (integer) --

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

      • CreatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The Voice Connector group's creation time stamp, in ISO 8601 format.

      • VoiceConnectorGroupArn (string) --

        The ARN of the Voice Connector group.

      • CallDistributionType (string) --