PutVoiceConnectorProxy - Amazon Chime

PutVoiceConnectorProxy

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Request Syntax

PUT /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1 Content-type: application/json { "DefaultSessionExpiryMinutes": number, "Disabled": boolean, "FallBackPhoneNumber": "string", "PhoneNumberPoolCountries": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

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.

DefaultSessionExpiryMinutes

The default number of minutes allowed for proxy sessions.

Type: Integer

Required: Yes

Disabled

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

Type: Boolean

Required: No

FallBackPhoneNumber

The phone number to route calls to after a proxy session expires.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No

PhoneNumberPoolCountries

The countries for proxy phone numbers to be selected from.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^$|^[A-Z]{2,2}$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Proxy": { "DefaultSessionExpiryMinutes": number, "Disabled": boolean, "FallBackPhoneNumber": "string", "PhoneNumberCountries": [ "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.

Proxy

The proxy configuration details.

Type: Proxy object

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

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. For example, when a user tries to create an account from an unsupported Region.

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

Example

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) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example puts a proxy configuration to your Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy 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: 20200415T160418Z Authorization: AUTHPARAMS Content-Length: 71 {"DefaultSessionExpiryMinutes": 60, "PhoneNumberPoolCountries": ["US"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 9f80051f-62b3-43d5-9630-bc28c098255b Content-Type: application/json Content-Length: 118 Date: Wed, 15 Apr 2020 16:04:19 GMT Connection: keep-alive {"Proxy":{"DefaultSessionExpiryMinutes":60,"Disabled":false,"FallBackPhoneNumber":null,"PhoneNumberCountries":["US"]}}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: