Get Digits

VCS only.

This block allows the script to capture DTMF digits (tones) entered by the caller.

Properties

Values

Description

Max Time

Seconds (integer)

Maximum amount of time to wait for the entire string of digits.

If Max Time is left blank, it is calculated by multiplying the Max Silence (default is 3 seconds) by the Max Digits.

Max Silence

Seconds (integer)

Maximum amount of time (silence) between digits.

If left blank the default is 3 seconds per digit. So if the number could be 3 or 4 digits, the Max Digits would be set to 4, and if 4 digits are entered, the getDigits block ends. If 1, 2 or 3 digits are entered, the block waits 3 seconds then ends.

Termination Digits

0-9 # and *

Enter digit(s), # or *. These value(s) can be used by the caller to terminate this command.

For example, to allow any touch tone to be a termination digit, set this to 1234567890#*

Include Termination

Yes or No

Include termination digit in the resulting string.

For example, the termination digit is # and caller enters 1234#.

If this is Yes, the result is 1234#. If this is No, the result is 1234.

Max Digits

Integer

Maximum number of DTMF digits allowed.

Result Variable

String

Name of a variable into which the digit string is to be passed.

Must start with an alphabetic character and not exceed 255 characters in length.

See How to use variables.

Clear Digits

Yes or No

Clear the digit buffer of any digits entered prior to this command. This should be set to No by default.

Line

Inbound

The function is applied to the original (incoming) call.

Outbound

The function is applied to the outbound call (to where the call is transferred).

Note

If the caller has entered 10 digits and there are 5 GetDigits blocks, each with Max Digits set to 2, each GetDigits block takes 2 digits so there will be 10, then 8 then 6, then 4 then 2 and after the 5th GetDigits block there will be no digits left in the buffer, but only if none of the blocks have Clear Digits set to Yes.