Tutorials: Voice Widget: Collect Input
Required access: Voxtelesys Portal
The Collect Input widget is one that gets used quite frequently!
You will want to place the answer call widget at the front of the flow if you plan on collecting input/directing the caller around.
The Collect Input widget goes under the voice category for the VAST flow builder. This widget plays an audio file or speaks TTS and then collects a user’s keypresses via dual tone multi-frequency (DTMF) keypresses or voice input via speech recognition. The collected keypresses or voice input is saved to a variable on the call which can be accessed immediately or later on in the flow to control which flow path the user traverses.
If speech recognition is used for input collection, the call is billed for the duration of the speech-to-text (STT) collection in 15 second increments.
*Disclaimer: You will need to have Voice API enabled on your account to do this you will need to open a ticket with support.
Last Updated: 10/17/24
To use the widget simply click and drag it into the builder
Note that naming the widget can help identify it with other tools later on. It is case sensitive, does not accept spaces or dashes
The collect input widget has the following configuration abilities.
Input
This is how you want to collect the information from the caller, it includes 3 options:
- Digits and Speech
- Digits
- Speech
Action Type
Action type can either play an audio file or you can use our built in voices to say text:
Play Audio
- URL - Provide the URL for the audio file location
Say Text
- Enter the Text to Say
- Select the Language
- Select the Voice
Number of Digits
The number of digits you expect to receive from the caller, leave blank for no limit
Finish on Key(s)
The special key press to end the input, defaults to #
Profanity Filter
Replaces all but the first character of each profane word with a '*' character (e.g., 'f***').
Timeout
Allow with finish on key(s), the timeout is the time in seconds to wait for the caller to enter digits (or speak if no speech timeout is specified).
Speech Timeout
The number of seconds to wait for the caller to speak. This property can either be an integer time in seconds or the word "auto". Setting this property to "auto" causes speech recognition to stop after a pause in speech.
Loop
The number of times to play the audio or TTS.
Conditions
You can add conditions on the input that is received, in our example below we take the speech and digits and use condition to route them differently.
Note that if using a number use the digit, example "one" should be "1"
Now, you will want to connect the Collect Input widget as seen below:
Adding the Collect Input widget is completed! To continue the flow, connect more widgets to the opposite end of the Collect Input widget:
Now connect more widgets! Click on the links below to view more tutorials:
Voice
Messaging
Tools
Control
