Skip to main content

Workflow Command: Gather Input

Basic settings

In the Gather Input command, users are allowed to add a greeting message to gather callers' input. 

  • For example:
    • Press 1 for Sales
    • Press 2 for Support
    • Etc.

In order to set up, please flow the steps below:

Step 1: Create Gather Input > Set up IVR message​

  1. Set IVR Message:
    • Type your message (TTS - Text to Speech):
      • The message is currently limited to 450 characters.
      • Choose Language
      • Choose Pitch: the degree of highness or lowness of a tone; from 0 (lowest) to 9 (highest)
      • Choose Rate: the speed; from 0 (slowest) to 9 (fastest)
      • ChoosetheGender of the voice
    • Upload an MP3 File:
      • The maximum MP3 file allowed to upload is 5Mb.
  2. Add*:*
    • Playtimes*- How many times the caller will hear the message*
    • Caller input timeout*- How long the caller can input the key number*

   

Step 2: Configure the next blocks​

  1. Select a Gather type:
    • Equal to a specific digit (E.g: 1, 2, 123,...)
    • Any digit
    • No digit
    • Upload digits
    • Matches regex
      • Matches Regex is the short name ofMatches Regular Expression, used for searching the specified input string from the user. It depends on the particular cases and initial requirements.

Note:

For “Gather type” options (Equals to, Any Digit, No Digit, Upload Digits), users are allowed to fill in digits/numbers only. Special characters are not an acceptable input for this field.

Below is an example for Matches Regex:     

  • \d : Input contains (0,1,2,3,4,5,6,7,8,9)
  • \d{10} : Input contains an 11-digit string starting with 1

 

  1. Select a block type and configure it:

   

Advanced settings - Context variables:​

Use these fields if you need to integrate the data into your system.  
Contact our technical support for more details.

 

Context variables describe the user-defined parameters, global data, and block data that are passed through the Virtual Line blocks at runtime, and can be used as a condition in the next block setting**.**

Format:

  • $.Variable name: $.variablename
  • Variable value: value

Some common global context variables:

Sample:​

Requirements for Incoming calls to Auto Attendant:

  • If caller input = 123, the call will be transferred to extension 101.
  • If caller input = 456, the call will be transferred to extension 102.
  • Otherwise, it will be transferred to extension 103.

In order to configure, please follow the step below:

Step 1: Set Gather Input with Context Variables​

  • $.Variable name: $.userinput
  • Variable value: digits

   

Step 2: Block type - Set Conditions​

 

  1. Choose the Gather Input block, click Next Step
  2. At Gather type, choose Any Digit -Max digitallowed: 3 (Collect any digits the callers press with the maximum valid digit = 3)
  3. Block type: Set Condition*(choose the type of command to set up the next step after the callers press the key)*

 

   

Step 3: Condition 1​

  1. Set type: Validate Expression
  2. Condition 1:
    • Process order = 1
    • Expression Template = {{$.userinput}}==='123'
    • Transfer to extension 101

   

Step 4: Condition 2​

  1. Set type: Validate Expression
  2. Condition 2:
    • Process order = 2
    • Expression Template = {{$.userinput}}==='456'
    • Transfer to extension 102

   

Step 5: Condition 3​

Set type: Otherwise
Condition 3:

Transfer to extension 103

   

Step 6: Deploy the workflow​

   

Click HERE for more detailed instructions on setting Conditions.