create_proxy_session

create_proxy_session(**kwargs)

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]
• ParticipantPhoneNumbers (list) --

  [REQUIRED]

  • (string) --
• Name (string) --
• ExpiryMinutes (integer) --
• Capabilities (list) --

  [REQUIRED]

  • (string) --
• NumberSelectionBehavior (string) --
• GeoMatchLevel (string) --
• GeoMatchParams (dict) --
  • Country (string) -- [REQUIRED]
  • AreaCode (string) -- [REQUIRED]

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) --
    • VoiceConnectorId (string) --
    • ProxySessionId (string) --
    • Name (string) --
    • Status (string) --
    • ExpiryMinutes (integer) --
    • Capabilities (list) --
      • (string) --
    • CreatedTimestamp (datetime) --
    • UpdatedTimestamp (datetime) --
    • EndedTimestamp (datetime) --
    • Participants (list) --
      • (dict) --
        • PhoneNumber (string) --
        • ProxyPhoneNumber (string) --
    • NumberSelectionBehavior (string) --
    • GeoMatchLevel (string) --
    • GeoMatchParams (dict) --
      • Country (string) --
      • AreaCode (string) --

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