Walkthrough: Get Variable Length Input Using GetDTMF and Play Back Input Entered

In this walkthrough we will get a variable length input from the caller and play back input entered.

Walkthrough Overview

In this walkthrough, you will:

1. Create Audiotex Records/Modules and Associated Scripts;
2. Define entry in the IVR Application List for the new custom IVR;
3. Set Ports.

During this walkthrough, you will learn to do the following:

• Configure CALLMaster to answer in Audiotex mode;
• Get input using the GetDTMF command;
• Use CALLBasic commands StringLength, MemMove, SayNumeral;
• Send caller to another Audiotex Module using the Next Module Audiotex Module Action;
• Make Audiotex recordings;
• Handle caller hang up and call failure.

Prerequisites and Assumptions

• CALLMaster software installed and running with the Dialogic board installed and configured.  For more information, see Installation and Setup.
• A working knowledge of CALLMaster Manager.  Specifically how to add, delete and edit records.

• Phone lines enabled and connected to CALLMaster.

Create Audiotex Records/Modules and Associated Scripts

As all calls will be starting in Audiotex mode in this walkthrough, the Audiotex Modules will determine the call flow.

In the Audiotex set-up, the caller will be asked to input a variable length number, which will be played back to them.

We will need to create several Audiotex records as shown below.  The Label field provides a brief description of each module.  

Audiotex Module Description

• Module 1000 is the starting module.  We will use this module to initialize variables using script InitializeVal.bas.  In particular we want to set the Maximum Input Length (intMaxInputLen).  As we are allowing a variable length input, we will need the caller to enter a terminating digit such as *.  The intMaxInputLen must include the terminating digit. e.g. if we want caller to enter a number up to 5 digits then intMaxInputLen must be set to 6.  See sample code below.
• Module 1100 is used to get the caller's input using the GetDTMF command. As the input is variable length with a maximum length defined by intMaxInputLen, we need to make sure to define a terminating digit, an asterisk (*).  This script uses the StringLength command to make sure the caller has entered a number.  If they have not then the call will be forwarded to module 1190 for error processing.
• Module 1190 is to notify the caller that they have not entered any numbers.  The associated script, CheckTryCount.bas, gives the caller 3 attempts to make an input.  If the caller has not entered any keys after 3 attempts, processing will be forwarded to module 9920.
• Before we say the number entered back to the caller, we need to remove the last digit.  The script associated with module 1200 will make a new string variable without the last digit entered using the MemMove command.  This new variable will be used to say the number back to the caller using the SayNumeral command.
• Module 9920 is used to notify caller that they have reached the maximum attempts allowed for a valid input.  The script associated with this module can be used to set flags and route processing as required.
• Modules 9900 and 9910 are required to handle call failure and capture caller hang-up respectively.  Both these modules can be used to set flags and route processing as required.

Based on the Audiotex modules shown above, we will need several scripts. 

Let's create the scripts first.  Open Notepad and create scripts following code examples below.  Remember to save them as .bas type files in the Program Files\CALLMaster\Scripts folder.

Now you can create the Audiotex modules and reference the scripts above.  Open the CALLMaster Manager, click on Manage, then select Audiotex to add the Audiotex records shown above.

Define IVR Application List Entry

We need to define the custom IVR in the IVR Application List and set it to Audiotex Start Module 1000.  Open CALLMaster Manager and select Manage | IVR Application List.  Let's add a new record as follows:

Set Ports

As a last step, we need set the port(s) to the new IVR Application entry created above.  Make sure the Audiotex Start Module field (read only) correctly points to module 1000.

 Set the Port Greeting File IDs to the main greeting for all calls if you have recorded one.  If you do not want a main greeting then set the Greeting File IDs to zero. Leave all other fields to the default values.

If you are working with a demo license or have only one line connected, then make sure the connected port is set as specified below.  All other ports should be set to Application 'Disabled'.

Test the custom application

Save all your work. 

Stop CALLMaster service.

Make Administrator Audiotex Recordings:

-  Set Port 1 to Application Voice Mail.

-  Start CALLMaster service.

-  Make a call using Port 1.

-  Log in as the Administrator using the Voice Mail Main Menu and make recordings for the Audiotex modules below.

Reset Port 1 to Application Audiotex.  Set the Port Greeting File IDs to zeros.

Stop and Start CALLMaster service.

Make a phone call to test the application.

Tip: See Walkthrough: Change Application Without Restarting CALLMaster Service to set port to Voice Mail to make recording without stopping and restarting the CALLMaster service.