Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListProxySessions

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

Request Syntax


GET /voice-connectors/voiceConnectorId/proxy-sessions?max-results=MaxResults&next-token=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token used to retrieve the next page of results.

Length Constraints: Maximum length of 65535.

Status

The proxy session status.

Valid Values: Open | InProgress | Closed

voiceConnectorId

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProxySessions": [ 
      { 
         "Capabilities": [ "string" ],
         "CreatedTimestamp": "string",
         "EndedTimestamp": "string",
         "ExpiryMinutes": number,
         "GeoMatchLevel": "string",
         "GeoMatchParams": { 
            "AreaCode": "string",
            "Country": "string"
         },
         "Name": "string",
         "NumberSelectionBehavior": "string",
         "Participants": [ 
            { 
               "PhoneNumber": "string",
               "ProxyPhoneNumber": "string"
            }
         ],
         "ProxySessionId": "string",
         "Status": "string",
         "UpdatedTimestamp": "string",
         "VoiceConnectorId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token used to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

ProxySessions

The proxy sessions' details.

Type: Array of ProxySession objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401