Sign In to the Console
Amazon Chime
API Reference (API Version 2018-05-01)

AWS Documentation » Amazon Chime » API Reference » Actions » CreateVoiceConnectorGroup

CreateVoiceConnectorGroup

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

You can include Amazon Chime 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.

Name

The name of the Amazon Chime Voice Connector group.

Type: String

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

Required: Yes

VoiceConnectorItems

The Amazon Chime Voice Connectors to route inbound calls to.

Type: Array of VoiceConnectorItem objects

Required: No

Response Syntax

HTTP/1.1 201
Content-type: application/json

{
   "VoiceConnectorGroup": { 
      "CreatedTimestamp": number,
      "Name": "string",
      "UpdatedTimestamp": number,
      "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.

VoiceConnectorGroup

The Amazon Chime Voice Connector group details.

Type: VoiceConnectorGroup 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

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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 creates an Amazon Chime Voice Connector group.

Sample Request

POST /voice-connector-groups HTTP/1.1
Host: service.chime.aws.amazon.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20190918T163834Z
Authorization: AUTHPARAMS
Content-Length: 107

{"Name": "myGroup", "VoiceConnectorItems": [{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 2}]}

Sample Response

HTTP/1.1 201 Created
x-amzn-RequestId: bb6c861a-bfb6-42d2-9655-898780f6e7f8
Content-Type: application/json
Content-Length: 222
Date: Wed, 18 Sep 2019 16:38:33 GMT
Connection: keep-alive

{"VoiceConnectorGroup":{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34.734Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}}

See Also

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