Chime / Client / create_proxy_session

create_proxy_session

Chime.Client.create_proxy_session(**kwargs)

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

See also: AWS API Documentation

Request Syntax

response = client.create_proxy_session(
    VoiceConnectorId='string',
    ParticipantPhoneNumbers=[
        'string',
    ],
    Name='string',
    ExpiryMinutes=123,
    Capabilities=[
        'Voice'|'SMS',
    ],
    NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
    GeoMatchLevel='Country'|'AreaCode',
    GeoMatchParams={
        'Country': 'string',
        'AreaCode': 'string'
    }
)

Parameters:

• VoiceConnectorId (string) –

  [REQUIRED]

  The Amazon Chime voice connector ID.

• ParticipantPhoneNumbers (list) –

  [REQUIRED]

  The participant phone numbers.

  • (string) –

• Name (string) – The name of the proxy session.

• ExpiryMinutes (integer) – The number of minutes allowed for the proxy session.

• Capabilities (list) –

  [REQUIRED]

  The proxy session capabilities.

  • (string) –

• NumberSelectionBehavior (string) – The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

• GeoMatchLevel (string) – The preference for matching the country or area code of the proxy phone number with that of the first participant.

• GeoMatchParams (dict) –

  The country and area code for the proxy phone number.

  • Country (string) – [REQUIRED]

    The country.

  • AreaCode (string) – [REQUIRED]

    The area code.

Return type:

dict

Returns:

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

• (dict) –

  • ProxySession (dict) –

    The proxy session details.

    • VoiceConnectorId (string) –

      The Amazon Chime voice connector ID.

    • ProxySessionId (string) –

      The proxy session ID.

    • Name (string) –

      The name of the proxy session.

    • Status (string) –

      The status of the proxy session.

    • ExpiryMinutes (integer) –

      The number of minutes allowed for the proxy session.

    • Capabilities (list) –

      The proxy session capabilities.

      • (string) –

    • CreatedTimestamp (datetime) –

      The created time stamp, in ISO 8601 format.

    • UpdatedTimestamp (datetime) –

      The updated time stamp, in ISO 8601 format.

    • EndedTimestamp (datetime) –

      The ended time stamp, in ISO 8601 format.

    • Participants (list) –

      The proxy session participants.

      • (dict) –

        The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

        • PhoneNumber (string) –

          The participant’s phone number.

        • ProxyPhoneNumber (string) –

          The participant’s proxy phone number.

    • NumberSelectionBehavior (string) –

      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

    • GeoMatchLevel (string) –

      The preference for matching the country or area code of the proxy phone number with that of the first participant.

    • GeoMatchParams (dict) –

      The country and area code for the proxy phone number.

      • Country (string) –

        The country.

      • AreaCode (string) –

        The area code.

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