Notes for OpenIVR
-----------------

Craig Southeren, 14 August 2002

1. Introduction
---------------

OpenIVR is a simple IVR answering machine for the H.323 protocol that uses the
VXML scripting protocol. It uses the OpenH323 protocol stack
(http:/www.openh323.org), and can use Festival (http://www.festvox.org)
or Microsoft SAPI for text to speech conversion.


2. Features
-----------

The code contains the following features:

- requires no codec hardware to operate

- requires no audio hardware to operate

- currently supports G.723.1, G.711 muLaw and ALaw, GSM, Microsoft MS-GSM
  and LPC10 codecs

- can accept multiple connections simultaneously

3. Operation
------------

OpenIVR has a http interface, which can be accessed on port 42420. When running,
use the URL https://ip:42420 to access the page. The default username and
password are admin and changeme. Note the URL is https - not http.

A simple VXML script is provided that will make a simple announcment. Note that
if Festival or SAPI is not available then nothing will be heard - sorry!

Linux:

OpenIVR can run as a daemon or a standalone program. Use "openivr -h" to
display the options

Windows:

OpenIVR can run as a service or as a standalone program. To run in standalone
mode use the command "openivr debug". To install as a service,
use "openivr install", then use "openivr start" or "openivr stop" or the
services control panel to start and stop.

4. VXML
-------

A sample VXML script is provided. For more information, see http://www.vxml.org
or http://www.voicexml.org


                              ------------------------

$Log: ReadMe.txt,v $
Revision 1.3  2002/08/21 10:49:14  rogerh
Fix mixtake in login instructions

Revision 1.2  2002/08/21 09:32:10  rogerh
Add new url for xvml

Revision 1.1  2002/08/14 07:21:39  craigs
Initial version

