Play
Definition
Starts a sound file. Must be either a tts value (text-to-speech engine) or a sound file at 8khz 16bit Mono. The sound file can be a .wav, or .mp3. If using tts, the actual text must be contained within the opening and closing tags.
Value
If using an actual sound file, the value is the ID or URL to that sound file. If using tts, the value is the text to be read by the tts engine. If the type attribute is callfireid, the value must represent a valid CallFire sound ID. For a URL, the value must be a valid URL to the sound file.
Attributes
| Attribute | Required | Values | Description |
|---|---|---|---|
| name | N | any text | A unique name for the tag |
| type | Y | callfireid, url, or tts | Establishes type of sound file |
| voice | N | male1, female1, female2, spanish1, frenchcanadian1 | The tts voice type |
| cache | N | true or false | Updates the sound file at each call |
Notes
You can insert a VTML specification into the play tag in order to slow down the text to speech. The lower the number, the more slowly the speech will be read.
For example:
<play type="tts" voice="male1"><vtml_speed value="60">This would be another way to do slow speech. </vtml_speed></play>
Note the encoded < and > to open and close the VTML. VTML can also be used to change the pitch or volume of the voice, interpret number strings in different ways (as types of date such as mmddyy or ddmmyy, or kinds of currency, for example), or many other ways to interpret the text being read. Please see the attached VTML specification document below.
Examples
This IVR plays three types of sounds: one from a website, one in your CallFire sound library, and one through the tts engine.
<dialplan name="Root">
<play name="play_URL" type="url">http://www.mysite.com/87878</play>
<play name="play_soundfile" type="callfireid">99999</play>
<play name="play_textToSpeech" type="tts" voice="male1">How are you doing?</play>
</dialplan>
vt_eng-Engine-VTML-v3.9.0-3.pdf (500 KB)