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.

<playdate>  element


The <playdate> element is used to render a given date to the caller via Text-to-Speech.


usage

<playdate cache="(yes|no)" cleardigits="(true|false)" format="ddmmyyyyhhnn" termdigits="(123456789*#|ABCD)" value="string - URI">


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: ddmmyyyyhhnn Default: Optional (ddmmyyyyhhnn)
The 'format' attribute defines the string formatting  to use for the <play> element.

Note that only the following format values are allowed:

<!-- day month year hour minutes -->
<playdate format="ddmmyyyyhhnn" value="180519700612"/>
<!-- day month -->
<playdate format="ddmm" value="1805"/>
<!-- hour minutes -->
<playdate format="hhnn" value="0732"/>
<!-- month day year -->
<playdate format="ddmmyyyy" value="18051970"/>
<!-- month day -->
<playdate format="ddmm" value="1805"/>

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



code samples

<Playdate format - value - termdigits>
<?xml version="1.0" encoding="UTF-8"?>

<callxml version="2.0">
  <block>

    <text>
      The dates are
    </text>

      <!-- day month year hour minutes -->
    <playdate format="ddmmyyyyhhnn" value="180519700612" termdigits="#"/>
      <!-- day month -->
    <playdate format="ddmm" value="1805" termdigits="#"/>
      <!-- hour minutes -->
    <playdate format="hhnn" value="0732" termdigits="#"/>
      <!-- month day year -->
    <playdate format="ddmmyyyy" value="18051970" termdigits="#"/>
      <!-- month day -->
    <playdate format="ddmm" value="1805" termdigits="#"/>

    <ontermdigit value="#">
      <text>
        You must have pressed the pound key.
      </text>
    </ontermdigit>
  </block>
</callxml>




additional links

none


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

 login


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