Chime / Client / get_voice_connector_origination

get_voice_connector_origination#

Chime.Client.get_voice_connector_origination(**kwargs)#

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.get_voice_connector_origination(
    VoiceConnectorId='string'
)

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) –
- Origination (dict) –
  
  The origination setting details.
  - Routes (list) –
    
    The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.
    - (dict) –
      
      Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
      
      Note
      The parameters listed below are not required, but you must use at least one.
      - Host (string) –
        
        The FQDN or IP address to contact for origination traffic.
      - Port (integer) –
        
        The designated origination route port. Defaults to 5060.
      - Protocol (string) –
        
        The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
      - Priority (integer) –
        
        The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
      - Weight (integer) –
        
        The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
  - Disabled (boolean) –
    
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

Exceptions

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