Cisco Cisco Unified Customer Voice Portal 11.0(1) Developer's Guide

C

HAPTER 

4:

 

C

ALL 

S

TART 

A

CTION

 

 

P

ROGRAMMING 

G

UIDE FOR 

C

ISCO 

U

NIFIED 

CVP

 

VXML

 

S

ERVER 

 

 

 

AND 

C

ISCO 

U

NIFIED 

C

ALL 

S

TUDIO 

R

ELEASE 

4.1(1) 

 

 

23 

The tags in these XML documents are: 

•

 

– This tag holds the session data to be created. Any number of 

<session>

 tags can 

appear, one for each session data variable to be created. Note that element data cannot be 
created because the call start action is not an element. 

•

 

– This tag is used to associate the call to a UID in the user management system. The 

content of the tag should be the integer UID. 

•

 

– This tag is used to trigger logger events for this application. Any number of  

<custom>

 

tags can appear, denoting the triggering of a custom event. The 

name

 attribute holds the name 

of the data, and the 

<custom>

 tag encapsulates the value. Any number of 

<warning>

 tags can 

appear, denoting the triggering of a warning event. The 

<warning>

 tag encapsulates the 

warning message.  

•

 

– This tag reports to VXML Server that an error occurred while executing the call start 

action. VXML Server will then throw an exception whose message is contained in the 

<error>

 tag. This allows the XML API to throw exceptions just as the Java API does. 

•

 

– This tag is used to change the default audio path.  

•

 

– This tag is used to change the maintainer e-mail address. 

•

 

– This tag is used to change the voice browser for this particular call. 

Note that the real name of the voice browser must be 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 VXML Server. 

•

 

– This tag allows the timeout length set for this session to be changed. The 

contents of the tab must be an integer representing the number of minutes in the timeout. 

•

 

– This tag allows the encoding and language settings for the 

application to be changed for this call. The 

<language>

 tag content is formatted according to 

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

<encoding>

 tag 

content is formatted according to the specification for encoding XML pages (e.g. “UTF-8”). 

•

 

– This tag allows for the addition and removal of VoiceXML 

properties and variables. The 

<delete>

 tag is necessary only if properties or variables were 

set in the application’s project pane in Call Studio and due to runtime circumstances the call 
start action determines they are no longer needed. The 

name

 attribute specifies the property or 

variable name and the tag contents encapsulates the value. 

Note that all the tags are optional, there is no tag required except for the root 

<result>

 tag. 

Since the XML API requires a document in response, it is acceptable to return an XML 
document whose 

<result>

 tag is empty.