Play MessageVoicewidgetsCoreplayMessage· Version 1.0.0
Play a sound file or TTS on the current call.
Plays a prompt on the current call — either a recorded sound file or text-to-speech in a chosen language — and can gather the caller's reply. The prompt text supports $(name) variables. When collecting input, the caller's response is saved to a variable you name, the prompt can be made interruptible by speech or DTMF, and it can repeat a set number of times with a delay between; exhausting the repeats takes the repeatLimitReached exit, otherwise the flow continues on default.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
Audio Fileprompt | dynamicDropdown | Optional | The audio file to play |
Languagelanguage | dynamicDropdown | Optional | The language to use for the TTS prompt |
Voicevoice | dynamicDropdown | Optional | The voice to use for the TTS prompt. |
Voice Engineengine | dynamicDropdown | Optional | The synthesis engine (generative, neural, or standard) for the selected voice. |
Contentcontent | textArea | Optional | The content of the TTS prompt. Example: Text to speech prompt |
Input TypeinputType | string | Required | How to collect caller input: NONE (no input), DTMF (keypad), SPEECH (voice recognition), or BOTH. |
Response Variable NameresponseVariableName | string · variableName | Required | The DTMF input or speech transcript will be stored in this variable. When input type is BOTH, whichever input is resolved first will be stored. |
interruptibleinterruptible | boolean | Optional | Whether or not to make the prompt interruptible by DTMF or speech. |
Speech ModespeechMode | string | Required | What the caller is expected to say, which constrains recognition. Choose "Specific words or phrases" to match a list of keywords, "Anything the caller says" to capture an open-ended answer such as a name, or one of the others to capture a spoken value of a known shape. Use the input-length settings to require an exact number of characters. |
Repeat CountrepeatCount | number | Optional | The number of times the prompt should be repeated. |
Repeat DelayrepeatDelay | number | Optional | The amount of time between repeats (in seconds) |
Maximum Input LengthmaxDTMFLength | number | Optional | The maximum allowed length of the user's input |
Minimum Input LengthminDTMFLength | number | Optional | The minimum allowed length of the user's input |
Between-Input TimeoutbetweenInputTimeout | number | Optional | The allowed amount of time (seconds) between two consecutive inputs. |
Terminating CharacterterminatingCharacter | string | Optional | DTMF character that signals the end of input (e.g. # to finish entering a number). |
Valid InputsvalidDTMFInputs | array of strings | Optional | Keypad values that should be considered valid |
Speech GrammarsspeechGrammars | array of strings | Optional | Keywords or phrases for speech recognition to listen for |
Exits
defaultrepeatLimitReached
System exits (auto-injected, hidden when unwired): invalidInput, fallback.