Activate and configure a third-party TTS provider integration

AI-generated summary

Genesys Cloud's TTS Connector integration system enables organizations to connect with multiple third-party text-to-speech providers, supporting up to 10 connector instances. The platform delivers audio at PCM and 8kHz, accommodating providers like Acapela Cloud, Deepgram, ElevenLabs, Emotech, and ReadSpeaker. Each integration requires specific URI configurations for text synthesis and voice listing endpoints, along with proper authentication methods ranging from OAuth to API keys. Provider-specific configurations include essential attributes for text, voice, language, and output format settings, with Acapela Cloud using https://acapela-cloud.com/api endpoints, Deepgram utilizing api.deepgram.com/v1 endpoints, ElevenLabs implementing api.elevenlabs.io/v1 endpoints, Emotech employing speech-synthesis-dev.api.emotechlab.com/v2 endpoints, and ReadSpeaker using scapi-eu.readspeaker.com endpoints. The system supports various languages and voice options, including Arabic and English, with both male and female voices available. Advanced features include JSON formatting for voice and language mapping, custom output format configurations, and synthesis body parameters. Integration status must be changed from Inactive to Active after configuration, with all credentials and attributes properly set for the system to function.

Feature coming soon

You can configure the Genesys TTS Connector integration in Genesys Cloud to use your preferred third-party text-to-speech (TTS) provider. To integrate with a third-party TTS provider, you must set the integration properties, attributes, and credentials that are required to access their API endpoint.

Notes:

You can configure up to 10 Genesys TTS Connector integration instances for an organization.
TTS audio plays as PCM and 8kHz regardless of the formats the TTS provider supports.
Genesys TTS Connector does not support audio payload in the JSON body. It supports only audio streams.

Refer to the following sample configuration for each third-party TTS provider that Genesys Cloud currently supports:

Acapela CloudClick to expand

Open the Genesys TTS Connector integration:
- If you did not previously install the integration into your Genesys Cloud organization, install the Genesys TTS Connector now.
- If you installed the integration, follow these steps to open the integration:
  1. Click Admin.
  2. Under Integrations, click Integrations.
  3. Click Menu > IT and Integrations > Integrations.
  4. Search for and open the Genesys TTS Connector integration.
In the Details tab, Genesys highly recommends that you enter a unique name for the integration that you want to configure. For example, “Genesys TTS Connector – Acapela Cloud”.
On the Genesys TTS Connector – Acapela Cloud integration page, click the Configuration tab.

Under Properties, enter the following values:

Property name	Value
Synthesize Text URI	https://acapela-cloud.com/api/command/
List Voices URI	https://acapela-cloud.com/api/account/
Synthesize Text Request Method	get
Synthesize Text Attribute	text
Synthesize Voice Attribute	voice
Synthesize Language Attribute	language
Synthesize OutputFormat Attribute	type
Synthesize Sample Rate Attribute	samplerate
Voices Attribute	voices
Voice Name Attribute	name
Voice Language Attribute	language
Voice Gender Attribute	gender
Voice Type Attribute	type

Click the Advanced tab. Enter any additional configuration in the JSON format.
Use the following sample configuration for Acapela Cloud:

{
  "voiceMapping": {
    "languageMapping": {
      "en-AE": "arabicenglish",
      "en-AU": "australianenglish",
      "en-us": "USEnglish",
      "ar-001": "arabic"
    },
    "genderMapping": {
      "female": "1",
      "male": "2"
    }
  },
  "outputFormatMapping": {
    "audio/L16": {
      "*": "wav"
    },
    "audio/mpeg": {
      "*": "mp3"
    }
  }
}

Click the Credentials tab.
1. Click Configure. The Configure Credentials dialog box opens.
2. Select the credential type, User Defined (OAuth).
3. Click Add Credential Field, then add the following field names and values:
  Field name Value
  loginUrl https://www.acapela-cloud.com/api/login/
  email <Your email address>
  password <Your password>
4. Click OK.
Click Save.
To activate the Genesys TTS Connector integration, in the Status column click Inactive. The Change Status dialog box opens.
Click Yes. The integration’s status changes to Active.

Field name	Value
loginUrl	`https://www.acapela-cloud.com/api/login/`
email	<Your email address>
password	<Your password>

DeepgramClick to expand

Note: As of July 2025, Deepgram does not support SSML tags.

Open the Genesys TTS Connector integration:
- If you did not previously install the integration into your Genesys Cloud organization, install the Genesys TTS Connector now.
- If you installed the integration, follow these steps to open the integration:
  1. Click Admin.
  2. Under Integrations, click Integrations.
  3. Click Menu > IT and Integrations > Integrations.
  4. Search for and open the Genesys TTS Connector integration.
In the Details tab, Genesys highly recommends that you enter a unique name for the integration that you want to configure. For example, “Genesys TTS Connector – Deepgram.”
On the Genesys TTS Connector – Deepgram integration page, click the Configuration tab.

Under Properties, enter the following values:

Property name	Value
Synthesize Text URI	https://api.deepgram.com/v1/speak
List Voices URI	https://api.deepgram.com/v1/models
Synthesize Text Request Method	post
Synthesize Text Attribute	text
Synthesize Voice Attribute	model
Synthesize Language Attribute	language
Synthesize OutputFormat Attribute	encoding
Synthesize Sample Rate Attribute	sample_rate
Voices Attribute	tts
Voice Name Attribute	canonical_name
Voice Language Attribute	languages
Voice Gender Attribute	gender
Voice Type Attribute	type

Click the Advanced tab. Enter any additional configuration in the JSON format.
Use the following sample configuration for Deepgram:

{
  "outputFormatMapping": {
    "audio/L16": {
      "*": "linear16"
    }
  },
  "voiceMapping": {
    "languageMapping": {
      "en-us": "en"
    }
  },
  "synthesizeBody": {
    "text": "$text"
  }
}

Click the Credentials tab.
1. Click Configure. The Configure Credentials dialog box opens.
2. Select the credential type, User Defined.
3. Click Add Credential Field, then add the following field name and value:
  Field name Value
  Authorization Token <Your Deepgram API key>
4. Click OK.
Click Save.
To activate the Genesys TTS Connector integration, in the Status column click Inactive. The Change Status dialog box opens.
Click Yes. The integration’s status changes to Active.

Field name	Value
Authorization	Token <Your Deepgram API key>

ElevenLabsClick to expand

Open the Genesys TTS Connector integration:
- If you did not previously install the integration into your Genesys Cloud organization, install the Genesys TTS Connector now.
- If you installed the integration, follow these steps to open the integration:
  1. Click Admin.
  2. Under Integrations, click Integrations.
  3. Click Menu > IT and Integrations > Integrations.
  4. Search for and open the Genesys TTS Connector integration.
In the Details tab, Genesys highly recommends that you enter a unique name for the integration that you want to configure. For example, “Genesys TTS Connector – ElevenLabs.”
On the Genesys TTS Connector – ElevenLabs integration page, click the Configuration tab.

Under Properties, enter the following values:

Property name	Value
Synthesize Text URI	https://api.elevenlabs.io/v1/text-to-speech/$voice/stream
List Voices URI	https://api.elevenlabs.io/v1/voices
Synthesize Text Request Method	post
Synthesize Text Attribute
Synthesize Voice Attribute
Synthesize Languages Attribute
Synthesize OutputFormat Attribute	output_format
Synthesize Sample Rate Attribute	samplerate
Voices Attribute	voices
Voice Id Attribute	voice_id
Voice Name Attribute	name
Voice Language Attribute	fine_tuning\|language
Voice Gender Attribute	labels\|gender
Voice Type Attribute	type

Click the Advanced tab. Enter any additional configuration in the JSON format.
Use the following sample configuration for ElevenLabs:

{
  "outputFormatMapping": {
    "audio/L16": {
      "*": "pcm_8000"
    }
  },
  "voiceMapping": {
    "languageMapping": {
      "en-us": "en"
    }
  },
  "synthesizeBody": {
    "apply_text_normalization": "on",
    "text": "$text",
    "model_id": "eleven_flash_v2_5"
  }
}

Click the Credentials tab.
1. Click Configure. The Configure Credentials dialog box opens.
2. Select the credential type, User Defined.
3. Click Add Credential Field, then add the following field name and value:
  Field name Value
  xi-api-key <Your ElevenLabs API key>
4. Click OK.
Click Save.
To activate the Genesys TTS Connector integration, in the Status column click Inactive. The Change Status dialog box opens.
Click Yes. The integration’s status changes to Active.

Field name	Value
xi-api-key	<Your ElevenLabs API key>

Emotech Click to expand

Open the Genesys TTS Connector integration:
- If you did not previously install the integration into your Genesys Cloud organization, install the Genesys TTS Connector now.
- If you installed the integration, follow these steps to open the integration:
  1. Click Admin.
  2. Under Integrations, click Integrations.
  3. Click Menu > IT and Integrations > Integrations.
  4. Search for and open the Genesys TTS Connector integration.
In the Details tab, Genesys highly recommends that you enter a unique name for the integration that you want to configure. For example, “Genesys TTS Connector – Emotech.”
On the Genesys TTS Connector – Emotech integration page, click the Configuration tab.

Under Properties, enter the following values:

Property name	Value
Synthesize Text URI	https://speech-synthesis-dev.api.emotechlab.com/v2/synthesize
List Voices URI	https://speech-synthesis-dev.api.emotechlab.com/v2/voices
Synthesize Text Request Method	get
Synthesize Text Attribute	text
Synthesize Voice Attribute	voice
Synthesize Language Attribute	language
Synthesize OutputFormat Attribute	audioformat
Synthesize Sample Rate Attribute	samplerate
Voices Attribute	voices
Voice Name Attribute	name
Voice Language Attribute	language
Voice Gender Attribute	gender
Voice Type Attribute	type

Click the Advanced tab. Enter any additional configuration in the JSON format.
Use the following sample configuration for Emotech:

{
  "voices": [
    {
      "name": "ar-SA_Female_1",
      "gender": "female",
      "language": "ar-SA"
    },
    {
      "name": "ar-SA_Male_1",
      "gender": "male",
      "language": "ar-SA"
    },
    {
      "name": "ar-SA_Male_2",
      "gender": "male",
      "language": "ar-SA"
    },
    {
      "name": "en-US_Female_1",
      "gender": "female",
      "language": "en-US"
    },
    {
      "gender": "male",
      "name": "ar-EG_Male_1",
      "language": "ar-EG"
    },
    {
      "gender": "female",
      "name": "ar-EG_Female_1",
      "language": "ar-EG"
    }
  ],
  "voiceMapping": {
    "languageMapping": {
      "ar-sa": "ar-SA",
      "ar-ae": "ar-EG",
      "en-us": "en-US"
    }
  },
  "outputFormatMapping": {
    "audio/L16": {
      "*": "wav"
    },
    "audio/mpeg": {
      "*": "mp3"
    }
  }
}

Click the Credentials tab.
1. Click Configure. The Configure Credentials dialog box opens.
2. Select the credential type, ttsConnectorUserDefinedPathAuth.
3. Type apikey in the Path Credential Name field.
4. Enter your API key in the Path Credential field.
5. Click OK.
Click Save.
To activate the Genesys TTS Connector integration, in the Status column click Inactive. The Change Status dialog box opens.
Click Yes. The integration’s status changes to Active.

ReadSpeakerClick to expand

Open the Genesys TTS Connector integration:
- If you did not previously install the integration into your Genesys Cloud organization, install the Genesys TTS Connector now.
- If you installed the integration, follow these steps to open the integration:
  1. Click Admin.
  2. Under Integrations, click Integrations.
  3. Click Menu > IT and Integrations > Integrations.
  4. Search for and open the Genesys TTS Connector integration.
In the Details tab, Genesys highly recommends that you enter a unique name for the integration that you want to configure. For example, “Genesys TTS Connector – ReadSpeaker.”
On the Genesys TTS Connector – ReadSpeaker integration page, click the Configuration tab.

Under Properties, enter the following values:

Property name	Value
Synthesize Text URI	https://scapi-eu.readspeaker.com/a/speak?container=none&streaming=0
List Voices URI	https://scapi-eu.readspeaker.com/a/speak?command=voiceinfo
Synthesize Text Request Method	get
Synthesize Text Attribute	text
Synthesize Voice Attribute	voice
Synthesize Language Attribute	lang
Synthesize OutputFormat Attribute	audioformat
Synthesize Sample Rate Attribute	samplerate
Voices Attribute	speakers
Voice Name Attribute	voice
Voice Language Attribute	language
Voice Gender Attribute	gender
Voice Type Attribute	type

Click the Advanced tab. Enter any additional configuration in the JSON format.
Use the following sample configuration for ReadSpeaker:

{
  "outputFormatMapping": {
    "audio/L16": {
      "8000": "pcm",
      "16000": "pcm_16_16k",
      "22050": "pcm_16_22k"
    },
    "audio/mpeg": {
      "*": "mp3"
    }
  },
  "voiceMapping": {
    "languageMapping": {
      "ja-jp": "ja_jp",
      "en-us": "en_us"
    }
  }
}

Click the Credentials tab.
1. Click Configure. The Configure Credentials dialog box opens.
2. Select the credential type, ttsConnectorUserDefinedPathAuth.
3. Type key in the Path Credential Name field.
4. Enter your API key in the Path Credential field.
5. Click OK.
Click Save.
To activate the Genesys TTS Connector integration, in the Status column click Inactive. The Change Status dialog box opens.
Click Yes. The integration’s status changes to Active.

[NEXT] Was this article helpful?

Get user feedback about articles.

Activate and configure a third-party TTS provider integration View summary

[NEXT] Was this article helpful?

Activate and configure a third-party TTS provider integration