Skip to main content
Skip table of contents

Capture Digits


This workflow object accepts input of a numeric value from the caller's keypad.

1. An Example Scenario

The caller is played a soundfile in which they are prompted to enter their 10 digit membership number. They then hear a second soundfile explaining about using the “#” hash key to terminate the digit entry. Using the keypad on their phone, they enter their membership number.

2. Add Workflow Object

  1. Open the Workspace.

  2. Select Workflows from the Resources menu.

  3. Select a workflow from the list displayed (you can also create a new one).

  4. A schematic representation of the workflow is displayed. Click the Add New Object icon  

  5. The New Workflow Object dialog opens. Select Capture Digits from the drop-down selection list.

When you include Capture Digits in your automated workflow, enter the following details:


What you should do

Workflow Object Title

Enter a meaningful name for your new object.

Data Label

Enter the textual label that will be saved in the record of this object's execution in the ivr_activities table.

Input Timeout Period

Select the amount of time the caller will be allowed to finish inputting digits. If the timeout is exceeded, the caller is given a second chance before the call is terminated.

Minimum Digits

Select the minimum number of digits expected.

Maximum Digits

Select the maximum number of digits expected.

Explanatory Sound

Select the voice recording you wish the caller to hear. If this field is left blank, no soundfile will be played.


This soundfile should explain to the caller the number of digits they are expected to enter, (e.g. minimum digits = 3 and maximum digits = 5) and instruct them to enter the hash key # at the end. If the caller does not use the hash key, the Input Timeout Period will be reached.

Error Message

Select the voice recording you wish the caller to hear in the event that an invalid number has been input. If this is left blank, no soundfile will be played in the event of an input error.

Maximum Retries

Select how many times the caller will be allowed to retry inputting a valid number.

Click Save to keep your new object and to return to the Workflow Builder.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.