Home Nodes Prompt Node Overview

Prompt Node Overview

Last updated on Jan 06, 2025

The Prompt Node is designed to collect user input, either through keypad digits (voice calls) or text input (e.g., SMS or email).

How It Works

  • Voice Calls: The Prompt Node plays a message or audio and waits for the user to enter digits on their keypad. The caller can interrupt the message to start dialing.

  • Chat-Based Flows (e.g., SMS): The message specified in "What to Say" is sent to the sender, and they can respond with text.

If no input is received within the specified timeout period, the flow follows the No Input transition.

Key Features

  1. What to Say: Works like a Say Node but allows interruptions for voice calls.

  2. Audio to Play: Optionally play an audio file instead of text-to-speech.

  3. Input Handling: Collects user responses and stores them in the Entered Text parameter for use in the flow.

  4. Timeout and Transitions:

    • For voice calls, specify the timeout duration.

    • Direct the flow to different transitions based on user input or lack thereof.

Voice Call Properties

  • Num Digits: Number of digits to collect from the user.

  • Finish On Key: Specify a key (e.g., # or *) that ends the digit collection early.

  • Timeout Secs: The time (in seconds) to wait for input before moving to the No Input transition.

Chat-Based Properties

The "Num Digits," "Finish On Key," and "Timeout Secs" properties only apply to voice calls and are ignored in chat-based flows like SMS.

Properties Overview

Field Name Type Description
What To Say String Message to be spoken (TTS) or sent in a chat flow.
Audio To Play Audio File Optional audio file to play instead of TTS.
Voice String Voice used for TTS.
Language String Language used for TTS.
Num Digits Number Number of digits to collect (voice calls only).
Finish On Key String Key that ends digit collection (e.g., # or *, voice calls only).
Timeout Secs Number Time to wait for input before timing out (voice calls only).
Entered Text String Stores user input (digits or text) for later use in the flow.
Transitions List Defines the flow path based on user input or lack of input.
Done Transition Used when the user provides valid input.
No Input Transition Used when no input is received within the timeout period.

By simplifying input handling and directing flows dynamically, the Prompt Node ensures seamless communication in both voice and text interactions.