Developer's Guide

CHAPTER 5: CALL END ACTION VOICEXML PROGRAMMING GUIDE

FOR CISCO UNIFIED CUSTOMER VOICE PORTAL RELEASE 4.0(1)

The tags in these XML documents are:

new_data – 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 end action is not an element.

set_uid – 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.

log – 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.

error – This tag reports to Unified CVP VoiceXML Server that an error occurred while

executing the call end action. The VoiceXML 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. Note that since the call has ended, there would be no adverse affect to

the call itself, though an error event will be thrown.

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

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

vxml_response – This optional tag encapsulates the VoiceXML page that is to be passed to

the voice browser for the final response. It is expected to contain a CDATA tag that

encapsulates the entire VoiceXML document as it is to be returned to the voice browser

(including the first line starting with <?xml).The developer is responsible for ensuring the

VoiceXML is correct as the VoiceXML Server does no validation of the VoiceXML before

returning it to the browser. Note that since the VFCs are not used to generate the VoiceXML

like the Java API, the developer is responsible for ensuring the VoiceXML is compatible

with the voice browser(s) being deployed to.

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.