CallXML 3.0 Development GuideHome  |  Frameset Home


<playnumber>  element

This element is used to play a digit or number value to the caller. The format may either be specified as a digit output, or a numeric output. Any value less than 50 characters long is considered acceptable for this value; going over this limit will result in an event: error "document" (invalid number value) error in the Voxeo Logger.


usage
<playnumber cache="(yes|no)" cleardigits="(true|false)" format="(digits|number)" id="(element id)" termdigits="(123456789*#|ABCD)" test="CDATA" value="(1234567890)" 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: (digits|number)Default: Optional (digits)
The 'format' attribute defines the string formatting  to use for the <play> element. In the case of the playnumber element, this defines whether the variable value should be read off as a digit or a numeric value.
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: (1234567890)Default: Required
The value attribute defines the numeric string to be played to the caller when the playnumber element is executed. Note that non-numeric characters, (including # and *), will cause a fatal application error, if specified as values in this attribute.
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 playnumber format-value-choices>
<?xml version="1.0" encoding="UTF-8"?>

<callxml version="3.0">
  <do label="B_1">

    <prompt value="Once the digits play, press the pound key"/>

    <playnumber format="digits" value="123" choices="#"/>

    <wait value="3s"/>
   
    <on event=" choice = #">
      <goto value="#B_2"/>
    </on>

  </do>

  <do label="B_2">
  <prompt value="Once the number plays, press the pound key"/>

    <playnumber format="number" value="123" choices="#"/>

    <wait value="3s"/>
   
    <on event="choice:#">
      <prompt value="Playing the numbers is a crime.
                    Unless you are a Mobster, that is"/>
    </on>

  </do>

</callxml>


<3.0 playnumber-id>
<?xml version="1.0" encoding="UTF-8"?> 
<callxml version="3.0">

  <block label="B_1" repeat="4">

    <prompt value="Press the pound key when you
                  are sure that you have Jennys number"/>
    </say>


    <playnumber format="digits" value="86" id="PN1" choices="#"/>
    <playnumber format="digits" value="75" id="PN2" choices="#"/>
    <playnumber format="digits" value="30" id="PN3" choices="#"/>
    <playnumber format="digits" value="9"  id="PN4" choices="#"/>


  <on event="choice:#" target="PN1">
    <prompt value="You got it. while play number ID PN1 was in progress"/>
  </on>

  <on event="choice:#" target="PN2">
    <prompt value="You got it. while play number ID PN2 was in progress"/>
    <exit/>
  </on>

  <on event="choice:#" target="PN3">
    <prompt value="You got it. while play number ID PN3 was in progress"/>
    <exit/>
  </on>

  <on event="choice:#" target="PN4">
    <prompt value="You got it. while play number ID PN4 was in progress"/>
    <exit/>
  </on>

  </block>

</callxml>


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

<callxml version="3.0">
 
  <block label="B_1" repeat="3">

    <prompt value="Hey, Jenny, whats the number"/>

  <!-- this will not play, as '1' is not equal to '2' -->
    <playnumber format="digits" value="777" cache="yes" test="1=2"/>

  <!-- this will play, as as '1' is not equal to '2 -->
    <playnumber format="digits" value="867" cache="yes" test="1!=2"/>

  <!-- this will not play, as 'TommyTuTone' is not equal to 'Liberace' -->
    <playnumber format="digits" value="555" cache="yes"
              test="&apos;TommyTuTone&apos; = &apos;Liberace&apos;"/>


  <!-- this will play, as 'TommyTuTone' is equal to 'TommyTuTone' -->
    <playnumber format="digits" value="5309" cache="yes"
              test="&apos;TommyTuTone&apos; = &apos;TommyTuTone&apos;"/>

   
    <say>
      I got it.
      I got it.
      8 6 7 5 3 0 9.
    </say>

  </block>


</callxml>


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

  <do label="B_1" value="TommyTuTone">

    <prompt value="Hey, Jenny, whats the number"/>

<!-- this will not play. and who would want to hear Stryper, anyhow -->
    <playnumber format="digits" value="777" value-is="Stryper"/>

<!-- this will play, as 'IronMaiden' is not equal to 'TommyTuTone' -->
    <playnumber format="digits" value="867" value-is-not="IronMaiden"/>

<!-- this will not play, as 'TommyTuTone' is equal to 'TommyTuTone' -->
    <playnumber format="digits" value="555" value-is-not="TommyTuTone"/>

<!-- this will play, as 'TommyTuTone' is not equal to 'TommyTuTone' -->
    <playnumber format="digits" value="5309" value-is="TommyTuTone"/>
     
    <say>
      I got it.
      I got it.
      8 6 7 5 3 0 9.
    </say>


  </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