IVR Collect Digit String applet

The IVR Collect Digit String applet collects a string of digits, in an IVR slot, that a caller provides using their telephone key pad. The applet stores this string in the specified digit string IVR Slot. For example, you might ask a user to provide their account number using their key pad. The applet collects this information.

When you store a value in an IVR slot, the value is also stored as a data source. The Data Connector, Data Announcer, Data Router, ACD, and UCD applets can then use the data source. The name of the data source is the friendly name of the IVR slot, prefixed with 'IVRSlot|'. For example, if an IVR slot has a friendly name of 'StockPrice', the corresponding data source value is called 'IVRSlot|StockPrice'.

You can only use this applet in an interaction plan that routes calls, and not other types of interactions.

Standard options

FieldOptionsDescription
Input prompt audio fileAudio (.wav) file

The audio file that contains the prompt that is played when the call is routed to this applet. The prompt tells the caller what information to provide using their telephone keypad.

Click Choose File to launch an Open dialog box. Select the audio file you want to use for the prompt.

For information about the format of the audio file, see Recording and preparing audio used in applets.

If you have uploaded an audio file, you cannot delete it. You can only replace it with a different file.

Input prompt alternative textTextIf you do not provide an audio file, you can type text that Vonage Contact Center converts to speech. The speech is played when the call is routed to this applet.
Maximum number of digits to collectNumber

The maximum number of digits that the caller can provide. When the caller has pressed the correct number of digits, the call routes to the next applet.

Type the maximum number of digits that you want the applet to collect.

If the caller provides fewer than the maximum number of digits, they should press the pound key (#) to indicate that they have finished providing information.

We recommend that you inform your caller of this in the input prompt.

Collect to data source?Check box

Determines whether to collect the provided digits in a data source or in an IVR slot.

Select the Collect to data source? checkbox to store the provided digits a data source for the duration of the call. Type the name of the data source in the Destination field.

Clear the Collect to data source? checkbox to store the provided digits in an IVR slot. Select the destination IVR slot in the Destination field. The digits will be available in IVR Data Collector for 30 days.

DestinationList of available IVR slots OR a text box

If you select the Collect to data source? checkbox, type the name of the data source that you want to store the provided digits in.

If you clear the Collect to data source? checkbox, select the IVR slot that you want to store the provided digits in.


Next applet after digits collectedList of available appletsThe applet that the call is routed to after the announcement is played.

No Input Options

FieldOptionsDescription
Maximum input promptsMaximum or 1-10

If the caller does not provide any information using their telephone key pad, the applet plays the input prompt again. The Maximum input prompts is the maximum number of times that the applet replays the input prompt after no input.

The maximum number of times that the applet replays the input prompt after no input.

Maximum value

The maximum value of Maximum input prompts is 20.

Select the maximum number of times (1-10 or Maximum) that the input prompt should be played.

Next applet after maximum input promptsList of available appletsThe applet that the call is routed if the input prompt has been played the maximum number of times.

Confirmation Options

FieldOptionsDescription
Confirmation prompt?Check boxDetermines whether or not the caller should confirm that they have provided the correct digits.
Playback audio fileAudio (.wav) file

The audio file containing the announcement that is played if the supervisor wants the caller to confirm their input.

Click Choose File to launch an Open dialog box. Select the audio file you want to use for the announcement.

For information about the format of the audio file, see Recording and preparing audio used in applets.

If you do not provide audio or alternative text, the default audio is played.

Playback alternative textStringIf you do not provide an audio file, you can type text that Vonage Contact Center converts to speech. The speech is played if the supervisor wants the caller to confirm their input.
Confirmation prompt audioAudio (.wav) file

The audio file that contains the prompt that is played when the digit string that the caller provides is valid, or not validated. The prompt should tell the caller to press 1 to accept the information they provide, or 2 to re-enter the information.

Click Choose File to launch an Open dialog box. Select the audio file you want to use for the announcement.

For information about the format of the audio file, see Recording and preparing audio used in applets.

If you do not provide audio or alternative text, the default audio is played.

Confirmation prompt alternative textStringIf you do not provide an audio file, you can type text that Vonage Contact Center converts to speech. The speech is played when the digit string that the caller provides is valid, or not validated.
Support and documentation feedback

For general assistance, please contact Customer Support.

For help using this documentation, please send an email to docs_feedback@vonage.com. We're happy to hear from you. Your contribution helps everyone at Vonage! Please include the name of the page in your email.