<bevocal:hold>

Extension. Places an outbound call on hold.

Syntax

 <bevocal:hold
     call="js_expression" 
     transferaudio="URI"
 />

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:hold> tag affects an outbound call that was initiated by a <bevocal:dial> tag; it disconnects the voice path between the user and the called third party, putting the third party on hold. The call remains on hold until reconnected with a <bevocal:connect> tag.

While the call is on hold:

•	The user can hear and talk to the application.
•	The application listens to the user and plays audio output for the user.
•	The called third party hears silence.
•	Neither the user nor the application can hear the called third party

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 put on hold.

transferaudio
Audio (specified by the URI) to play to the third-party while on hold.

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 "`<`", "`>`", or "`&`". For more information, see JavaScript Quick Reference.

Usage

Parents Children

<bevocal:foreach> <block> <catch> <error> <filled> <help> <if> <noinput> <nomatch>
None

The following events may be thrown by the execution of a <bevocal:hold> tag:

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 outbound call.

See Also

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

[Show Frames] [FIRST] [PREVIOUS] [NEXT]

Parents	Children
`<bevocal:foreach>` `<block>` `<catch>` `<error>` `<filled>` `<help>` `<if>` `<noinput>` `<nomatch>`	None

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 outbound call.