CallXML 2.0 Development Guide

Home | Frameset Home

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.

<playmoney> element

The <playmoney> element allows the developer to render a monetary amount to the caller via Text-to-Speech. The allowable ranges for this element are between '.00' and '999999999.99'.

usage

attributes

cache	Data Type: (yes\|no)	Default: none - attribute is optional
	Allows manual override over the caching mechanism. If this attribute is empty the default system caching is used. "yes" should force the system to use the cache all the time, "no" means that no cache should be used at all.
cleardigits	Data Type: (true\|false)	Default: false
	This attribute's value is a Boolean, indicating whether the queued digits buffer should be cleared when this action starts. "true" clears the digits buffer; "false" leaves the contents of the digit buffer alone.
format	Data Type: (us)	Default: Optional (us)
	The 'format' attribute defines the string formatting to use for the <playmoney> element. AT this time, the only supported value for this attribute is "us", for United States denominations.
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: string - URI	Default: none - attribute is required
	The 'value' attribute defines the audio file to play to the caller when the parent element is first entered.

possible events

onerror type="linenotactive"	Trying to issue a telephony event such as <getdigits> or <playaudio> on a non-active line
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.
onerror type="document"	Document was unable to be fetched for all the reasons web servers are unavailable

code samples

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

<callxml version="2.0">
<block repeat="3">
<text>
Yes, thats right kids!
The Ronco cheese grater and bunyan polisher is available for only
</text>
<playmoney format="us" value="29.95" termdigits="#"/>

<text termdigits="#">
Press the pound key to order now.
Operators are Standing By.
</text>

<ontermdigit value="#">
<text>
Your order for crappy Ronco products has been processed.
Thanks for calling.
</text>
</ontermdigit>

</block>
</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page