<bevocal:whisper>

Extension. Interrupts an outbound call, allowing the application to play audio output to the called third party while the user is on hold.

Syntax

 <bevocal:whisper
     call="js_expression" 
     transferaudio="URI"
 >
   Optional Content
 </bevocal:whisper>

Description

To use this tag, the containing <vxml> tag must declare the XML namespace bevocal by including the following attribute:

 xmlns:bevocal="http://www.bevocal.com/"

A <bevocal:whisper> element lets the application interrupt an active outbound call that was initiated by a <bevocal:dial> tag. During execution of the <bevocal:whisper> element:

 •  The application plays audio output for the called third party.
 •  The application ignores all speech and DTMF signals, whether from the user or from the called third party.
 •  The called third party can hear the application, but cannot hear the user.
 •  The user hears silence.

Note: This and other call-control tags constitute a BeVocal VoiceXML extension. Committees are currently working to standardize call-control features for VoiceXML, and their current approach is different from the BeVocal VoiceXML implementation. Because the approval of any call-control standards will be quite some time in coming, however, BeVocal VoiceXML contains this extension to allow developers to start taking advantage of call-control features. BeVocal will continue to monitor the development within these committees. If the features in the BeVocal VoiceXML extension become a part of VoiceXML or a separate call-control standard, BeVocal VoiceXML will implement that standard. We will then deprecate the current extension and provide developers with information on how to convert their applications to the new standard.

Attribute Description
call

JavaScript expression whose value is a JavaScript object that was initialized by <bevocal:dial>; specifies the call to be interrupted.

transferaudio

Audio (specified by the URI) to play to the user while the called third-party hears the application.

Note: This attribute is valid only for VoIP calls.

Tip:

 •  If a JavaScript expression contains any of the characters "<", ">", or "&", that character must be replaced with the corresponding escape sequence "&lt;", "&gt;", or "&amp;". For more information, see JavaScript Quick Reference.

Usage

Parents Children
<bevocal:foreach>
<block>
<catch>
<error>
<filled>
<help>
<if>
<noinput>
<nomatch>
<audio>
<break>
<emphasis>
<enumerate>
<mark>
<p>
<paragraph>
<phoneme>
<prosody>
<s>
<say-as>
<sentence>
<value>
<voice>

The following events may be thrown by the execution of a <bevocal:whisper> element:

Event Description
connection.far_end.disconnect

The specified outbound call has already been disconnected.

error.semantic

The call attribute is not a valid JavaScript expression or the expression does not evaluate to an object representing an active outbound call.

See Also

 •  Chapter  6, Controlling Outbound Calls
 •  Related tags: <bevocal:dial>, <bevocal:listen>

[Show Frames]   [FIRST] [PREVIOUS] [NEXT]
BeVocal, Inc. Café Home | Developer Agreement | Privacy Policy | Site Map | Terms & Conditions
Part No. 520-0001-02 | © 1999-2007, BeVocal, Inc. All rights reserved | 1.877.33.VOCAL