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

CreateVoiceConnector

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

Request Syntax


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

{
   "AwsRegion": "string",
   "IntegrationType": "string",
   "Name": "string",
   "RequireEncryption": boolean,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

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 SDK Voice Connector is created. Default value: us-east-1 .

Type: String

Required: No

IntegrationType

The connectors for use with Amazon Connect.

The following options are available:

CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.
CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.

Type: String

Valid Values: CONNECT_CALL_TRANSFER_CONNECTOR | CONNECT_ANALYTICS_CONNECTOR

Required: No

Name

The name of the Voice Connector.

Type: String

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

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

Required: Yes

RequireEncryption

Enables or disables encryption for the Voice Connector.

Type: Boolean

Required: Yes

Tags

The tags assigned to the Voice Connector.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "VoiceConnector": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "IntegrationType": "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 details of the Voice Connector.

Type: VoiceConnector object

Errors

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

AccessDeniedException

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

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 number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401