ChimeSDKVoice / Client / list_proxy_sessions
list_proxy_sessions#
- ChimeSDKVoice.Client.list_proxy_sessions(**kwargs)#
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.list_proxy_sessions( VoiceConnectorId='string', Status='Open'|'InProgress'|'Closed', NextToken='string', MaxResults=123 )
- Parameters:
VoiceConnectorId (string) –
[REQUIRED]
The Voice Connector ID.
Status (string) – The proxy session status.
NextToken (string) – The token used to retrieve the next page of results.
MaxResults (integer) – The maximum number of results to return in a single call.
- Return type:
dict
- Returns:
Response Syntax
{ 'ProxySessions': [ { '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' } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
ProxySessions (list) –
The proxy sessions’ details.
(dict) –
The proxy session for an Amazon Chime SDK Voice Connector.
VoiceConnectorId (string) –
The Voice Connector ID.
ProxySessionId (string) –
The proxy session ID.
Name (string) –
The proxy session name.
Status (string) –
The proxy session status.
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 SDK 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.
NextToken (string) –
The token used to retrieve the next page of results.
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