Chime / Client / put_voice_connector_proxy

put_voice_connector_proxy#

Chime.Client.put_voice_connector_proxy(**kwargs)#

Puts the specified proxy configuration to 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, PutVoiceConnectorProxy, 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.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_proxy(
    VoiceConnectorId='string',
    DefaultSessionExpiryMinutes=123,
    PhoneNumberPoolCountries=[
        'string',
    ],
    FallBackPhoneNumber='string',
    Disabled=True|False
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • DefaultSessionExpiryMinutes (integer) –

    [REQUIRED]

    The default number of minutes allowed for proxy sessions.

  • PhoneNumberPoolCountries (list) –

    [REQUIRED]

    The countries for proxy phone numbers to be selected from.

    • (string) –

  • FallBackPhoneNumber (string) – The phone number to route calls to after a proxy session expires.

  • Disabled (boolean) – When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

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