Cisco Cisco Unified Customer Voice Portal 11.0(1) Developer's Guide
C
HAPTER
2:
C
ISCO
U
NIFIED
CVP
API
I
NTRODUCTION
V
OICE
XML
P
ROGRAMMING
G
UIDE
FOR
C
ISCO
U
NIFIED
C
USTOMER
V
OICE
P
ORTAL
R
ELEASE
4.0(1)
8
While the XML API provides the same functionality as the Java API, there are some small
deficiencies. Firstly, there is additional overhead involved in the XML API since it involves the
creation and parsing of XML as well as the overhead inherent in HTTP communications. This
overhead, though, is not large as the XML documents involved are typically small and only a
single HTTP request and response are used per component. However the developer should test
their system to ensure that any overhead introduced is acceptable. Secondly, some components,
both Cisco Unified CVP and custom built, utilize Java classes as efficient mechanisms for
storing data. Using the Java API, these classes can be accessed and modified directly. The XML
API, however, will not be able to because it is a text-only interface designed to work identically
using different programming languages. A developer must be aware of this restriction before
designing components that rely on Java-only concepts.
deficiencies. Firstly, there is additional overhead involved in the XML API since it involves the
creation and parsing of XML as well as the overhead inherent in HTTP communications. This
overhead, though, is not large as the XML documents involved are typically small and only a
single HTTP request and response are used per component. However the developer should test
their system to ensure that any overhead introduced is acceptable. Secondly, some components,
both Cisco Unified CVP and custom built, utilize Java classes as efficient mechanisms for
storing data. Using the Java API, these classes can be accessed and modified directly. The XML
API, however, will not be able to because it is a text-only interface designed to work identically
using different programming languages. A developer must be aware of this restriction before
designing components that rely on Java-only concepts.
Due to the nature of XML and HTTP and the complexity of some Unified CVP components, the
XML API is available as an alternative only for some components. The components that can
utilize the XML API are: standard action and decision elements, dynamic element
configurations, and start and end of call actions. Since configurable elements require more
integration with Unified CVP VoiceXML Studio and Unified CVP VoiceXML Server, they can
only be created using the Java API.
XML API is available as an alternative only for some components. The components that can
utilize the XML API are: standard action and decision elements, dynamic element
configurations, and start and end of call actions. Since configurable elements require more
integration with Unified CVP VoiceXML Studio and Unified CVP VoiceXML Server, they can
only be created using the Java API.
DTD Diagrams
While the Java API has Javadocs for Cisco Unified Customer Voice Portal explaining what can
be done with the classes and methods in the API, the DTDs for every XML document sent either
as a request or a response is described within this document. A quick introduction to DTD
diagrams is warranted at this point in order to fully understand the XML API.
be done with the classes and methods in the API, the DTDs for every XML document sent either
as a request or a response is described within this document. A quick introduction to DTD
diagrams is warranted at this point in order to fully understand the XML API.
Figure 2-1