Developer's Guide

CHAPTER 3: SESSION API VOICEXML PROGRAMMING GUIDE

FOR CISCO UNIFIED CUSTOMER VOICE PORTAL RELEASE 4.0(1)

The tags in this XML document are:

application – The root tag. The key and serial attributes are used by VoiceXML Studio and

the VoiceXML Server and can be safely ignored here. The version attribute holds the

version of the file. The above diagram represents version 1.2 of the DTD. The

subdialog

attribute holds a true if the application is accessed as a subdialog, false if not.

maintainer – This tag holds the e-mail address of the maintainer.

language – This tag holds the language for the application. This value shows up in the

VoiceXML pages produced by Unified CVP VoiceXML Server. The contents of this tag is

formatted according to the specification for using languages in VoiceXML (e.g. “en-US”).

encoding – This tag holds the encoding format for the application. This value determines

how the VoiceXML pages produced by Unified CVP VoiceXML Server are encoded. The

contents of this tag is formatted according to the specification for encoding XML pages (e.g.

“UTF-8”).

audio – This tag holds all audio files and/or TTS phrases to use for various situations.

o error – This tag encapsulates the message to play when an error occurs and the

application does not contain an error element.

o suspended – This tag encapsulates the message to play when a caller calls an application

that is suspended.

o initial_on_hold – This tag encapsulates the first message a caller hears when all the

VoiceXML Server ports are in use.

o main_on_hold – This tag encapsulates the message repeatedly played after the initial on

hold audio is played until a VoiceXML Server port is available.

o default_path – This tag lists the URI path in which all pre-recorded audio for this

application is located.

session_timeout – This tag lists the length of time in minutes of inactivity Unified CVP

VoiceXML Server will time out the call session.

voice_browser – This tag lists the voice browser selected for this application. Note that the

real name of the voice browser is used here, not the display name. Gateway Adapter real

names can be seen by reading the folder name for that adapter in the

gateways folder of the

VoiceXML Server.

user_management – This tag encapsulates information concerning the user management

database. The <database> tag’s jndi_name attribute contains the JNDI name for the

database and the tag itself contains the database to use, which is either “MySQL” or

“SQLServer”.

endpoints – This tag encapsulates actions to perform at the endpoints of an application and a

call.