The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
UpdateProxySession
Updates the specified proxy session details, such as voice or SMS capabilities.
Important
This API is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 Amazon Chime 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 | SMS
Required: 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 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
-
One or more of the resources in the request does not exist in the system.
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 client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
Examples
In the following example or examples, the Authorization header contents(
AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see
Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When
you use the AWS Command Line Interface (AWS
CLI)
Example
This example updates the proxy session capabilities.
Sample Request
POST /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-h4ghjk56789l HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T161517Z Authorization: AUTHPARAMS Content-Length: 27 {"Capabilities": ["Voice"]}
Sample Response
HTTP/1.1 201 Created x-amzn-RequestId: 3fea90c8-0c57-42cd-80ed-a628704eef17 Content-Type: application/json Content-Length: 525 Date: Wed, 15 Apr 2020 16:15:17 GMT Connection: keep-alive {"ProxySession":{"Capabilities":["Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMatchLevel":null,"GeoMatchParams":null,"Name":null,"NumberSelectionBehavior":null,"Participants":[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-2f3g-h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:15:17.560Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: