Cisco Cisco Unified Customer Voice Portal 10.5(1) Developer's Guide
V
OICE
E
LEMENT
: T
RANSFER
C
ISCO
CVP V
OICE
XML 3.1
Element Specifications
Transfer
The Transfer voice element performs a call transfer to a phone number specified by a configuration setting. Depending on how the
voice browser is configured, the call transfer can be a bridge transfer or a blind transfer. For a bridge transfer, the voice browser makes
an outbound call while maintaining the original call and acts as a bridge between the two calls. The advantage of this is that once the
secondary call ends, the original call can still continue with the IVR. The disadvantage is that two separate phone lines are used. For a
blind transfer, the voice browser makes an outbound call to the callee and leaves the connection regardless of the outcome. At this
point, the voice browser (and as a result CVP VoiceXML Server) is no longer in control of the call. Blind transfers involve only one
line.
voice browser is configured, the call transfer can be a bridge transfer or a blind transfer. For a bridge transfer, the voice browser makes
an outbound call while maintaining the original call and acts as a bridge between the two calls. The advantage of this is that once the
secondary call ends, the original call can still continue with the IVR. The disadvantage is that two separate phone lines are used. For a
blind transfer, the voice browser makes an outbound call to the callee and leaves the connection regardless of the outcome. At this
point, the voice browser (and as a result CVP VoiceXML Server) is no longer in control of the call. Blind transfers involve only one
line.
The Transfer element defines exit states for the different ways bridge transfers can end such as the person being called hung up, there
was no answer, there was a busy signal, or some other phone-related error occurred. Since blind transfers take the call away from the
voice browser and CVP VoiceXML Server, a Transfer element performing a blind transfer would never return an exit state. Instead, a
special event would be thrown by the voice browser, caught in the root document for the call, and CVP VoiceXML Server would
terminate the session by interrupting the Transfer element.
was no answer, there was a busy signal, or some other phone-related error occurred. Since blind transfers take the call away from the
voice browser and CVP VoiceXML Server, a Transfer element performing a blind transfer would never return an exit state. Instead, a
special event would be thrown by the voice browser, caught in the root document for the call, and CVP VoiceXML Server would
terminate the session by interrupting the Transfer element.
The number to transfer to can be any phone number allowed by the voice browser telephony provider. Check the browser
documentation for specific requirements and restrictions for call transfer.
documentation for specific requirements and restrictions for call transfer.
Settings
Name (Label)
Type
Req’d
Single
setting
value
Substitution
allowed
Default
Notes
transfer_destination
(Transfer Destination)
(Transfer Destination)
string
Yes
true
true
None
The phone number to transfer to. It may contain non-
numerical characters to allow support for phone extensions.
numerical characters to allow support for phone extensions.
destination_type
(Destination Type)
(Destination Type)
string
Yes
true
True
tel
The type of transfer destination to which the voice element is
to connect. Possible values are:
to connect. Possible values are:
tel
|
sip
.
connect_timeout
(Connect Timeout)
(Connect Timeout)
int > 0
Yes
true
true
60
The number of seconds the voice element is allowed to wait
for an answer, after which it will exit with the "noanswer" exit
state. Note that this setting only applies to the bridge mode.
for an answer, after which it will exit with the "noanswer" exit
state. Note that this setting only applies to the bridge mode.
max_transfer_time
(Max Transfer Time)
(Max Transfer Time)
int > 0
No
true
true
Browser
default
default
The maximum duration (in seconds) the transfer is allowed to
last. By default, it is an infinite amount of time, so the setting
should be configured only if a limit is required. Note that
max_transfer_time only applies to the bridge mode.
last. By default, it is an infinite amount of time, so the setting
should be configured only if a limit is required. Note that
max_transfer_time only applies to the bridge mode.
Copyright 2001 - 2005 Audium Corporation. All Rights Reserved. 10/05
86