TTSVOICE

Adds text-to-speech (TTS) capabilities to the script. This action uses third-party TTS services such as Google TTS.

This action is used with CXoneCloud TTS Hub.

Supported Script Types

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

Phone

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

vendor

The name of the TTS provider this action uses. This property populates automatically when you select the voice you want the provider to use.

If you haven't added a provider account yet, do so now.

voicename

The name of the TTS voice you want this action to use. This property populates automatically when you select a voice from the Cloud Text to Speech page.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

Add a TTS Provider

You can use one TTS provider profile with multiple Cloud TTS actions in the same script, or in different scripts. Each action can use a different voice.

  1. Double-click the Cloud TTS action to open the Cloud Text-to-Speech page.

  2. Click Add New TTS.

    The Add Text to Speech Config page, where you can add a new TTS provider.
  3. Enter a name for this provider in the Text to Speech Config Name field. This is the name that goes in the vendor property of the Cloud TTS action.
  4. Click the Text to Speech Config Provider that you're using.
  5. Click Next.

  6. Complete the Configuration page with the information required to authenticate your account with the TTS provider you chose. This information is different for each provider.

    Provider Required Information
    Access Key

    Enter your AWS Polly access key. Create your access keyAn icon of a square with an arrow pointing from the center out to the upper right corner. in AWS.

    Secret Key

    Enter the secret key for your AWS Polly account.
    Region Enter the region for your AWS Polly. For example, us-east-2.
    Engine Select which Polly TTS engine you're using, Standard or Neural.
    Language Select the language you want this profile to use.
    Provider Required Information
    Base64 Service Account

    Enter the ID for your service account in base64 format. The description under this field on the Configuration page includes a link to a converter you can use to convert your ID to base64.

     
    Use Custom Voice

    Select this option to use a custom Google TTS voice model.

    Note: Google Custom Voice TTS is only available for use with Google accounts that are directly billed to your organization (BYO TTS). It is not available if your organization is billed through the NICE CXone Google account (OEM service account).
    Language Select the language of your custom voice model. This option appears only when  Use Custom Voice is enabled.
    Custom Voice Model Enter the name of the custom voice model you're using. This option appears only when  Use Custom Voice is enabled.
  7. Click Add.

Choose a TTS Voice

When you want to use TTS in your script, you need to assign a provider to each Cloud TTSaction you include in your script.

  1. Double-click the Cloud TTS action to open the Cloud Text-to-Speech page.
  2. Click to select a TTS provider from the list on the left side of the page.

  3. Scroll through the list of voices and select the language and voice that you want this action to use.

    The Select a Voice page, where you can choose a voice from the ones the selected provider offers.
  4. Test the selected voice by entering text in the Text to Speak field and clicking the speaker icon next to the voice you're testing.
  5. When you are satisfied with the voice you've chosen, click OK to save your selection to the action's properties.