ChimeSDKVoice / Client / get_voice_connector_termination

get_voice_connector_termination#

ChimeSDKVoice.Client.get_voice_connector_termination(**kwargs)#

Retrieves the termination setting details for the specified Voice Connector.

Request Syntax

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

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The 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 outbound calling 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.
    - (string) –
  - Disabled (boolean) –
    
    When termination is disabled, outbound calls cannot be made.

Exceptions

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