IVR Software Library
IVR Utility 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_speak_state()
int
ivr_speak_state(int call,char *text, int allow_interrupt)
The
ivr_speak_state function speaks a state name to the specified call. It
attempts to read the state from a wave file of the same name, stored in the
"States" folder. If the state can not be found, it is then read with
standard text-to-speech. You can re-record the states already in this folder,
or add new abbreviations such as MX for Mexico and CN for Canada.
Parameters
|
int
|
call
|
Specifies which call to speak to.
It can be one of the following values.
CALL_PRIMARY: Speak to Primary Call
CALL_SECONDARY: Speak to Secondary Call
|
|
char *
|
text
|
the state name to be read
|
|
int
|
allow_interrupt
|
Specifies if a digit can interrupt the
state name.
It can be one of the following values.
NO_INTERRUPT: Do not allow reading to be interrupted by a digit
INTERRUPT: Allow reading to be interrupted by a digit
|
Return Value
Returns
IVR_SUCCESS on a successful function call. On error the function returns one
of the IVR
Error Codes.
Example
ivr_speak_state(CALL_PRIMARY, "AZ",
INTERRUPT);
|
