# Workflow Action - IVR Gather Input On Call

> TABLE OF CONTENTS Overview Action Name Action Description Action Details Example Overview The Gather Input On Call action enables users to gather inputs…

- Source: https://docs.ghlcustomercare.com/docs/workflows/ivr-workflow-actions/workflow-action-ivr-gather-input-on-call
- Section: Workflows / IVR Workflow Actions
- Reading time: 2 min
- Images: 2, each explained below

---
**TABLE OF CONTENTS**

-   [Overview](#overview)
-   [Action Name](#action-name)
-   [Action Description](#action-description)
-   [Action Details](#action-details)
-   [Example](#example)

## Overview

The **Gather Input On Call** action enables users to gather inputs via keypad from the caller. This can be used in IVR systems where the caller is prompted to press certain keys to make a selection (e.g., "Press 1 to speak to support, Press 2 to leave a message"). This action helps automate responses and proceed based on the inputs from the user.

## Action Name

**Gather Input On Call**

## Action Description

The **Gather Input On Call (IVR)** action collects information from the caller through DTMF (Dual Tone Multi-Frequency) inputs. It is typically used in IVR flows, where the user interacts with the system by pressing keys on their phone. Based on the keypress, different branches can be defined, allowing for customized flows depending on the input.

## Action Details

![Action Details (image 1 of 2)](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/155032467893/original/UcwBIizZxLaiHIF6_C7pXEdsTOKADGR4dg.png)

**Action Details (image 1 of 2)**

This screenshot appears in the "Action Details" section of "Workflow Action - IVR Gather Input On Call". The text alongside this image reads: The Gather Input On Call (IVR) action collects information from the caller through DTMF (Dual Tone Multi-Frequency) inputs. It is typically used in IVR flows, where the user interacts with the system by pressing keys on their phone. Based on the keypress, different branches can be defined…. Immediately after, the guide continues: Action Name: Set a relevant name for this IVR input gathering action. Say or Play Message: Choose between "Say a message" (text-to-speech) or uploading a pre-recorded audio file. Text to Say: If "Say a message" is chosen, provide the….
- What to fill in: The Gather Input On Call (IVR) action collects information from the caller through DTMF (Dual Tone Multi-Frequency) inputs. It is typically used in IVR flows, where the user interacts with the system by pressing keys on their phone. Based on the keypress, different branches can be defined, allowing for customized flows depending on the input.
- Next: Action Name: Set a relevant name for this IVR input gathering action. Say or Play Message: Choose between "Say a message" (text-to-speech) or uploading a pre-recorded audio file. Text to Say: If "Say a message" is chosen, provide the message that will be played (e.g., "Press 1 for support"). Language: Select the language for the text-to-speech. Message Voice: Select whether you want a "Man" or "Woman" voice for the text-to-speech message. Number of Loops: Define how many times the message will be repeated before proceeding. Advanced Settings: Set a timeout (in seconds) after which input gathering stops and optionally stop the input gathering when the user presses a key. Match Conditions: Use this feature to create branches based on the caller’s input. For example:

![Action Details (image 2 of 2)](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/155032467902/original/GGJsEM9GZ_TeC1H01k3e01ossdpOH4BbWA.png)

**Action Details (image 2 of 2)**

This screenshot appears in the "Action Details" section of "Workflow Action - IVR Gather Input On Call". The text alongside this image reads: The Gather Input On Call (IVR) action collects information from the caller through DTMF (Dual Tone Multi-Frequency) inputs. It is typically used in IVR flows, where the user interacts with the system by pressing keys on their phone. Based on the keypress, different branches can be defined…. Immediately after, the guide continues: Action Name: Set a relevant name for this IVR input gathering action. Say or Play Message: Choose between "Say a message" (text-to-speech) or uploading a pre-recorded audio file. Text to Say: If "Say a message" is chosen, provide the….
- What to fill in: The Gather Input On Call (IVR) action collects information from the caller through DTMF (Dual Tone Multi-Frequency) inputs. It is typically used in IVR flows, where the user interacts with the system by pressing keys on their phone. Based on the keypress, different branches can be defined, allowing for customized flows depending on the input.
- Next: Action Name: Set a relevant name for this IVR input gathering action. Say or Play Message: Choose between "Say a message" (text-to-speech) or uploading a pre-recorded audio file. Text to Say: If "Say a message" is chosen, provide the message that will be played (e.g., "Press 1 for support"). Language: Select the language for the text-to-speech. Message Voice: Select whether you want a "Man" or "Woman" voice for the text-to-speech message. Number of Loops: Define how many times the message will be repeated before proceeding. Advanced Settings: Set a timeout (in seconds) after which input gathering stops and optionally stop the input gathering when the user presses a key. Match Conditions: Use this feature to create branches based on the caller’s input. For example:

### **How to Configure:**

1.  **Action Name**: Set a relevant name for this IVR input gathering action.
    
2.  **Say or Play Message**: Choose between "Say a message" (text-to-speech) or uploading a pre-recorded audio file.
    
3.  **Text to Say**: If "Say a message" is chosen, provide the message that will be played (e.g., "Press 1 for support").
    
4.  **Language**: Select the language for the text-to-speech.
    
5.  **Message Voice**: Select whether you want a "Man" or "Woman" voice for the text-to-speech message.
    
6.  **Number of Loops**: Define how many times the message will be repeated before proceeding.
    
7.  **Advanced Settings**: Set a timeout (in seconds) after which input gathering stops and optionally stop the input gathering when the user presses a key.
    
8.  **Match Conditions**: Use this feature to create branches based on the caller’s input. For example:
    
    -   Branch 1: Press "1" for Support
    -   Branch 2: Press "2" for Sales

<table border="1" cellpadding="0" cellspacing="0" dir="ltr" style="width: 0px"><colgroup><col width="100"><col width="506"><col width="119"></colgroup><tbody><tr><td style="vertical-align: bottom; text-align: center">Field Name</td><td style="vertical-align: bottom; font-weight: normal; text-align: center">Description</td><td style="vertical-align: bottom; font-weight: normal; text-align: center">Mandatory</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Action Name</td><td style="vertical-align: bottom; white-space: normal">Provide the name of the action.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Say or Play Message</td><td style="vertical-align: bottom; white-space: normal">Choose whether to say a message or play a pre-recorded audio file.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Text to Say</td><td style="vertical-align: bottom; white-space: normal">If "Say a message" is selected, input the text to be said to the caller.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Language</td><td style="vertical-align: bottom; white-space: normal">Select the language in which the message should be spoken.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Message Voice</td><td style="vertical-align: bottom; white-space: normal">Choose between male or female voice.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Number of Loops</td><td style="vertical-align: bottom; white-space: normal">Select the number of times the message should be played or repeated.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Stop Gathering After (Seconds)</td><td style="vertical-align: bottom; white-space: normal">Set the duration (in seconds) after which the gathering stops.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Stop Gathering After (Digits)</td><td style="vertical-align: bottom; white-space: normal">Specify how many digits to collect before stopping input collection.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">No</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Stop Gathering on Key Press</td><td style="vertical-align: bottom; white-space: normal">Enable this to stop gathering input once a key is pressed.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">No</td></tr><tr><td style="vertical-align: bottom; white-space: normal">Match Conditions</td><td style="vertical-align: bottom; white-space: normal">Option to define branches based on key press values.</td><td style="vertical-align: bottom; font-weight: normal; white-space: normal">Yes</td></tr></tbody></table>

## Example

**Scenario**: Collecting input from a caller for a bank's IVR system.

**Message**: "Press 1 to hear your bank statement, Press 2 to connect with an agent, or Press 3 to exit."

**Key Presses**:

-   Pressing "1" directs the user to a branch that reads their bank statement.
-   Pressing "2" directs the caller to a customer support agent.
-   Pressing "3" terminates the call after thanking the customer.

---

Documentation for GHL Customer Care. Support: support@ghlcustomercare.com