PUT

/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy

http://service.chime.aws.amazon.com/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy

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

Access Token Required: API Key

Path Parameters

voiceConnectorIdstringrequired

The Amazon Chime voice connector ID.

Body Params

Disabledboolean

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

FallBackPhoneNumberstring

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

PhoneNumberPoolCountriesarrayrequired

The countries for proxy phone numbers to be selected from.

DefaultSessionExpiryMinutesintegerrequired

The default number of minutes allowed for proxy sessions.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://service.chime.aws.amazon.com/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}