Play Message

The Play Message activity plays an uninterruptible message to the caller. You can use the Play Message activity with or without the Text-to-Speech capability enabled. The configuration options change accordingly.

The following sections enable you to configure the Play Message activity:

General Settings

Parameter

Description

Activity Label

Enter a name for the activity.

Activity Description

(Optional) Enter a description for the activity.

Prompt

If you don't wish to use the Text-to-Speech capability in your prompt, disable the Text‐to‐Speech toggle button. By default, Text-to-Speech is not enabled.

You can configure up to five audio prompts (audio files and audio prompt variables combined). The full prompt is played to the caller in the configured order, alternating between the audio files and audio prompt variables.

Note

If any of the ordered list inputs is empty, the system responds with a flow error. Resolve these errors before publishing the flow.

Prompt Configuration without Text-To-Speech Enabled

Parameter

Description

Add Audio Files

To configure the prompt without Text-to-Speech, add at least one prerecorded audio file. Choose the desired audio file from the drop-down list that is labeled as 1.

To add more audio files, click Add New. The files play to the caller in the order in which they appear.

To remove an audio file from the sequence, click the Delete icon that appears next to each drop-down list.

Add Audio Prompt Variable

Use this option to configure the audio prompt to be played dynamically to the customers. For example, you can configure this variable to play the audio prompt in multiple languages based on the customer's preference during the interaction.

To configure the audio prompt variable, click Add Audio Prompt Variable. Enter the variable value in the form of a pebble expression.

For more information, see Pebble Template Syntax.

Note

The variable value must match the name of the .wav file that is uploaded to the Management Portal.

To use the Text-to-Speech capability in your prompt, enable the Text‐to‐Speech toggle button. You can configure up to a total of five audio prompts (Text-to-Speech messages, audio files, and audio prompt variables combined). The full prompt is played to the caller in the configured order, alternating between the Text-to-Speech messages, audio files, and audio prompt variables.

Prompt Configuration with Text-to-Speech Enabled

Parameter

Description

Connector

Indicates the connector to authenticate the Text‐to‐Speech service. The drop-down list displays the name of all Google connectors in the Control Hub. Only the active connectors are displayed. Select the connector from the drop‐down list.

Override Default Language & Voice Settings

Use this toggle button to override the voice settings configured in the Global Voicename variable. This parameter is enabled by default.

Output Voice

Indicates the output voice name. This field appears only if you enable the Override Default Language & Voice Settings toggle button. Select the output voice name from the drop-down list.

Note

If the output voice name that is supported by Google isn't available in the Output Voice drop-down list, disable the Override Default Language & Voice Settings toggle button. Include the Set Variable activity before the Play Message activity in the flow.

Configure the Set Variable activity as follows:

  • Set the variable to Global_VoiceName.

  • Set the variable value to the required output voice name code (for example, en-US-Standard-D). For more information on the supported voices and languages, see the Google Supported voices and languages page.

Add Audio File

To alternate Text-to-Speech messages with prerecorded audio files, click Add Audio File. This adds a new row to the configuration where you can choose the desired audio file from the drop-down list.

To remove an item from the sequence, click the Delete icon that appears next to the corresponding input or drop-down list.

Add Text-to-Speech Message

To build the prompt, use Text-to-Speech or a mix of prerecorded audio files and Text-to-Speech messages.

Click Add Text-to-Speech Message to add a new text input field to the prompt creation section. In this field, type the message to be played to the caller in the selected Language and Voice. The field accepts two types of input—raw text (plaintext) or Speech Synthesis Markup Language (SSML)‐formatted data. You can also use variables as part of the message to read the dynamic content.

Add Audio Prompt Variable

Use this option to configure the audio prompt to be played dynamically to the customers. For example, you can configure this variable to play the audio prompt in multiple languages based on the customer's preference during the interaction.

To configure the audio prompt variable, click Add Audio Prompt Variable. Enter the variable value in the form of a pebble expression.

For more information, see Pebble Template Syntax.

Note

The variable value must match the name of the .wav file that is uploaded to the Management Portal.

Note
  • Don't include only the Play Message activity in loop after the Queue Contact activity in the call flow. You can use a combination of the Play Music activity and the Play Message activity in loop to make a valid call flow.

  • When you include the Play Message activity before the HTTP Request activity in a call flow, the HTTP request executes immediately without waiting for the audio to complete.