Cisco Cisco Customer Voice Portal Downloads User Guide
C
HAPTER
2:
V
OICE
XML
S
ERVER
C
OMPONENTS IN
D
ETAIL
V
OICE
XML
S
ERVER
U
SER
G
UIDE
FOR
C
ISCO
U
NIFIED
C
USTOMER
V
OICE
P
ORTAL
R
ELEASE
4.0(1)
21
Hotevents
A hotevent is some developer-defined action performed whenever a VoiceXML event is
triggered. Hotevents can take two forms. The first simply moves the caller to a new part of the
call flow when the event is triggered, similar to a hotlink. In this case the hotevent can be defined
entirely in the Unified CVP VoiceXML Studio by the application designer and does not require
any additional work by a developer. The second form of a hotevent executes custom VoiceXML
content when the event is triggered (and may optionally also move to another part of the call
flow).
triggered. Hotevents can take two forms. The first simply moves the caller to a new part of the
call flow when the event is triggered, similar to a hotlink. In this case the hotevent can be defined
entirely in the Unified CVP VoiceXML Studio by the application designer and does not require
any additional work by a developer. The second form of a hotevent executes custom VoiceXML
content when the event is triggered (and may optionally also move to another part of the call
flow).
The second form requires a Java class that returns the VoiceXML to execute when the event is
triggered. This class is accessed once per call, not when the event is triggered. This is because
hotevents appear in the VoiceXML root document, which is generated when the application is
started or updated. For this reason the API provided to hotevents do not have access to call
information normally given to other components. The purpose of a hotevent is solely to produce
VoiceXML that will execute when the event is triggered.
triggered. This class is accessed once per call, not when the event is triggered. This is because
hotevents appear in the VoiceXML root document, which is generated when the application is
started or updated. For this reason the API provided to hotevents do not have access to call
information normally given to other components. The purpose of a hotevent is solely to produce
VoiceXML that will execute when the event is triggered.
A hotevent can be created to react based on a standard VoiceXML event such as nomatch or
noinput, but a more common use for a hotevent is to be triggered by a developer-specified or a
voice browser-specific event. For example, one can create a hotevent to play audio when a
custom event occurs.
noinput, but a more common use for a hotevent is to be triggered by a developer-specified or a
voice browser-specific event. For example, one can create a hotevent to play audio when a
custom event occurs.
As with any other component that produces VoiceXML, the hotevent utilizes the VFCs and
therefore can only be constructed with the Java API.
therefore can only be constructed with the Java API.