This is an old revision of the document!



This module collects individual digit information.
This module is commonly used for things like zip code, credit card number, account ID, or a transaction number. If users have a number that people typically read off each digit individually, then they should use this module.

Note: For numeric input such as a currency amount or a mathematical number, please use the Number ( ) module. The digits module handles individually spoken digits such as “One Two Nine”, whereas the Number module is designed for spoken numbers such as “one hundred twenty-nine”.

If the minimum and maximum digits are set, any input that does not match will return a no-match error.
For example, if the minimum is set to 2 and the maximum to 4, values like 5 or 54928 would both be invalid.

If the minimum and maximum digits are set to the same number, the input value must be that exact length.
For example, if the min and max are both set to 2, then 5, and 549 would be invalid input, but 54 would be valid.
Because credit card numbers are 16 digits, set both the min and max to 16 (or 15/16 if accepting AMEX) when collecting credit card numbers to ensure data accuracy and transactional efficiency.

Module Settings

This setting allows callers to interrupt a prompt before it finishes playing.
When enabled, DTMF input interrupts the prompt and progresses the call forward in the call-flow. If speech recognition is enabled on the ensuing module in the call-flow, then end-users can also interrupt the prompt with a spoken utterance, too. Disabling barge-in forces callers to listen to the entire prompt.

A barge-in enabled module will have a dashed line on top of the text box. See example here.

Note: This setting is enabled by default.

Enable Speech Input
This setting enables Automatic Speech Recognition (ASR) for that module.
A green microphone ( ) icon appears in the module when this is enabled.

Max Digits
It allows users to set the maximum number of allowable digits for end-user input.
Acceptable number values range from 1 to 128.

If the min and max digits are set to the same number, the module will only accept input of that length.

Min Digits
It allows users to set the minimum number of allowable digits for end-user input.
Acceptable number values range from 1 to 128.

If the min and max digits are set to the same number, the module will only accept input of that length.

This setting controls the logging function of a module.
Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates.
The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance.

The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.

Show Custom Errors
Enabling this setting overrides the default, global error options set in the Application Settings > User Input Settings.
This allows users to establish custom error handling in order to act on errors in a specific way in that module.
Instead of progressing to the next module in the call-flow, custom error handling allows users to re-prompt the same module, to provide a custom error message, to re-direct the call based on the error, or any other desired behavior.

Adding multiple errors ( ) to a module functions behave the same way as a counter.
The first error follows the path for the first error listed, if a second error occurs in the same module it follows the second listed error, and so on until all errors are exhausted or an error directs the end-user away from that module.

No Input occurs when the caller does not provide an input based on the timeout settings.
This is based on the “Initial input timeout” in User Input Settings

No Match occurs when the caller input does not match the module's criteria for the input module.

Advanced Settings: Advanced Fuse users may want to use shadow variables that are available with input modules. For more information on this functionality, please visit the Shadow Variables page.

modules/digits.1535483889.txt.gz · Last modified: 2018/08/28 19:18 by admin