Configure and activate a third-party TTS provider integration

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.

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

Acapela Cloud

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, open the Genesys Cloud Admin menu and under Integrations, click Integrations. Then, 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>

Deepgram

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, open the Genesys Cloud Admin menu and under Integrations, click Integrations. Then, 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	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 Deepgram:

{
  "voices": [
    {
      "name": "aura-asteria-en",
      "gender": "female",
      "language": "en-us"
    },
    {
      "name": "aura-orion-en",
      "gender": "male",
      "language": "en-us"
    }
  ],
  "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>

ReadSpeaker

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, open the Genesys Cloud Admin menu and under Integrations, click Integrations. Then, 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.