Developer's Guide

CHAPTER 3: SESSION API VOICEXML PROGRAMMING GUIDE

FOR CISCO UNIFIED CUSTOMER VOICE PORTAL RELEASE 4.0(1)

telephony – This tag holds information about the call itself such as the ANI. It also contains

the area code and exchange of the ANI. All values are “NA” if not sent by the voice browser

(area code and exchange won’t appear at all in the case that the ANI is not sent).

call – This tag holds call information. The session ID is used by Unified CVP VoiceXML

Server to identify the call. The <source> tag, if applicable, contains the name of the

application that transferred to this one (the tag does not appear if application visit is a new

call). <start> contains when the call started. <application> contains the name of the

application.

history – This tag holds the history of elements visited so far in the call. The name and exit

state of the element is included as attributes to a <visited> tag. Multiple tags are listed in

the order in which the elements were visited in the call. The

<history> tag will not appear if

no elements were visited before this one (i.e. the start of the call).

data – This tag holds all the element and session data created so far in the call. The

<element> tag’s name attribute holds the name of the element. All the variables created by

this element appear in this tag. The log attribute indicates whether this variable’s value will

appear in the activity log file (no session variables appear in the log). The <data> tag will not

appear if no element or session data exist. If the session data variable holds a Java class, the

tag will contain the results of the toString() method called on that object.

user – This tag appears only if the application is configured to use the user management

system and the call has been associated with a particular UID. The <demographics> tag

holds the user demographic information. The <account> tag contains information about the

account such as when it was created and modified, the account number and pin (if

applicable), etc. This data appears exactly as in the user database. See Chapter 4: User

Management in the VoiceXML Server User Guide for Cisco Unified Customer Voice Portal

for more on user management.

user_by_ani – This tag appears only if the application is configured to use the user

management system, though unlike <user>, the tag will appear even if the call is not

associated with a UID. The tag holds information about the number of calls made to this

application by the current phone number and the last time a call was received to the

application by that number.

call_ended – This tag appears only when being sent as a request to an end of call event. It

defines how the call ended and the result of the call. The possible content of

<how> are:

hangup (the caller hung up), disconnect (the application hung up on the caller),

application_transfer (the application visit ended by transferring to another application),

call_transfer (a blind transfer took place) and app_session_complete (the application visit

ended even if the call itself continued - such as via a CTI event). The possible content of

<result> are normal, max_ports (the caller hung up while on hold waiting to enter the

application), suspended (the caller called into a suspended application), error (an error

occurred during the call), timeout (the session timed out) and invalidated (the session was

invalidated by an element). Note that the

invalidated attribute of <call_ended> also

indicates if the session was invalidated by an element.