Voxeo Documentation - <vxml> Element

The <vxml> element is the initial declaration that defines a document as a VoiceXML application.

Syntax

The following code example shows the syntax for the <vxml> element.

<vxml application="myApplicationURI" version="2.1" xml:base="myXmlBaseURI" xml:lang="myXmlLangNMTOKEN" xmlns="http://www.w3.org/2001/vxml" xmlns:voxeo="http://community.voxeo.com/xmlns/vxml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3.org/2001/vxml http://www.w3.org/TR/2007/REC-voicexml21-20070619/vxml.xsd">

Attribute Details

The following table describes the attributes for the <vxml> element.

application

Required: false

Type: URI

Default: none

Specifies the URI of the root document for the application. When specified, all event handlers, variables, links, grammars , and scripts contained within the root document are considered active when each document loads. All variables declared within the root document are then considered to have application scope, and are available at any point in the application.

Valid Values: A valid URI.

version

Required: true

Type: 2.0 | 2.1

Default: none

Specifies the VoiceXML version number. To use elements and attributes that were modified in VoiceXML 2.1, you must specify 2.1 as the version attribute value.

xml:base

Required: false

Type: URI

Default: none

Specifies the base URI of the document. All relative URIs contained in the document are derived from the base attribute value.

Valid Values: A valid URI.

xml:lang

Required: false

Type: NMTOKEN

Default: en-us

Specifies the language and locale information of the VoiceXML document. If omitted, this value is inherited from the document hierarchy, or ultimately from the platform default. The Prophecy platform default is en-us.

xmlns

Required: false

Type: URI

Default: http://www.w3.org/2001/vxml

Specifies the VoiceXML namespace. All elements and attributes using Voxeo Prophecy belong to this namespace. The namespace URI for VoiceXML is http://www.w3.org/2001/vxml.

xmlns:voxeo

Required: false

Type: URI

Default: none

Defines the XML namespace for any Voxeo-specific extension elements. This attribute is only required when you use a Voxeo-specific VoiceXML element, such as the <voxeo:recordcall> element. The only allowable value for this attribute is http://community.voxeo.com/xmlns/vxml.

Valid Values: A valid URI.

xmlns:xsi

Required: false

Type: CDATA

Default: none

Defines the XML namespace for the VoiceXML 2.1 Schema. The only allowable value is http://www.w3.org/2001/XMLSchema-instance.

xsi:schemaLocation

Required: false

Type: CDATA

Default: none

Specifies the location of the schema for the VoiceXML namespace. This attribute is only valid in conjunction with the xmlns:xsi attribute, and the only allowable value is http://www.w3.org/2001/vxml http://www.w3.org/TR/2007/REC-voicexml21-20070619/vxml.xsd.

Shadow Variables

None.

Parents

None.

Children

<catch> <error> <form> <help> <link> <menu> <meta> <noinput> <nomatch> <property> <script> <var>

Code Samples

The following code samples show use of the <vxml> element.

<!-- AppRoot.vxml -->

<?xml version="1.0" encoding="UTF-8"?>

<vxml version="2.1">

 

<catch event="GlobalEvent">

<prompt>

We caught a global event.

</prompt>

</catch>

 

<form id="F1">

<block>

<prompt>

Here is some text that will not be executed.

</prompt>

</block>

</form>

</vxml>

 

<!-- Vxml application-xml:base sample -->

<?xml version="1.0" encoding="UTF-8"?>

<vxml version="2.1" application="AppRoot.vxml" xml:base="http://ThisServer/ThisDirectory/">

 

<form id="F1">

<block>

<prompt>

Preparing to throw a global event, which is

caught by the application root document.

</prompt>

 

<throw event="GlobalEvent" />

</block>

</form>

</vxml>

See Also

VoiceXML Development Guide v2.1 Overview

Element Summary

Voxeo Support

 

The <vxml> element is the initial declaration that defines a document as a VoiceXML application. For more information, see <vxml> Element.

 
VoiceXML is an XML markup language format that you can use to specify interactive voice dialogs between a human and a computer. A voice application developed using VoiceXML can be deployed in a similar way an HTML application is deployed. While HTML uses a visual browser to display data, VoiceXML uses a voice browser, for example, the Voxeo Prophecy VoiceXML browser, to interpret the VoiceXML data. For more information, see the VoiceXML 2.1 Development Guide.
 

The <vxml> element is the initial declaration that defines a document as a VoiceXML application. For more information, see <vxml> Element.

 

The <vxml> element is the initial declaration that defines a document as a VoiceXML application. For more information, see <vxml> Element.

 
A specific character string that represents both a reference to an Internet resource, a URL, the name of an object such as web page, file, and so forth, called a URN. The acronym for uniform resource identifier is URI. Combined, the URL and a URN define a URI.
 

URL - http://help.voxeo.com or http://www.voxeo.com

 
 

URI - http://help.voxeo.com/helpserver/go/help/Support.welcome.htm where the URN is the /helpserver/go/help/Support.welcome.htm portion of the URI

 
 

The set of valid utterances recognized by the speech recognition system in a voice application. Grammars are commonly specified using symbolic notation which describes context-free grammars.

 
Prophecy is a Voxeo 100% standards-based communications software platform for running applications for voice, text messaging (SMS), video, and mobile web. Prophecy makes it easy for companies to create, deploy, and manage DTMF and speech self-service IVR applications, while also providing support for non-voice self-service channels, including SMS. Prophecy is the only IVR platform to pass every mandatory and optional VoiceXML Forum compliance test. Prophecy is available for on-premise deployment and as Prophecy Hosting as the Voxeo worldwide hosting network. A free download of Prophecy is available at Voxeo Prophecy Download. For more information, see your version of Prophecy in the Prophecy Documentation.
 
Voxeo Corporation is a technology company that specializes in providing development platforms for unified customer experience as self-service and unified communications using real-time communications applications. Voxeo's products are also available as a SaaS platform as cloud-based services using on-premise software in a private cloud, or hybrid clouds that combine both on-demand public-cloud and on-premise components. For more information, see Voxeo.com.

 

The <voxeo:recordcall> element is a Voxeo-specific element that allows the developer to record both sides of a call. For more information, see <voxeo:recordcall> Element.

 

The <catch> element is used to intercept application and user-defined errors, conditions, and messages, allowing the developer to assign event handlers on a scoped basis. For more information, see <catch> Element.

 

The <error> element is shorthand for the <catch event="error"> element, and catches all events that begin with error. For more information, see <error> Element.

 

The <form> element is a container for all field items, such as a <field> element or a <subdialog> element, and for all control items, such as a <block> element or an <initial> element. For more information, see <form> Element.

 

The <help> element is shorthand for the <catch event="help"> element, and catches all help events. For more information, see <help> Element.

 

The <link> element allows the developer to implement a document or application scoped grammar and transition or event handler for caller input. For more information, see <link> Element.

 

The <menu> element is a shorthand element that emulates the <field>, <grammar>, and <goto> elements. The <menu> element defines a set of choices for a caller, and allows for both implied DTMF and voice grammars. For more information, see <menu> Element.

 

The <meta> element is used to denote meta information about the document, or to specify HTTP response headers. For more information, see <meta> Element.

 

The <noinput> element is shorthand for the <catch event="noinput"> element. This element allows the developer to assign event handlers for when the application expects voice or DTMF input, but has received none from the caller. For more information, see <noinput> Element.

 

The <nomatch> element is shorthand for the <catch event="nomatch"> element. This element allows the developer to assign handlers for when the caller inputs a value that is not recognized by any of the active grammars. For more information, see <nomatch> Element.

 

The <property> element defines any platform-defined setting which impacts the behavior of the application. For more information, see <property> Element.

 

The <script> element is used to specify a block of client-side ECMAScript code. For more information, see <script> Element.

 

The <var> element is used to declare a VoiceXML variable within the scope specified by the parent element. For more information, see <var> Element.

 

The <vxml> element is the initial declaration that defines a document as a VoiceXML application. For more information, see <vxml> Element.

Voxeo Documentation

     Voxeo Documentation Overview
  Evolution Developer Portal Documentation
  Voxeo CXP Documentation
  Prophecy Documentation
  XML Development Languages Documentation
  VoiceXML 2.1 Development Guide
     VoiceXML Development Guide v2.1 Overview
     Platform Overview
     Creating an Application
     Voxeo File Manager
     Caching Tips and Techniques
     Cache Manager API
     Security Information
  Learning VoiceXML 2.1
  Best Practices
  Debugging Techniques
  Exceptions and Errors
  VoiceXML 2.1 Porting Guide
  VoiceXML Variables
  All Things Audio
  Outbound Dialing
  Property Guide
  GSL Grammars
  grXML Grammars
     Custom Features
     External References
  Text-To-Speech Guide
     VoIP Dialing
     Voxeo Designer User Interface
  Element Reference Guide
     Element Summary
     <assign> Element
     <audio> Element
     <block> Element
     <break> Element
     <catch> Element
     <choice> Element
     <clear> Element
     <data> Element
     <disconnect> Element
     <else> Element
     <elseif> Element
     <emphasis> Element
     <enumerate> Element
     <error> Element
     <example> Element
     <exit> Element
     <field> Element
     <filled> Element
     <foreach> Element
     <form> Element
     <goto> Element
     <grammar> Element
     <help> Element
     <if> Element
     <initial> Element
     <item> Element
     <link> Element
     <log> Element
     <mark> Element
     <media> Element
     <menu> Element
     <meta> Element
     <noinput> Element
     <nomatch> Element
     <one-of> Element
     <option> Element
     <paragraph> Element
     <param> Element
     <phoneme> Element
     <prompt> Element
     <property> Element
     <prosody> Element
     <record> Element
     <reprompt> Element
     <return> Element
     <rule> Element
     <ruleref> Element
     <say-as> Element
     <script> Element
     <sentence> Element
     <sub> Element
     <subdialog> Element
     <submit> Element
     <tag> Element
     <throw> Element
     <token> Element
     <transfer> Element
     <value> Element
     <var> Element
     <voxeo:logcontrol> Element
     <voxeo:recordcall> Element
     <vxml> Element
  CCXML 1.0 Development Guide
     CallXML 3.0 Development Guide
  Voxeo Support
     Support Quick Reference
  Registering for an Account
  Self-Help Tools
  Collecting Information
  Evolution Ticketing System
     Submitting a Support Request
     Escalating a Support Request
  Software Lifecycle and Support Policies
  Getting Further Assistance
  Voxeo Glossary
  Help on Help