Menu applet


The Menu applet provides one or more options during a call, and can optionally play an announcement as an introduction to those options. For example, the announcement can tell the caller to press number 1 on their telephone keypad for Sales, 2 for Support, or 3 for any other queries. When the caller presses their chosen number, the call is routed to another applet.

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

FieldOptionsDescription
Announcement TypeList of announcement types

The type of information that the applet will announce.

Click Audio file (uploaded) to play a specific audio file. You need to upload the file in the Audio file field.

Click Dynamic audio file to play the audio file that you specify in the Announce from field. For information about specifying audio files in data sources, see Using dynamic announcements.

Click Text to use the text-to-speech feature and announce the specified text in the specified voice. For information about text-to-speech in announcements, see Using text-to-speech in announcements.

Audio file (uploaded)
Audio fileFile

The applet will play the file you upload.

Click Browse... to choose the file to upload a new file or replace an existing file.
Click Play to play the uploaded file.

Maximum audio file size

The size of the audio that a customer provides can be a maximum of 10 MB (approximately 10 minutes).

Dynamic audio file

Data sourceData Source

The data source that contains the name of the audio file to play at runtime. If the data source contains a comma-separated list of values, the applet looks for and plays all corresponding audio files in the order in which they appear. If the audio file or any of the audio files do not exist, the applet plays no audio and pauses while waiting for the caller to press a number.

The Data source field contains both IVR slot and data source names. IVR slot names are prefixed with 'IVR Slot|'. 

Text to speech

For information about text-to-speech in announcements, see Using text-to-speech in announcements.

Dynamic voiceSelect or clear

Determines whether you use a dynamic or static voice to announce menu options.

Select the Dynamic voice check box to use a data source to define the voice at runtime.
Clear the Dynamic voice check box to use a static destination country for the voice.

Voice data sourceList of all available data sources

If you select the Dynamic voice check box, the Voice data source field appears.

A list of all available data sources.

Select the data source that will contain the voice you want to use to announce menu options at runtime.

VoiceList of voices available in Amazon Polly

If you clear the Dynamic voice check box, the Voice field appears.

A list of voices available in Amazon Polly. Select the voice you want to use to announce menu options.

TextText

The text that is announced in the specified voice. You can use a combination of text, digits and data sources. The resulting value in the Text field can contain a maximum of 1500 characters.

Data sources

The data sources are placeholders for the data sources' values at run time. Vonage Contact Center replaces the placeholders with values before announcing the text.

Use the following format to specify a placeholder for a data source:

$(DataSource)

For example, "Welcome to $(CompanyName) customer support."

Check announcementButton

If you clear the Dynamic voice check box, the Check announcement button appears.

To check the audio, click the Play button. VCC uses the Voice and Text values to generate audio.

Data sources

When generating test audio, VCC cannot replace any data sources in the Text field with actual values.

VCC announces data source names in the Text field — including the '$' — as if they are text. At runtime, VCC will include data source values in the audio as expected.

Download announcementButton

If you clear the Dynamic voice check box, the Download announcement button appears.

To download the audio, click the Download button. VCC uses the Voice and Text values to generate audio.

Data sources

When generating audio to download, VCC cannot replace any data sources in the Text field with actual values.

VCC announces data source names in the Text field — including the '$' — as if they are text. At runtime, VCC will include data source values in the audio as expected.

All

Enable barge-in

Select or clear

Select the Enable barge-in check box to enable barge-in. Clear the Enable barge-in check box to disable barge-in.

Barge-in

If you enable barge-in and follow this applet with a Menu Tone applet, callers can press any key on their telephone keypad to skip the rest of this announcement. The key that the caller presses is logged and used by the following Menu Tone applet.

If you enable barge-in for a chain of announcements between this and the Menu Tone applet, callers will skip these announcements too. If intermediate announcements do not have barge-in enabled, the caller's keypress is not passed to the Menu Tone applet and is lost.

FieldOptionsDescription
Menu option nList of available applets

The applet that the call is routed to when the caller presses key n.

n is a number from 0-9, or *

Menu failure appletList of available appletsThe applet that the call is routed to when the menu fails to play the announcement.
FieldOptionsDescription
Pause time (seconds)Number

The length of time that the applet waits for the caller to press a key before playing the menu options again.

Number of replaysMaximum or 1-10

The number of times that the applet replays the menu options after no input.

Maximum value

The maximum value of Max. No Input Count is 20.

Next appletList of available appletsThe applet that the call is routed to when the Number of replays has been reached.


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.