CreateVoiceConnectorGroup - Amazon Chime SDK


Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Request Syntax

POST /voice-connector-groups HTTP/1.1 Content-type: application/json { "Name": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The name of the Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9 _.-]+

Required: Yes


Lists the Voice Connectors that inbound calls are routed to.

Type: Array of VoiceConnectorItem objects

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "VoiceConnectorGroup": { "CreatedTimestamp": "string", "Name": "string", "UpdatedTimestamp": "string", "VoiceConnectorGroupArn": "string", "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "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.


The details of the Voice Connector group.

Type: VoiceConnectorGroup object


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


You don't have the permissions needed to run this action.

HTTP Status Code: 403


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The request exceeds the resource limit.

HTTP Status Code: 400


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429


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: