UpdateProxySession
Updates the specified proxy session details, such as voice or SMS capabilities.
Request Syntax
POST /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
Content-type: application/json
{
"Capabilities": [ "string" ],
"ExpiryMinutes": number
}URI Request Parameters
The request uses the following URI parameters.
- proxySessionId
-
The proxy session ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
- voiceConnectorId
-
The Voice Connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
Request Body
The request accepts the following data in JSON format.
- Capabilities
-
The proxy session capabilities.
Type: Array of strings
Valid Values:
Voice | SMSRequired: Yes
- ExpiryMinutes
-
The number of minutes allowed for the proxy session.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"ProxySession": {
"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 201 response.
The following data is returned in JSON format by the service.
- ProxySession
-
The updated proxy session details.
Type: ProxySession object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
