get_voice_connector_proxy

Chime.Client.get_voice_connector_proxy(**kwargs)

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

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

Parameters

VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime voice connector ID.

Return type

dict

Returns

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

• (dict) --
  • Proxy (dict) --

    The proxy configuration details.

    • DefaultSessionExpiryMinutes (integer) --

      The default number of minutes allowed for proxy sessions.

    • Disabled (boolean) --

      When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

    • FallBackPhoneNumber (string) --

      The phone number to route calls to after a proxy session expires.

    • PhoneNumberCountries (list) --

      The countries for proxy phone numbers to be selected from.

      • (string) --

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