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

PutVoiceConnectorProxy

Puts the specified proxy configuration to the specified Amazon Chime SDK 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 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 session.

Type: Integer

Required: Yes

Disabled

When true, stops proxy sessions from being created on the specified Amazon Chime SDK 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 the permissions needed to run this action.

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.

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