Chime / Client / get_voice_connector_termination

get_voice_connector_termination#

Chime.Client.get_voice_connector_termination(**kwargs)#

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

Request Syntax

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

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) –
- Termination (dict) –
  
  The termination setting details.
  - CpsLimit (integer) –
    
    The limit on calls per second. Max value based on account service quota. Default value of 1.
  - DefaultPhoneNumber (string) –
    
    The default caller ID phone number.
  - CallingRegions (list) –
    
    The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
    - (string) –
  - CidrAllowedList (list) –
    
    The IP addresses allowed to make calls, in CIDR format. Required.
    - (string) –
  - Disabled (boolean) –
    
    When termination settings are disabled, outbound calls can not be made.

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