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

CreateVoiceConnector

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnector:RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


POST /voice-connectors HTTP/1.1
Content-type: application/json

{
   "AwsRegion": "string",
   "Name": "string",
   "RequireEncryption": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AwsRegion

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

Type: String

Valid Values: us-east-1 | us-west-2

Required: No

Name

The name of the Amazon Chime Voice Connector.

Type: String

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

Required: Yes

RequireEncryption

When enabled, requires encryption for the Amazon Chime Voice Connector.

Type: Boolean

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "VoiceConnector": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Name": "string",
      "OutboundHostName": "string",
      "RequireEncryption": boolean,
      "UpdatedTimestamp": "string",
      "VoiceConnectorArn": "string",
      "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.

VoiceConnector

The Amazon Chime Voice Connector details.

Type: VoiceConnector 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.

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

Examples

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.

Sample Request


POST /voice-connectors 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: 20190918T203400Z Authorization: AUTHPARAMS Content-Length: 82 {"Name": "newVoiceConnector", "AwsRegion": "us-west-2", "RequireEncryption": true}

Sample Response


HTTP/1.1 201 Created x-amzn-RequestId: 3f08f447-316c-45a8-b3ad-12dec6231828 Content-Type: application/json Content-Length: 301 Date: Wed, 18 Sep 2019 20:34:01 GMT Connection: keep-alive {"Voice Connector":{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:34:01.352Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}