CallXML 3.0 Development GuideHome  |  Frameset Home


<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
<playmoney cache="(yes|no)" cleardigits="(true|false)" format="(us)" id="(element id)" termdigits="(123456789*#|ABCD)" test="CDATA" value="URI" value-is="STRING" value-is-not="STRING">


attributes
cacheData 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.
cleardigitsData Type: (true|false)Default: none - attribute is optional
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.
formatData 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.
idData Type: (element id)Default: none - attribute is optional
The new 'id' attribute in CallXML3.0 is applicable to all container and action elements. Specifying this attribute allows yet another level of control and event handling when events occur and are caught by the <on> element. When an event occurs, the handler will first check the event, and then verify that the handler has a handler specific to the 'id' attribute to execute. This allows the developer to plan a specific course of action for events based on where in the application that they occur.
termdigitsData 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".
testData Type: CDATADefault: Optional
The 'test' attribute is a new supplement to the CallXML markup that permits the developer to execute the contents of a container element, or action element, based on whether or not the specified condition is met. If the defined condition is met, then the code contained within the element is then executed. If the condition is not met, then the application resumes execution with the next sequential container container element in the document.
valueData Type: URIDefault: none - attribute is required
The 'value' attribute defines the audio file to play to the caller when the parent element is first entered.
value-isData Type: STRINGDefault: none - attribute is optional
Another new attribute, 'value-is', grants the developer with the ability to perform conditional logic upon container elements, or action elements for the first time within the CallXML markup. The value specified in the 'value-is' attribute specifies a string to compare against any 'value' attributes. If the 'value' and 'value-is' equate to 'true', then the element specified will execute. If the value equates to 'false' then the element will be skipped during document execution.
value-is-notData Type: STRINGDefault: none - attribute is optional
Another new attribute, 'value-is-not', grants the developer with the ability to perform conditional logic upon container elements, or action elements, for the first time within the CallXML markup. The value specified in the 'value-is-not' attribute specifies a string to compare against any 'value' attributes. If the 'value' and 'value-is-not' equate to 'false', then the element specified will execute. If the value equates to 'true' then the element will be skipped during document execution.



code samples
<3.0 playmoney-format-value-choices>
<?xml version="1.0" encoding="UTF-8"?>

<callxml version="3.0">
  <do repeat="3">
    <prompt value="Yes, thats right kids!
      The Ronco cheese grater and bunyan
      polisher is available for only"/>

    <playmoney format="us" value="29.95" choices="#"/>

    <prompt value="Press the pound key to order now.
      Operators are Standing By" choices="#"/>

    <on event="choice:#">
      <prompt value="Your order for crappy Ronco
                    products has been processed.
                    Thanks for calling"/>
    </on>

  </do>
</callxml>


<3.0 playmoney-id-test-cache>
<?xml version="1.0" encoding="UTF-8"?>

<callxml version="3.0">

  <do repeat="3">

    <prompt value="I got my mind on my money.
      And my money on my mind.
      Press the pound key when you hear a value you like, G Dogg"/>

    <!-- this will be played -->
    <playmoney format="us" value="99.95" choices="#"
                  id="PM1" test="1=1" cache="yes"/>


    <!-- this will be played -->
    <playmoney format="us" value="99.96" choices="#"
                  id="PM2" test="1!=2" cache="yes"/>


    <!-- this will NOT be played -->
    <playmoney format="us" value="99.97" choices="#"
                    id="PM3"
                    test="&apos;masterP&apos;=&apos;originalG&apos;"
                    cache="yes"/>


    <!-- this will be played -->
    <playmoney format="us" value="99.98" choices="#"
                  id="PM4"
                  test="&apos;masterP&apos;!=&apos;originalG&apos;"
                  cache="yes"/>


    <!-- this will be played -->
    <playmoney format="us" value="99.99" choices="#"
                  id="PM5" test="PDiddy" cache="yes"/>



    <on event="choice:#" target="PM1">
      <log>** termdigit caught from ID: PM1 **</log>
      <prompt value="Word up"/>
    </on>

    <on event="choice:#" target="PM2">
      <log>** termdigit caught from ID: PM2 **</log>
      <prompt value="Word up"/>
    </on>

    <on event="choice:#" target="PM4">
      <log>** termdigit caught from ID: PM4 **</log>
      <prompt value="Word up"/>
    </on>

    <on event="choice:#" target="PM5">
      <log>** termdigit caught from ID: PM5 **</log>
      <prompt value="Word up"/>
    </on>

  </do>

</callxml>


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

<cfheader name="Cache-Control" value= "no-cache">
<cfheader name="Expires" value="#Now()#">

<callxml version="3.0">

  <do value="gene">

    <prompt value="I got my money on my mind.
                  And my mind on my money"/>
    </say>

    <!-- this will be played -->
    <playmoney format="us" value="99.95" value-is="gene"/>

    <!-- this will NOT be played -->
    <playmoney format="us" value="99.96" value-is="ace"/>

    <!-- this will be played -->
    <playmoney format="us" value="99.97" value-is-not="paul"/>

    <!-- this will NOT be played -->
    <playmoney format="us" value="99.98" value-is-not="gene"/>


  </do>

</callxml>




additional links
none


  ANNOTATIONS: EXISTING POSTS
0 posts - click the button below to add a note to this page

login



© 2008 Voxeo Corporation  |  Voxeo IVR  |  VoiceXML & CCXML IVR Developer Site