Cisco Cisco Unified Customer Voice Portal 10.0(1) Guía Del Desarrollador
C
HAPTER
2:
C
ISCO
CVP
V
OICE
XML
API Introduction
C
ISCO
CVP V
OICE
XML 3.1
Programmer
Guide
Chapter 2: Cisco CVP VoiceXML API Introduction
Cisco CVP VoiceXML’s API design has three goals: to be simple to use, to provide all the
information a developer may need, and to allow the use of as many programming languages as
possible. The API is used for simple tasks such as getting the ANI of the call or complex tasks
such as creating a custom voice element. The API defines some mechanisms for custom
components to integrate with CVP VoiceXML Studio, though the API is primarily used to create
components for integration with CVP VoiceXML Server.
information a developer may need, and to allow the use of as many programming languages as
possible. The API is used for simple tasks such as getting the ANI of the call or complex tasks
such as creating a custom voice element. The API defines some mechanisms for custom
components to integrate with CVP VoiceXML Studio, though the API is primarily used to create
components for integration with CVP VoiceXML Server.
Cisco CVP VoiceXML provides a Java API, which is the most efficient way to interface with
CVP VoiceXML software. The Java API is also the most comprehensive, all components can be
constructed using it. It is also the only way to build the components that require integration with
CVP VoiceXML Studio. Many components can be built with an equivalent API called the XML
API. This API works by sending and receiving XML documents over an HTTP connection. This
scheme allows for the use of any programming language with the ability to create and parse
XML and handle HTTP connections. Languages such as Perl or ASP in conjunction with a web
server like Apache are sufficient to interface with CVP VoiceXML Server using the XML APIs.
The requirement for integrating with CVP VoiceXML Studio must be through Java, so the XML
API is used to construct only those components that need to integrate with Studio. The table
below lists each component, which API can be used to construct it, and whether that component
must integrate with Studio.
CVP VoiceXML software. The Java API is also the most comprehensive, all components can be
constructed using it. It is also the only way to build the components that require integration with
CVP VoiceXML Studio. Many components can be built with an equivalent API called the XML
API. This API works by sending and receiving XML documents over an HTTP connection. This
scheme allows for the use of any programming language with the ability to create and parse
XML and handle HTTP connections. Languages such as Perl or ASP in conjunction with a web
server like Apache are sufficient to interface with CVP VoiceXML Server using the XML APIs.
The requirement for integrating with CVP VoiceXML Studio must be through Java, so the XML
API is used to construct only those components that need to integrate with Studio. The table
below lists each component, which API can be used to construct it, and whether that component
must integrate with Studio.
CVP VoiceXML Component
Build With
Java API
Build With
XML API
Studio
Integration
On Call Start / On Call End Actions
Yes
Yes
No
Dynamic Element Configurations
Yes
Yes
No
Generic Action and Decision Elements
Yes
Yes
No
Configurable Elements
Yes
No
Yes
Say It Smart Plugins
Yes
No
Yes
Hotevents Yes
No
No
On Error Notification
Yes
No
No
Java API
There are two parts of the CVP VoiceXML Java API: a set of Java interfaces and classes that are
implemented or extended to build a custom component and a set of classes used by those
components to obtain information on the environment in which the call is occurring. Each
component implements or extends a different class, though many of them share a common base.
Similarly, the class used to obtain environment information differs for each component, though
each of those classes share a common base class.
implemented or extended to build a custom component and a set of classes used by those
components to obtain information on the environment in which the call is occurring. Each
component implements or extends a different class, though many of them share a common base.
Similarly, the class used to obtain environment information differs for each component, though
each of those classes share a common base class.
The classes used to obtain and change environment information are referred to as the Session
API. All components receive an instance of one of the classes to act as the conduit between the
API. All components receive an instance of one of the classes to act as the conduit between the
Copyright 2001 - 2005 Audium Corporation. All Rights Reserved. 10/05
10