callxml elements

CallXML 2.0 Development Guide

This documentation is for CallXML 2, which has been superceded by CallXML 3. The CallXML 2 language is not being updated any longer. CallXML 3, however, has many new features and is actively being enhanced. If you're writing a new CallXML application, you should use CallXML 3. Click here for the CallXML 3.0 documentation.

<wait> element

The wait element is used to instruct the CallXML browser to wait for a specified amount of time. This is most often used when you need to allow certain content within your code additional time to execute.

usage

<wait termdigits="(123456789*#|ABCD)" value="(m|s|ms)">

attributes

termdigits	Data Type: (123456789*#\|ABCD)	Default: none - attribute is optional
	This attribute holds the list of touch-tone digits which can terminate the current caller action. Note that for each termdigit specified, there should be an <ontermdigit> handler in the code to catch the event. Allowable values are any one of "012356789*#", the ordinary DTMF (Touch-Tone) keypad possibilities, plus the special keypad tones found on some telephones "ABCD".
value	Data Type: (m\|s\|ms)	Default: none - attribute is required
	The time string format is: <numeric value>[<optional qualifier>] \| nolimit The string begins with a required numeric value. The valid qualifiers are: m: minutes s: seconds (default) ms: milliseconds Example: "45m 33s 117ms" Note that if no qualifier is specified, an "s" qualifier is assumed. No combinations of qualifiers are allowed. If there is a need to specify an unlimited amount of time, simply use the key word "nolimit".

possible events

onerror type="document"	Document was unable to be fetched for all the reasons web servers are unavailable
onerror type="telephony"	Unable to issue a telephony event such as <call> or <playaudio> or <ftp>
ontermdigit	Used for catching and handling term digit events as they occur in the call flow. See the ontermdigit element description for further details.
onhangup	This event occurs when a session determines that one side of the call has hung up. A typical use for this handler is to execute any necessary clean-up code. See the onhangup element description for further details.

code samples

<?xml version="1.0" encoding="UTF-8"?>

<callxml version="2.0">
<block>
<text>
Preparing to demonstrate the wait element.
You will be able to press the star key at any time to stop waiting.
</text>

<wait value="nolimit" termdigits="*"/>

<ontermdigit value="*">
<text>
The wait is now over, my little love bucket.
You are free to go about your bidness.
</text>
</ontermdigit>

</block>
</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

zscgeek

8/31/2006 7:29 PM (EDT)

One thing to note is that a value attribute of "0s" also is treated as nolimit meaning CallXML will wait for ever.