Amazon Chime
API Reference (API Version 2018-05-01)

The AWS Documentation website is getting a new look!



Creates an Amazon Chime Voice Connector under the administrator's AWS account. 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.

Request Syntax

POST /voice-connectors HTTP/1.1 Content-type: application/json { "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.


The name of the Amazon Chime Voice Connector.

Type: String


Required: Yes


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": { "CreatedTimestamp": number, "Name": "string", "OutboundHostName": "string", "RequireEncryption": boolean, "UpdatedTimestamp": number, "VoiceConnectorId": "string" } }

Response Elements


The following data is returned in JSON format by the service.


The Amazon Chime Voice Connector details.

Type: VoiceConnector object




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

HTTP Status Code: 400



HTTP Status Code: 403


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
