Cisco Cisco Customer Voice Portal 8.0(1) Developer's Guide
•
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
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 (that is, 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
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
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
applicable), etc. This data appears exactly as in the user database. See
(http://www.cisco.com/en/US/
products/sw/custcosw/ps1006/products_user_guide_list.html), Chapter 4, section User
Management, for more information on user management.
Management, for more information on user management.
•
user_by_ani – This tag appears only if the application is configured to use the user
management system, though unlike
management system, though unlike
<user>
, the tag appears 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.
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
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).
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>
can be 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).
application), error (an error occurred during the call), timeout (the session timed out) and
invalidated (the session was invalidated by an element).
Note: The
invalidated
attribute of
<call_ended>
also indicates if the session was
invalidated by an element.
XML Document Sent in “settings”
The following example shows the DTD diagram for the XML document sent to all components
in the settings argument. Its DTD is defined in the file
in the settings argument. Its DTD is defined in the file
Settings.dtd
in the VXML Server
dtds
folder.
Note: This document shares the same DTD as the static application settings file
settings.
xml
created when an application is deployed from Call Studio to VXML Server. This document
Programming Guide for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 8.0(1)
23
Chapter 3: Session API
XML API