IVR Software Manual ivr_mixed_menu
  CALL CENTER SYSTEMS AND SOFTWARE RESOURCE CENTER
call centers

IVR Software Library
ivr_mixed_menu

IVR Software API Manual

ivr software manual functions Database Systems Corp. (DSC) provides an API subroutine library of IVR Software routines that perform phone functions The following is a description of one of the functions within this library that controls the IVR operation - ivr_mixed_menu.

The routine is from our C programming library, although this same routine has an equivalent for Visual Basic, .NET, C++ and Active-X. DSC provides a separate user guide for each of these languages.

Contact DSC to obtain the most current IVR manuals in your required programming language.



ivr_mixed_menu()

int ivr_mixed_menu(int call, IVRMIXEDPROMPTS *prompts, int numprompts, int allow_interrupt, int max_digits, int timeout, char termchar, int clear, IVRDIGITS *ivrd)

The ivr_mixed_menu function plays a series of menu items and retrieves the digits from the specified call. The menu items can either be text or wave files.

Parameters

int

call

Specifies which call to retrieve digits from. It can be one of the following values.

CALL_PRIMARY: Collect Digits from the Primary Call
CALL_SECONDARY: Collect Digits from the Secondary Call

IVRMIXEDPROMPTS *

prompts

Array of IVRMIXEDPROMPTS structures containing the pathnames or text of the prompts to play.

int

numprompts

Number of prompts in the prompts array.

int

allow_interrupt

Specifies if a digit can interrupt the prompts. It can be one of the following values.

NO_INTERRUPT: Do not allow prompts to be interrupted by a digit
INTERRUPT: Allow prompts to be interrupted by a digit

int

max_digits

The maximum number of digits to return. This must be less than 32.

int

timeout

The maximum amount of time in seconds to wait for the digits to be entered.

char

termchar

A specific character to terminate digit collection.

int

clear

Clear the buffer before digit collection. It can be one of the following values.

NO_CLEAR: Do NOT clear the buffer before digit collection
CLEAR: Clear the buffer before digit collection

IVRDIGITS *

ivrd

Structure of type IVRDIGITS in which the digits will be returned.

 


Return Value

Returns IVR_SUCCESS on a successful function call. On error the function returns one of the IVR Error Codes.

Example

IVRMIXEDPROMPTS prompts[4] = {
 {PROMPT_WAVE,"D:\\sounds\\Swelcome.wav"},
 {PROMPT_TEXT,"This is a text prompt."},
 {PROMPT_WAVE,"D:\\sounds\\SGoodbye.wav"},
 {PROMPT_TEXT,"Another Text Prompt"}
};

IVRDIGITS ivrd;

if(ivr_mixed_menu(CALL_PRIMARY,prompts,4,INTERRUPT,1,15,'*',
 '*',NO_CLEAR,&ivrd) != IVR_SUCCESS){
    ...handle error;
}