AWS API Changes

2024/12/02 - Amazon Chime SDK Voice - 3 new4 updated api methods

Changes This release adds supports for enterprises to integrate Amazon Connect with other voice systems. It supports directly transferring voice calls and metadata without using the public telephone network. It also supports real-time and post-call analytics.

GetVoiceConnectorExternalSystemsConfiguration (new)

Link ¶

Gets information about an external systems configuration for a Voice Connector.

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_external_systems_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The ID of the Voice Connector for which to return information about the external system configuration.

rtype:

dict

returns:

Response Syntax

{
    'ExternalSystemsConfiguration': {
        'SessionBorderControllerTypes': [
            'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC',
        ],
        'ContactCenterSystemTypes': [
            'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE',
        ]
    }
}

Response Structure

(dict) --
- ExternalSystemsConfiguration (dict) --
  
  An object that contains information about an external systems configuration for a Voice Connector.
  - SessionBorderControllerTypes (list) --
    
    The session border controllers.
    - (string) --
  - ContactCenterSystemTypes (list) --
    
    The contact center system.
    - (string) --

PutVoiceConnectorExternalSystemsConfiguration (new)

Link ¶

Adds an external systems configuration to a Voice Connector.

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_external_systems_configuration(
    VoiceConnectorId='string',
    SessionBorderControllerTypes=[
        'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC',
    ],
    ContactCenterSystemTypes=[
        'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE',
    ]
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The ID of the Voice Connector for which to add the external system configuration.

type SessionBorderControllerTypes:

list

param SessionBorderControllerTypes:

The session border controllers to use.

(string) --

type ContactCenterSystemTypes:

list

param ContactCenterSystemTypes:

The contact center system to use.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ExternalSystemsConfiguration': {
        'SessionBorderControllerTypes': [
            'RIBBON_SBC'|'ORACLE_ACME_PACKET_SBC'|'AVAYA_SBCE'|'CISCO_UNIFIED_BORDER_ELEMENT'|'AUDIOCODES_MEDIANT_SBC',
        ],
        'ContactCenterSystemTypes': [
            'GENESYS_ENGAGE_ON_PREMISES'|'AVAYA_AURA_CALL_CENTER_ELITE'|'AVAYA_AURA_CONTACT_CENTER'|'CISCO_UNIFIED_CONTACT_CENTER_ENTERPRISE',
        ]
    }
}

Response Structure

(dict) --
- ExternalSystemsConfiguration (dict) --
  
  An object that contains information about an external systems configuration for a Voice Connector.
  - SessionBorderControllerTypes (list) --
    
    The session border controllers.
    - (string) --
  - ContactCenterSystemTypes (list) --
    
    The contact center system.
    - (string) --

DeleteVoiceConnectorExternalSystemsConfiguration (new)

Link ¶

Deletes the external systems configuration for a Voice Connector.

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_external_systems_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The ID of the Voice Connector for which to delete the external system configuration.

returns:

None

CreateVoiceConnector (updated)

Link ¶
Changes (request, response)
Request

{'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR | '
                    'CONNECT_ANALYTICS_CONNECTOR'}

Response

{'VoiceConnector': {'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR | '
                                       'CONNECT_ANALYTICS_CONNECTOR'}}

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

See also: AWS API Documentation

Request Syntax

client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    RequireEncryption=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IntegrationType='CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
)

type Name:

string

param Name:

[REQUIRED]

The name of the Voice Connector.

type AwsRegion:

string

param AwsRegion:

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

type RequireEncryption:

boolean

param RequireEncryption:

[REQUIRED]

Enables or disables encryption for the Voice Connector.

type Tags:

list

param Tags:

The tags assigned to the Voice Connector.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

type IntegrationType:

string

param IntegrationType:

The connectors for use with Amazon Connect.

The following options are available:

CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.
CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string',
        'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The details of the Voice Connector.
  - VoiceConnectorId (string) --
    
    The Voice Connector's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Voice Connector is created. Default: us-east-1.
  - Name (string) --
    
    The Voice Connector's name.
  - OutboundHostName (string) --
    
    The outbound host name for the Voice Connector.
  - RequireEncryption (boolean) --
    
    Enables or disables encryption for the Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Voice Connector's creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The Voice Connector's updated timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the Voice Connector.
  - IntegrationType (string) --
    
    The connectors for use with Amazon Connect.

GetVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR | '
                                       'CONNECT_ANALYTICS_CONNECTOR'}}

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

See also: AWS API Documentation

Request Syntax

client.get_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Voice Connector ID.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string',
        'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The Voice Connector details.
  - VoiceConnectorId (string) --
    
    The Voice Connector's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Voice Connector is created. Default: us-east-1.
  - Name (string) --
    
    The Voice Connector's name.
  - OutboundHostName (string) --
    
    The outbound host name for the Voice Connector.
  - RequireEncryption (boolean) --
    
    Enables or disables encryption for the Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Voice Connector's creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The Voice Connector's updated timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the Voice Connector.
  - IntegrationType (string) --
    
    The connectors for use with Amazon Connect.

ListVoiceConnectors (updated)

Link ¶
Changes (response)

{'VoiceConnectors': {'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR | '
                                        'CONNECT_ANALYTICS_CONNECTOR'}}

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

See also: AWS API Documentation

Request Syntax

client.list_voice_connectors(
    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

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorArn': 'string',
            'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceConnectors (list) --
  
  The details of the Voice Connectors.
  - (dict) --
    
    The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.
    - VoiceConnectorId (string) --
      
      The Voice Connector's ID.
    - AwsRegion (string) --
      
      The AWS Region in which the Voice Connector is created. Default: us-east-1.
    - Name (string) --
      
      The Voice Connector's name.
    - OutboundHostName (string) --
      
      The outbound host name for the Voice Connector.
    - RequireEncryption (boolean) --
      
      Enables or disables encryption for the Voice Connector.
    - CreatedTimestamp (datetime) --
      
      The Voice Connector's creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) --
      
      The Voice Connector's updated timestamp, in ISO 8601 format.
    - VoiceConnectorArn (string) --
      
      The ARN of the Voice Connector.
    - IntegrationType (string) --
      
      The connectors for use with Amazon Connect.
- NextToken (string) --
  
  The token used to return the next page of results.

UpdateVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR | '
                                       'CONNECT_ANALYTICS_CONNECTOR'}}

Updates the details for the specified Amazon Chime SDK Voice Connector.

See also: AWS API Documentation

Request Syntax

client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Voice Connector ID.

type Name:

string

param Name:

[REQUIRED]

The name of the Voice Connector.

type RequireEncryption:

boolean

param RequireEncryption:

[REQUIRED]

When enabled, requires encryption for the Voice Connector.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string',
        'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The updated Voice Connector details.
  - VoiceConnectorId (string) --
    
    The Voice Connector's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Voice Connector is created. Default: us-east-1.
  - Name (string) --
    
    The Voice Connector's name.
  - OutboundHostName (string) --
    
    The outbound host name for the Voice Connector.
  - RequireEncryption (boolean) --
    
    Enables or disables encryption for the Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Voice Connector's creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The Voice Connector's updated timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the Voice Connector.
  - IntegrationType (string) --
    
    The connectors for use with Amazon Connect.