Voximal documentation - developer_guide:voicexml_references:elements
https://wiki.voximal.com/
2026-04-29T19:45:05+00:00Voximal documentation
https://wiki.voximal.com/
https://wiki.voximal.com/lib/exe/fetch.php?media=wiki:logo.pngtext/html2017-12-19T09:03:19+00:00Anonymous (anonymous@undisclosed.example.com)assign
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:assign&rev=1513674199&do=diff
< assign >
Description
The <assign> element assigns a value to a variable. It is illegal to make an assignment to a variable that has not been explicitly declared using a <var> element or a <var> statement within a <script>. Attempting to assign an undeclared variable causes an error.semantic event to be thrown.text/html2015-10-28T14:39:01+00:00Anonymous (anonymous@undisclosed.example.com)audio
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:audio&rev=1446043141&do=diff
< audio >
Description
The <audio> element plays an audio file. If the file cannot be played, the content of the <audio> element is played instead. The alternate content may be text, speech markup, or another <audio> element.
Syntax
<audio
src="URI"
expr="ECMAScript_Expression"
fetchtimeout="time_interval"
fetchhint="prefetch" | "safe"
maxage="time_interval"
maxstale="time_interval">
alternate text
</audio>text/html2015-10-13T21:21:24+00:00Anonymous (anonymous@undisclosed.example.com)block
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:block&rev=1444771284&do=diff
< block >
Description
The < block > element specifies a block of directives to be executed in the order given.
Syntax
<block
name="String"
expr="ECMAScript_Expression"
cond="ECMAScript_Expression">
child elements
</block>
Attributes
nameThis is the name of the block that can be referred within the form. This is optional and defaults to an inaccessible internal variable.text/html2015-10-13T21:25:30+00:00Anonymous (anonymous@undisclosed.example.com)catch
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:catch&rev=1444771530&do=diff
< catch >
Description
The <catch> element catches events thrown from the VoiceXML application or the platform. The <catch> element associates a catch with a document, dialog or form item and contains executable content. The <catch> element catches an event with the name that either matches exactly with the event attribute or a prefix match. A prefix match means the event attribute is a token prefix of the thrown event, where the dot is the token separator. For example, <catch event=text/html2015-10-13T21:42:21+00:00Anonymous (anonymous@undisclosed.example.com)choice
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:choice&rev=1444772541&do=diff
< choice >
Description
The <choice> element defines a menu item and serves several purposes:
* Specifies a speech grammar fragment and/or a DTMF grammar fragment that determines when that choice has been selected.
* Forms the <enumerate> prompt string with its contents.text/html2015-10-13T21:42:51+00:00Anonymous (anonymous@undisclosed.example.com)clear
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:clear&rev=1444772571&do=diff
< clear >
Description
The < clear > element resets one or more form items and will perform the following actions:
* Sets the form item variable to ECMAScript undefined.
* Reinitializes the prompt and event counters for the form item.
Syntax
<clear
namelist="item1 item2 item3 ..."/>text/html2021-03-02T23:52:21+00:00Anonymous (anonymous@undisclosed.example.com)data
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:data&rev=1614729141&do=diff
< data >
Description
The <data> element allows a VoiceXML application to fetch arbitrary XML data from a document server without transitioning to a new VoiceXML document. The XML data fetched by the <data> element is bound to ECMAScript through the named variable that exposes a read-only subset of thetext/html2015-10-27T11:12:54+00:00Anonymous (anonymous@undisclosed.example.com)disconnect
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:disconnect&rev=1445944374&do=diff
< disconnect >
Description
This element disconnects the user’s phone call. As a result, the interpreter context will throw the telephone.disconnect.hangup event. A < disconnect > differs from an <exit> in that it forces the interpreter context to drop the call.text/html2015-10-27T11:13:34+00:00Anonymous (anonymous@undisclosed.example.com)else
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:else&rev=1445944414&do=diff
< else >
Description
The < else > element is used within the conditional logic statement <if> and optional <elseif> element.
Syntax
<else/>
Parents
<if>
Children
None.
Extensions
None.
Limitations/Restrictions
None.
Example Codetext/html2015-10-27T11:14:39+00:00Anonymous (anonymous@undisclosed.example.com)elseif
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:elseif&rev=1445944479&do=diff
< elseif >
Description
The < elseif > element is used within the conditional logic statement <if> and optional <else> element.
Syntax
<elseif
cond="ECMAScript_Expression"/>
Attributes
condThe cond attribute is the Boolean expression for the conditional logic statement. This attribute is required.text/html2015-10-27T11:16:05+00:00Anonymous (anonymous@undisclosed.example.com)enumerate
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:enumerate&rev=1445944565&do=diff
< enumerate >
Description
The < enumerate > element is an automatically generated description of the choices available for the user. It specifies a template that is applied to each choice in the order they appear in the < menu > element, or in the < field > element that contains < option > elements.text/html2015-10-27T12:29:04+00:00Anonymous (anonymous@undisclosed.example.com)error
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:error&rev=1445948944&do=diff
< error >
Description
The < error > element catches an error event. This is a shorthand notation for <catch event=“error”> that catches all events of type error.
Syntax
<error
count="Integer"
cond="ECMAScript_Expression">
child elements
</error>text/html2015-10-27T12:29:35+00:00Anonymous (anonymous@undisclosed.example.com)exit
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:exit&rev=1445948975&do=diff
< exit >
Description
The < exit > element exits the interpreter session and returns control to the interpreter context, which determines what to do next. This element differs from the < return > element in that < exit > terminates all loaded elements while < return > returns from a < subdialog > invocation.text/html2017-03-21T14:21:31+00:00Anonymous (anonymous@undisclosed.example.com)field
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:field&rev=1490106091&do=diff
< field >
Description
The < field > element declares an input field in a form and prompts the user for values that match a grammar.
Syntax
<field
name="String"
expr="ECMAScript_Expression"
cond="ECMAScript_Expression"
type="boolean"|"number"|"digit"
slot="String"
modal="true" | "false"
saveutterance="true" | "false">
child elements
</field>text/html2015-10-27T12:30:40+00:00Anonymous (anonymous@undisclosed.example.com)filled
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:filled&rev=1445949040&do=diff
< filled >
Description
The < filled > element specifies an action to perform when some combinations of fields are filled by user input. It may occur as a child of the element, or as a child of a field item.
Syntax
<filled
mode="all" | "any"
namelist="item1 item2 item3...">
child elements
</filled>text/html2015-10-27T12:36:42+00:00Anonymous (anonymous@undisclosed.example.com)foreach
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:foreach&rev=1445949402&do=diff
< foreach >
Description
Iterates through an ECMAScript array of items. New in VoiceXML 2.1.
Syntax
<foreach
array = "ECMAScript_Expression"
item = "variable"
/>
Attributes
arrayAn ECMAScript expression that evaluates to an array. Required.itemtext/html2015-10-27T12:37:45+00:00Anonymous (anonymous@undisclosed.example.com)form
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:form&rev=1445949465&do=diff
< form >
Description
Forms are key components in VoiceXML applications. Forms collect user input and present information to the user. A form can define a field item (for collecting user input), or a control item (contains procedural items to help collect inputs).text/html2015-10-27T12:38:25+00:00Anonymous (anonymous@undisclosed.example.com)goto
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:goto&rev=1445949505&do=diff
< goto >
Description
The < goto > attribute transitions to another item in the current form, another dialog in the same document, or to a different document. Transitioning to another dialog in the current document or to a different document will cause the old dialog’s variables to be lost. Document variables are retained when transitioning to the same document with an emptytext/html2015-10-27T12:38:51+00:00Anonymous (anonymous@undisclosed.example.com)grammar
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:grammar&rev=1445949531&do=diff
< grammar >
Description
The < grammar > element specifies a grammar (word or phrase) for speech recognition. When the grammar is recognized, the application may perform an action (such as a transition to another field item), or assign values to a field item variable. Multiple values can also be assigned with mixed initiative forms.text/html2015-10-27T12:56:57+00:00Anonymous (anonymous@undisclosed.example.com)help
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:help&rev=1445950617&do=diff
< help >
Description
The < help > element catches a help event. This is a shorthand notation for < catch event=“help” >.
Syntax
<help
count="Integer"
cond="ECMAScript_Expression">
child elements
</help>
Attributes
countThe count attribute is the event count just as in the <catch> element. This attribute is optional.text/html2015-10-27T12:57:22+00:00Anonymous (anonymous@undisclosed.example.com)if
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:if&rev=1445950642&do=diff
< if >
Description
The < if > element defines if-then-else conditional logic.
Syntax
<if
cond="ECMAScript_Expression">
child elements
</if>
Attributes
condThe cond attribute is a Boolean expression for the conditional logic statement. This attribute is required.text/html2015-10-27T12:57:48+00:00Anonymous (anonymous@undisclosed.example.com)initial
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:initial&rev=1445950668&do=diff
< initial >
Description
The < initial > element declares initial logic upon entry into a mixed-initiative form.
Unlike < field >, < initial > has no grammars and no < filled > action. < initial > can request user input and handle events. < initial > continues to be visited while its form item variable is undefined and its condition is true. When any of the form’s fields are filled in by user input, then all < initial > form item variables are set to true, before any < filled > actions are e…text/html2015-10-27T12:58:19+00:00Anonymous (anonymous@undisclosed.example.com)link
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:link&rev=1445950699&do=diff
< link >
Description
A < link > element may have one or more grammars. The grammars are in the scope of the element containing this <link> element. When the user input matches one of the linked grammars, it activates the < link > to either throw an event, or transition to another document or dialog.text/html2015-10-27T21:37:27+00:00Anonymous (anonymous@undisclosed.example.com)log
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:log&rev=1445981847&do=diff
< log >
Description
The < log > element allows the application to generate debug messages. This element can contain a combination of text and <value> elements in which the resulting message will be the concatenation of the text and string value of the < value > element. The messages will be logged to the metrics file for viewing.text/html2015-10-27T21:37:51+00:00Anonymous (anonymous@undisclosed.example.com)menu
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:menu&rev=1445981871&do=diff
< menu >
Description
The < menu > element presents a menu of choices to the user and transitions to another dialog based on user input.
Syntax
<menu
id="String"
scope="dialog" | "document"
dtmf="true" | "false"
accept="exact" | "approximate">
child elements
</menu>text/html2015-10-27T21:38:27+00:00Anonymous (anonymous@undisclosed.example.com)meta
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:meta&rev=1445981907&do=diff
< meta >
Description
The < meta > element specifies general information about the VoiceXML application.
Syntax
<meta
name="String"
content="String"
http-equiv="String"/>
Attributes
nameThe name attribute is the name of the meta-data property. This attribute is required (specifically either name or http-equiv).text/html2015-10-27T21:38:51+00:00Anonymous (anonymous@undisclosed.example.com)noinput
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:noinput&rev=1445981931&do=diff
< noinput >
Description
The < noinput > element handles the event when the user does not give inputs in a field. This is a shorthand notation for < catch event=“noinput” > that catches all events of type error.
Syntax
<noinput
count="Integer"
cond="ECMAScript_Expression">
child elements
</noinput>text/html2015-10-27T21:39:25+00:00Anonymous (anonymous@undisclosed.example.com)nomatch
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:nomatch&rev=1445981965&do=diff
< nomatch >
Description
The < nomatch > element handles the event when the user gives unrecognized input. This is a shorthand notation for <catch event=“nomatch”> that catches all events of type error.
Syntax
<nomatch
count="Integer"
cond="ECMAScript_Expression">
child elements
</nomatch>text/html2015-10-28T14:32:17+00:00Anonymous (anonymous@undisclosed.example.com)object
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:object&rev=1446042737&do=diff
< object >
Description
The < object > element interacts with custom extensions. A VoiceXML platform may have platform-specific functionality that an application wants to use, such as speaker verification, native components, additional telephony, etc. Such platform-specific objects are accessed using the <object> element, which is analogous to thetext/html2015-10-27T21:40:36+00:00Anonymous (anonymous@undisclosed.example.com)option
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:option&rev=1445982036&do=diff
< option >
Description
The <option> element specifies an option in a <field>. It is a convenient way to specify a list of choices in a field without specifying a grammar. The grammar is generated automatically from the text contained in each <option>.text/html2015-10-27T21:41:05+00:00Anonymous (anonymous@undisclosed.example.com)param
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:param&rev=1445982065&do=diff
< param >
Description
The <param> element specifies values that are passed into the <object> or in <subdialog>. When <param> is contained in a <subdialog> element, the values specified are used to initialize <var> declarations in the subdialog that is invoked. The initialization takes precedence over the expr attribute in <var>.text/html2015-10-27T21:41:39+00:00Anonymous (anonymous@undisclosed.example.com)prompt
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:prompt&rev=1445982099&do=diff
< prompt >
Description
The <prompt> element controls the output of synthesized speech and prerecorded audio.
NOTE:
Any prompts that contain Speech Markup (SSML) will be passed into the TTS Engine as an XML document. The interpreter first decodes the VoiceXML document, and then re-encodes the prompt content into an XML document to pass to the TTS Engine.text/html2015-10-27T21:42:14+00:00Anonymous (anonymous@undisclosed.example.com)property
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:property&rev=1445982134&do=diff
< property >
Description
The <property> element controls implementation platform settings. Properties are used to set values that affect platform behavior, such as the recognition process, timeouts, caching policy, etc. Please refer to Properties for list of properties.text/html2015-10-28T14:34:20+00:00Anonymous (anonymous@undisclosed.example.com)record
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:record&rev=1446042860&do=diff
< record >
Description
The <record> element collects a recording from the user. A reference to the recorded audio is stored in the field item variable which can be played back or submitted to a server.
Syntax
<record
name="String"
expr="ECMAScript_Expression"
cond="ECMAScript_Expression"
modal="true" | "false"
beep="true" | "false"
maxtime="time_interval"
finalsilence="time_interval"
dtmfterm="true" | "false"
type="MIME_type">
child elements
dest="URI"
destexpr="ECMAScript_Expression"
</re…text/html2015-10-27T21:43:18+00:00Anonymous (anonymous@undisclosed.example.com)reprompt
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:reprompt&rev=1445982198&do=diff
< reprompt >
Description
The <reprompt> element replays a previously played prompt. Normally, the interpreter stops playing prompts on the next form item after executing a <catch> element. However, if a <reprompt> is executed in the catch, the interpreter will process a normal prompt for the next form item. This includes a selection of a prompt and an incremental addition to the prompt counter.text/html2015-10-27T21:43:52+00:00Anonymous (anonymous@undisclosed.example.com)return
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:return&rev=1445982232&do=diff
< return >
Description
The <return> element completes the execution of <subdialog> and returns control and data to a calling dialog.
Syntax
<return
event="event"
namelist="variable1 variable2 ..."/>
Attributes
eventReturn and throw this event. Optional.text/html2015-10-27T21:44:31+00:00Anonymous (anonymous@undisclosed.example.com)script
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:script&rev=1445982271&do=diff
< script >
Description
The <script> element includes a block of client-side script. Each <script> element is executed in the scope of its containing element; i.e., it does not have its own scope. Variables defined in the <script> element are equivalent to variables defined using <var> within the same scope.text/html2015-10-27T22:41:09+00:00Anonymous (anonymous@undisclosed.example.com)start
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:start&rev=1445985669&do=diff
Elements
The following table includes all VoiceXML 2.0 and 2.1 tag elements supported by our VoiceXML interpreter:
Element Description Supported < assign > Assigns a value to a variable. yes < audio > Plays an audio file to a user. yes < block > Allows execution of code within this item.text/html2015-10-27T21:45:03+00:00Anonymous (anonymous@undisclosed.example.com)subdialog
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:subdialog&rev=1445982303&do=diff
< subdialog >
Description
The <subdialog> element invokes another dialog as a subdialog of the current one. The subdialog is a reusable dialog that allows values to be returned. The subdialog executes in a new execution context with all variables and execution states initialized. Values can be passed into the subdialog using <param> child elements; the subdialog must contain the <var> variable declaration for each parameter. The original dialog can continue execution only when the subdialog …text/html2015-10-27T21:45:28+00:00Anonymous (anonymous@undisclosed.example.com)submit
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:submit&rev=1445982328&do=diff
< submit >
Description
The <submit> element submits values to document server. It is similar to <goto> in that it results in a new document being obtained. Unlike <goto>, it lets you submit a list of variables to the document server via HTTP GET or HTTP POST.text/html2015-10-27T21:45:54+00:00Anonymous (anonymous@undisclosed.example.com)throw
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:throw&rev=1445982354&do=diff
< throw >
Description
The <throw> element throws a pre-defined event or application-specific event.
Syntax
<throw
event="event"
eventexpr="ECMAScript_Expression"
message="String"
messageexpr="ECMAScript_Expression"/>
Attributes
eventThe event attribute defines the event name to throw. The attribute is required – specifically the event or eventexpr is required.text/html2015-12-09T22:14:44+00:00Anonymous (anonymous@undisclosed.example.com)transfer
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:transfer&rev=1449699284&do=diff
< transfer >
Description
The <transfer> attribute transfers the caller to another phone number. There are two types of transfer:
* bridge transfer – the caller resumes the interpreter session after a call with the third party.
* blind transfer – as soon as the call with the third party connects, the platform throws a telephone.disconnect.transfer and terminates the interpreter session.text/html2015-10-27T21:46:59+00:00Anonymous (anonymous@undisclosed.example.com)value
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:value&rev=1445982419&do=diff
< value >
Description
The <value> element inserts the value of an expression in a prompt.
Syntax
<value
expr="ECMAScript_Expression"/>
Attributes
exprThe expr attribute is an expression to return. This attribute is required.
Parents
<audio>, <block>, <catch>, <choice>, <enumerate>, <error>, <field>, <filled>, <help>, <if>, <initial>, <menu>, <noinput>, <nomatch>, <object>, <prompt>, <record>, <subdialog>, <transfer>text/html2015-10-27T21:47:58+00:00Anonymous (anonymous@undisclosed.example.com)var
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:var&rev=1445982478&do=diff
< var >
Description
The <var> element declares a variable in the scope of its parent element. If the variable is already defined in the current scope, further declaration is treated as value assignments.
Syntax
<var
name="String"
expr="ECMAScript_Expression"/>text/html2015-10-27T21:49:12+00:00Anonymous (anonymous@undisclosed.example.com)vxml
https://wiki.voximal.com/doku.php?id=developer_guide:voicexml_references:elements:vxml&rev=1445982552&do=diff
< vxml >
Description
The < vxml > element identifies a VoiceXML document (the xml root element).
Syntax
<vxml
version="Version"
base="URI"
xml:lang="Language"
application="URI" />
Attributes
versionThe version attribute specifies the VoiceXML version number. The current version is 2.0. This attribute is required.