VoiceXML 2.x Element Reference

The following table lists the VoiceXML 2.0 and VoiceXML 2.1 elements supported by the Tellme VoiceXML interpreter. Using these elements you can develop voice applications that are compliant with the VoiceXML 2.0 and VoiceXML 2.1 specifications and run them on the Tellme Voice Application Network.

VoiceXML element list

Click each element link for additional information.

Element

Defintion

assign

Assigns a value to a variable.

audio

Plays an audio file or converts text to speech within a prompt.

block

Specifies a block of directives that are executed in document source order.

break

Introduces a specified amount of silence into the audio played back to the user.

catch

Handles events thrown by a VoiceXML application or the interpreter.

choice

Defines a menu option.

clear

Resets the specified form items.

data

Provides programmatic access to data in XML format from an HTTP server without transitioning to a new VoiceXML document. See VoiceXML 2.1

disconnect

Terminates the phone call.

else

Provides the final alternative in an if construct.

elseif

Provides an alternative conditional statement in an if construct.

emphasis

Indicates the prominence or stress with which the enclosed text should be played back by the TTS engine. Currently the emphasis element has no effect on the synthesized speech output.

enumerate

Creates a template for choices in a menu.

error

Handles errors thrown by the platform or throw element.

exit

Terminates the running application.

field

Formulates an interactive dialog between the user and the system.

filled

Specifies an action to perform when the VoiceXML interpreter assigns a value to the named variable of a field, transfer, record, or subdialog element.

foreach

Iterates through an ECMAScript array of items. See VoiceXML 2.1

form

Contains a series of field items to be filled through interaction with the user.

goto

Jumps to the specified URI.

grammar

Specifies a permissible vocabulary for user interaction.

help

Handles a help event.

if

Performs conditional logic.

initial

Prompts the user for form-wide information.

link

Specifies one or more grammars and a destination to go to or an event to throw when one is matched.

log element

Writes a message to the debug log. When you use Tellme Studio to execute your VoiceXML applications, you can use the Debug Log Viewer to view these messages.

mark

Sets a bookmark allowing you to determine when the user barged in on a prompt. See VoiceXML 2.1

menu

Presents a list of choices to the user and transitions to the chosen information.

meta

Specifies general information about the VoiceXML document.

noinput

Executes when the user does not speak within the active field.

nomatch

Handles user input that is not recognized as part of the active grammar(s).

object

Exposes platform-specific functionality for use by a VoiceXML application.

option

Specifies an option to a user within a field.

p element

Provides a container element for zero or more sentences.

paragraph

Provides a container element for zero or more sentences.

param

Specifies a value to pass to a subdialog or object element.

phoneme

Specifies a phonetic pronunciation for the contained text.

prompt

Queues recorded audio and synthesized text to speech in an interactive dialog.

property

Specifies speech parameters for an entire application, document, or form. Although the default value for each property is provided below, these values are subject to change. If your voice application relies on a specific value, set the property explicitly in your application root document.

prosody

Controls the speaking rate and the volume of the speech output.

record

Records user input.

reprompt

Indicates that the Platform should select and queue the appropriate prompt element before entering a listen state in an interactive dialog.

return

Returns control and data or an event to the dialog that called the subdialog.

s element

Identifies the enclosed text as a complete sentence. Currently the s element has no effect on the synthesized speech output.

say-as

Aids the TTS engine in pronunciation by resolving ambiguities regarding the meaning of the contained text.

script

Includes a block of ECMAscript code.

sentence

Identifies the enclosed text as a complete sentence.

sub

Indicates a substitution for pronunciation of the contained text. This allows a document to contain both a spoken and written form.

subdialog

Jumps to and executes an encapsulated dialog.

submit

Obtains a new document via an HTTP GET or POST request.

throw

Generates a system or user-defined event to catch with an event handler.

transfer

Transfers the caller to the specified telephone number.

value

Evaluates and returns an ECMAScript expression.

var

Declares a variable.

voice

Controls the vocal characteristics for the contained text when played back by the TTS engine.

vxml

Represents the root document element of a VoiceXML document.