IVR Software Library
IVR Library Routine Descriptions
The following routine or parameter is maintained in the PACER and WIZARD IVR software library. These routines are developed for programmers who are creating and managing IVR application programs.
IVR programs can be written in C/C++ on Windows, Unix and Linux operating environments.
ivr_get_digits()
int
ivr_get_digits(int call, int max_digits, int timeout, char termchar, int clear,
IVRDIGITS *ivrd)
The
ivr_get_digits function waits for digits to be entered from the
specified call.
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
|
|
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
Return
IVR_SUCCESS on a successful function call. On error the function returns one
of the IVR Error Codes.
Example
IVRDIGITS ivrd; if(ivr_get_digits(CALL_PRIMARY,3,10,'*',CLEAR,&ivrd) != IVR_SUCCESS){ ...handle error; }
|
