Cisco Cisco Unified Customer Voice Portal 10.5(1) Developer's Guide
C
HAPTER
2:
C
ISCO
CVP
V
OICE
XML
API Introduction
C
ISCO
CVP V
OICE
XML 3.1
Programmer
Guide
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 CVP VoiceXML 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.
their system to ensure that any overhead introduced is acceptable. Secondly, some components,
both Cisco CVP VoiceXML 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 CVP VoiceXML 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 CVP VoiceXML Studio and CVP VoiceXML Server, they can only be created
using the Java API.
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 CVP VoiceXML Studio and CVP VoiceXML Server, they can only be created
using the Java API.
DTD Diagrams
While the Java API has Javadocs 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.
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
Figure 2-1 shows a sample DTD diagram that contains most of what can be found in an XML
DTD. A DTD diagram is a graphical representation of a DTD, that explains how an XML
document is formatted. Due to the nature of XML, syntax is very important and DTD diagrams
describe the syntax of an XML document. The diagram shows the hierarchical structure of XML
by using a sideways tree display, listing tags and their child tags from left to right. The diagram
shows the attributes of tags as well as how those tags can be added to their parent tags.
DTD. A DTD diagram is a graphical representation of a DTD, that explains how an XML
document is formatted. Due to the nature of XML, syntax is very important and DTD diagrams
describe the syntax of an XML document. The diagram shows the hierarchical structure of XML
by using a sideways tree display, listing tags and their child tags from left to right. The diagram
shows the attributes of tags as well as how those tags can be added to their parent tags.
In the above diagram, the root tag is named parent. Tags are denoted by a blue diamond in its
box. parent has two attributes, attribute1 and attribute2 displayed in a red box emerging from
box. parent has two attributes, attribute1 and attribute2 displayed in a red box emerging from
Copyright 2001 - 2005 Audium Corporation. All Rights Reserved. 10/05
16