VoiceXML elements

This section describes the VoiceXML elements that Voice Platform supports. These elements comply with the VoiceXML Version 2.0 Specification. New features that comply with the VoiceXML 2.1 Specification are noted in the text.

For more information, see:

Supported VoiceXML elements

Element

Description

<assign>

Assigns a value to a variable.

<audio>

Plays a digital audio recording.

<block>

Defines a container of non-interactive executable code.

<catch>

Defines an event handler within the current scope.

<choice>

Defines a menu item.

<clear>

Resets one or more form items.

<data>

Fetches arbitrary XML data from a document server.

<disconnect>

Disconnects the current session.

<else>

Conditional logic used in <if>.

<elseif>

Conditional logic used in <if>.

<enumerate>

Enumerates a list of choices within a menu.

<error>

Catches an error event.

<exit>

Terminates the current session.

<field>

Specifies an input field within a form.

<filled>

Specifies actions that are executed when field items are filled.

<foreach>

Iterates through an ECMAScript array.

<form>

Presents information and collects input from users.

<goto>

Executes a subdialog in the same document or a different document.

<grammar>

Specifies a speech recognition grammar or DTMF grammar.

<help>

Catches a help event.

<if>

Specifies a conditional logic expression.

<initial>

Declares initial logic upon entry into a (mixed-initiative) form.

<link>

Specifies an action to take when an embedded grammar is recognized.

<log>

Specifies messaging information to a file, console, and/or SNMP custom listener.

<menu>

Specifies a list of alternatives to the user and then transitions to the response provided by the user.

<meta>

Contains meta-data.

<nuance:nbest>

Selects the best recognition result from a list returned by the recognizer. (Nuance extension)

<nuance:recordasync-start> Indicates to start asynchronous recording of audio samples.
<nuance:recordasync-stop> Indicates to stop an asynchronous recording.

<noinput>

Catches a noinput event (no speech timeout).

<nomatch>

Catches a nomatch event (out-of-grammar response).

<option>

Specifies an option in an input field.

<param>

Specifies an input parameter for the <subdialog> element.

<prompt>

Plays audio or synthesized speech.

<property>

Sets properties of the VoiceXML interpreter platform.

<record>

Records audio samples.

<reprompt>

Increments the prompt counter when a field item is visited after an event.

<return>

Terminates the execution of a subdialog and returns to the main dialog.

<script>

Contains ECMAScript code for execution on client.

<nuance:send>

Sends data to a server or a file system without transitioning control to a new document. (Nuance extension)

<subdialog>

Allows you to invoke a subdialog within the current dialog.

<submit>

Generates an HTTP request for a new URI and passes a list of variables to the new server.

<nuance:taskbegin>

Identifies the beginning of a task. (Nuance extension)

<nuance:taskend>

Identifies the completion of a task. (Nuance extension)

<throw>

Throws an event.

<transfer>

Transfers the caller to another destination.

<value>

Dynamically generates a prompt from a variable.

<var>

Declares a variable.

<vxml>

Top-level element required in every VoiceXML document.