Play String Extended

This Telephony tool reads the contents of a string to a caller using the text-to-speech (TTS) engine.  This tool extends the options available over the Play String tool in that you can specify Voice Name, Volume, Speed, and other Optional Parameters.

For more information about installing, licensing, and configuring Interaction Text to Speech, see CIC Text To Speech Engines Technical Reference in the PureConnect Documentation Library.

Inputs

Call Identifier

The identifier for the call to which the string will be played.

Text

A text value or string variable containing the text to be played.

Voice Name

Name of voice to use to play the string.

Volume

An integer from zero to 100 representing the percentage of the maximum permitted volume at which the string will be played. That is, a value of 100 will play the recording at the maximum volume, whereas a value of 25 will play the recording at 25% of the maximum level.

Speed

This optional value is used to specify the approximate rate of speech. Since rates vary depending on what TTS engine is used, refer to the TTS provider documentation for more information.

Immediate Mode

Select this option if you want the text to be played when this step executes. Clear this option if you want the text to be queued with other prompts played before and after so that several prompts are played seamlessly, one after another.

Load Controller Timeout (milliseconds)

This parameter is no longer used.

Optional Parameters

Use this field to set any optional parameters to TTSServer.  

One of the optional parameters you can specify is "NOXML." If the NOXML parameter is specified, the TTS engine ignores the < sign and does not attempt to process the text as a SAPI tag. If the NOXML parameter is not specified, the TTS engine attempts to process the < sign as the beginning of a SAPI tag.  

To specify a name:value pair to control advanced MRCP properties, refer to Using MRCP Tools.

To use ITTS even if you have SAPI or MRCP as the default TTS provider, specify "I3TTS" as the optional parameter.

To specify a name:value pair to control advanced ITTS properties, refer to in Using ITTS Tools.

Exit Paths

Next

This step takes the Next exit path if the speech is played.

Rejected

This step takes the rejected exit path if the TTS subsystem does not have the resources to play the speech.