VoiceXML 2.1 Development Guide

| TOC

The Voxeo File Manager

A recent addition to the array of tools and services offered at Voxeo is the File Manager. Upon signup, we allocate filespace for our developers so that they can host .XML, .grammar, and .wav files on our servers, so that the headaches of setting up your own webserver to dish out content, (or worse, finding a free webhost), is no longer a requirement. Herein, we will detail how you can use the Voxeo File Manager, (or VFM, for short) to upload your files to our servers.

Logging In

The first thing you'll want to do is to log in to your account by pointing your browser to http://community.voxeo.com, and enter your username and password into the appropriate fields in the left navigation bar. Don't have an account yet? The you'll need to visit our Account Signup Page first! Once you provide your login credentials, you'll be taken to the Application Manager page, where you will be able to view existing applications, and create new ones. From here, you will want to look in the left nav bar, and choose 'Voxeo File Manager'.

Uploading and Creating Files

With the Voxeo File Manager open, you'll see the default directory structure containing three folders. The 'Root/www' directory, with a 'grammar' and an 'audio' subdirectory. You can add directories as you see fit, by using the 'New Directory' field located at the bottom of the screen. If you have an existing .xml, .grammar, or .wav file, (the only supported file extensions), to upload, then you can click the 'browse' button located next to the 'Upload File' field to find the file on your local machine.

Don't have an existing file to upload? No worries. You can create and map an XML file by using our on-site XML editor. Scroll down to the 'New File' field and enter a filename, (with file extension!), for our new file. Once this has been submitted, you will see your new file listed in the 'www/root' directory.

Editing and Deleting Files

Once you have some content uploaded to the filespace, you can edit, delete or view the files by using the options in the 'Actions' column. In this column, you will see the following choices:

Edit File
Rename File
Delete File

Choosing the 'Edit File' option will take you to the text-viewer. There, you can add, delete, or comment out code for troubleshooting or development purposes. When finished, make sure you click the 'Save File' button located at the bottom. You'll also note at the bottom of the output pane, the file's URL is displayed so you can easily map to it in the Application Manager. The naming scheme is as follows:

http://webhosting.voxeo.net/AccountID/www/Filename.xml

The options for renaming and deleting files are pretty self-explanatory. Smart coders make a habit out of creating concise, descriptive filenames so that content is loacted easily. Imagine the heaqdaches of looking through fourteeen or so 'helloworld' applications in order to find the right one...........

Recording your own audio files

In the right hand side of the VFM, astute developers will notice an option that allowsd you to record audio over the phone. This recorded audio is conveniently saved within the 'audio' directory of the File Manager so you can easily include it in your application.

Allowable File Extensions

As noted, the VFM will accept .xml, .grammar, and .wav files, but do be aware that we do not support any kind of server-side markups, such as ASP/JSP/PHP/etc. If your wish is to run a more complex app, (such as our downloadable opensource applications), then you will need to find a suitable webhost that does offer support for the server side language in question. A quick Google on the subject will turn uo numerous choices for hosting, some free, and some not-so-free. Choose wisely.

ANNOTATIONS: EXISTING POSTS

mthle01

9/18/2005 8:43 PM (EDT)

<?xml version="1.0" encoding="UTF-8" ?>
- <vxml version="2.1">
<meta name="maintainer" content="YOUREMAILADDRESS@HERE.com" />
- <form>
<block>Hello World. This is my first telephone application.</block>
</form>
</vxml>

JimMurphy

9/19/2005 7:41 AM (EDT)

mthle01,

Is there anything we cam do to help with your development? If so, please open a support ticket from your evolution account and describe the problem. We'd be glad to help.

Thanks,

Jim

NanLu

10/20/2005 3:14 PM (EDT)

I have created my first application and created file "helloworld.xml" like below and Saved changes:

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

<form>
<block>
<prompt>
Hello World. This is my first telephone application.
</prompt>
</block>
</form>
</vxml>

but when I test by calling the # came with the application, I couldn't hear "Hello World" as I expected. why?

MattHenry

10/20/2005 4:53 PM (EDT)

NanLu,

This sort of specific support question is better suited for an account ticket. It might be best if you review the following links, which detail the information that we need in order to effectively troubleshoot your problem:

http://docs.voxeo.com/voicexml/2.0/motty_meta.htm
http://docs.voxeo.com/voicexml/2.0/loggerfeatures.htm
http://docs.voxeo.com/voicexml/2.0/gettingsupport.htm

Regards,

~Matt

chidu_jigajinni

8/18/2006 1:36 AM (EDT)

Hi,
I am a newbie to VXML programming.
I have uploaded a helloworld.xml file onto the server.
But when i try to access the URL given there, namely http://webhosting.voxeo.net/19797/www/helloworld.xml, i see the (110) Connection timed out message. Is the server down or any other problems?

-Chidanand.

MattHenry

8/18/2006 12:58 PM (EDT)

Hello Chidanand,

This URL is only visible from within the voxeo network; the only way that you will be able to view this code in a browser window is when you choose the 'view' icon from within the file manager itself. Simply pasting the http://webhosting.voxeo.net address into a browser will not allow you to view the code at all.

Hope that this clears up the mystery,

~Matthew Henry

qkhader

9/24/2006 11:49 AM (EDT)

i have tried the example helloworld.xml, but when calling i get error message applicatoin could not be open eroor code 6..etc
regards
david

qkhader

9/24/2006 12:04 PM (EDT)

hi i have another question when you i do the sample
<?xml version="1.0" encoding="UTF-8"?>
<vxml version = "2.1" >

<form>
<block>
<prompt>
Hello World. This is my first telephone application.
</prompt>
</block>
</form>
</vxml>

is it actually attached to a TTS engine in order to read the text or i have to attach a wav file, thanks
david

mikethompson

9/24/2006 3:03 PM (EDT)

David,

If you're running your applications in our hosted staging environment, you will have access to two types of text-to-speech engines. By default, our VoiceXML browser uses Speechify text-to-speech, but you also have the option to use Rhetorical. You can find more information on these engines here:

http://www.voicexmlguide.com/appendixm.htm
http://www.voicexmlguide.com/appendixn.htm

Hope this helps,
Mike Thompson
Voxeo Corporation

random_oracle

11/23/2006 6:26 PM (EST)

Thanks for providing this wonderful development platform. I was able to code my first VXML application "Hello world", call up the number and test it in about an hour. Though it is simple, this is an exciting start for me as a newbie to VXML. Have a wonderful Thanksgiving day.

swethareddy

4/3/2007 11:52 PM (EDT)

Hi Colleagues,

I'm trying to start the prophecy home page after installing the Voxeo prophecy server 8.0 and i get the following error:

Warning: DOMDocument::loadXML() [function.loadXML]: Empty string supplied as input in c:\program files\Voxeo\mc\index.php on line 49

Warning: DOMXPath::query() [function.query]: ..\xpath.c:11188 Internal error: document without root in c:\program files\Voxeo\mc\index.php on line 52

Warning: DOMDocument::loadXML() [function.loadXML]: Empty string supplied as input in c:\program files\Voxeo\mc\index.php on line 59

Warning: DOMXPath::query() [function.query]: ..\xpath.c:11188 Internal error: document without root in c:\program files\Voxeo\mc\index.php on line 62

Please suggest how to proceed.

jbassett

4/4/2007 2:26 AM (EDT)

Hello,

I have addressed your issue in the support ticket that you have opened.

Thanks
Jesse Bassett
Voxeo

haresh_gateway

8/11/2007 4:12 AM (EDT)

Hello respected person

i m developing this kind of application in .net
so can u send me some information regarding that.

any resources available?

Thanks

jbassett

8/11/2007 6:58 AM (EDT)

Hello,

Our free hosted environment only allows for xml, wav, and grammar files to be executed. The good news is you can feel free to host the .NET files on your own server as long as they are outputting valid XML code. When you create your first application, just point to the URL of the files hosted on your server.

Here are some examples of how to use VoiceXML with various server side languages.

http://docs.voxeo.com/voicexml/2.0/qs_vars.htm

If you run into any trouble getting something to work, feel free to open a ticket in our support forums.

Thanks,
Jesse Bassett
Voxeo Support

AlanT

11/20/2007 12:57 AM (EST)

Hi,

I am new to VXML and this website.
After I loggin and click the Application Manager, how do I upload my HelloWorld.xml to your webhost?

jbassett

11/20/2007 2:49 AM (EST)

Hello,

From the account menu, choose "Files, Logs, & Reports". You will want to upload your file into the "www" directory. After you have done that you can map your application to this file through "Application Manager"

Cheers,
Jesse Bassett
Voxeo Support

AlanT

11/20/2007 7:35 PM (EST)

Hi,

Now I successfully upload the Helloworld.XML file.
I am in Australia and installed Skype, what number I can dial to hear my HelloWorld ?

MattHenry

11/20/2007 11:47 PM (EST)

Hi Alan,

Once uploaded, you will then choose "account", then "application manager" and hen select theapp name that you have mapped to your application. Then select the "phone numbers" tab, which should list out a bountiful array of options for indialing our application.

Cheers!

~Matthew henry

rahulk

1/29/2008 6:34 AM (EST)

Can i use VXML With ASP.Net & C#.

If yes please give me a sample.

Rahul

voxeojeff

1/29/2008 9:37 AM (EST)

Hi Rahul,

You can use VoiceXML with all different flavors of server-side scripting. However, we do not support server-side scripting. Database queries, stored procedures, and functions on the server side is simply something that we cannot offer support for; even assuming that we did offer support for this, there would be no way that we could offer an accurate response to developer inquiries, as we don't have the database mappings, and have no way of recreating the code locally to test.

As such, I think that your best course of action would be to search for assistance on this matter by visiting a ASP.net-specific site, (such as http://www.w3schools.com/aspnet/default.asp), to see if you can find advice and support in this inquiry.

http://docs.voxeo.com/voicexml/2.0/gettingsupport.htm
http://docs.voxeo.com/voicexml/2.0/intro_serverside.htm
http://docs.voxeo.com/voicexml/2.0/qs_vars.htm

Regards,

Jeff

rahulk

1/31/2008 3:32 AM (EST)

Hi Jeff,

Thank's for support.
I tried my asp.net & C# code. it's working fine.

Thanks
Rahul

rahulk

1/31/2008 3:40 AM (EST)

Hi Jeff,

Suppose my grammar contain word Chemistry.

There are many ways to pronounce the word chemistry.

how dose your engine recognize the word.

is there any option to recognize the word irrespective of Pronunciation.

Thanks
Rahul

VoxeoDante

1/31/2008 10:51 AM (EST)

Hello Rahul,

This is a common issue developers face when designing grammars. The most common option to ensure proper recognition is to add phonetic spellings to the grammar for a given utterance. Like so;

<rule id="THERULE" scope="public">
<one-of>
<item>
<one-of>
<item> tomato</item> <item> tomoto </item>
</one-of>
<tag> <![CDATA[ <MySlot "1"> ]]> </tag>
</item>

<item>
<one-of>
<item> water </item> <item> wadder </item>
</one-of>
<tag> <![CDATA[ <MySlot "2"> ]]> </tag>
</item>

<item>
<one-of>
<item> car </item> <item> kar </item>
</one-of>
<tag> <![CDATA[ <MySlot "3"> ]]> </tag>
</item>
</one-of>
</rule>

Structuring your grammar in the way should help you too capture utterances even if the word is spoken in a slightly different way.

All the best,
Dant� Vitulano
Voxeo Support

amit.l

4/2/2008 6:00 AM (EDT)

Hi

This is very nice. However, I have few questions like if I want to do auto calling to few numbers e.g. I have a list of mobile numbers and a text messages for each on them, and I want to call those numbers then how can I do that using VoiceXML (push service).

Thanks

voxeojeremyr

4/2/2008 4:19 PM (EDT)

Hi,

If you are looking to just dial out a number and then play a message it might be easier to use CCXML 1.0.

We have many examples of doing outbound calls and playing a message in our docs. Some of the places you can look are:

http://docs.voxeo.com/ccxml/1.0-final/tutparent_ccxml10.htm
http://docs.voxeo.com/ccxml/1.0-final/t_7ccxml10.htm

Hopefully, this will get you started in the right direction.

Thanks,
Jeremy Richmond
Voxeo Support

rawat

9/18/2008 5:33 AM (EDT)

Some queries.

1) Is it mandatory to upload the xml files under www directory? I loaded it outside the www after making a sample directory but when i used File manager for mapping it didn't showed it?

2) I can call to the application but i can't hear anything. Already raised a ticket for this and hooping quick reply :)

Cheers
Rawat

voxeoJeffK

9/18/2008 6:12 AM (EDT)

Hi Rawat,

Yes, you will want to upload your files to your Evolution account under the "www" directory. For your question about difficulties connecting, I suggest we concentrate our investigations in the ticket that you have opened so as to avoid any miscommunication.

Regards,
Jeff K.

gopi219

10/6/2008 6:51 AM (EDT)

Hi,

Am new to this VXML. Once I uploaded the XML file what I supposed to do. Do I need to upload separate audio file and to assigning each audio file with relevant portion?!

Plz help me...

voxeoJeffK

10/6/2008 7:38 AM (EDT)

Hi,

I checked your account where I see you have a Hello World application. I tested it, and it works just fine. Have you called the application using one of the provided numbers? If you have, and you are experiencing difficulties then I recommend opening the application debugger, running the Hello World application, and then open a ticket with us from the debugger window. We will be able to troubleshoot any issues you are experiencing.

Please ask if we can clarify anything for you. We are eager to assist.

Regards,
Jeff K.

Chandrajeet

10/22/2008 11:18 AM (EDT)

Thanks for this beatuiful documentation.

How can I change the female tone for IVR to male tone.

Thanks,

voxeojeff

10/22/2008 11:46 AM (EDT)

Hi there,

Thank you for the kind words! :-)

If you wish to test drive a male text-to-speech voice on our Staging environment (Prophecy 8.0 - VoiceXML 2.1, Staging), you can test using either the property or xml:lang versions of the following male voices:

Properties:

<property name="voicename" value="English-Male3"/>

-or-

<property name="voicename" value="English-Male4"/>

xml:lang attribute:


<prompt xml:lang="en-us-m3">

-or-


<prompt xml:lang="en-us-m">

Hope this helps,
Jeff

gayatri87

1/29/2009 1:01 AM (EST)

Hi,

I am a VoiceXML newbie. I have created my first Hello World application and uploaded it successfully.

It was mentioned that :

"This URL is only visible from within the voxeo network; the only way that you will be able to view this code in a browser window is when you choose the 'view' icon from within the file manager itself"

But i am not able to find the "view" icon anywhere in the file manager window. Help!!

voxeoAlexBring

1/29/2009 2:59 AM (EST)

Hello,
I believe you are referring to viewing the source code for an application that you have made under your account? If this is the case, then you can simply goto the application manager under the account tab in your browser. Once you are in the application manager, you can click on any one of the applications that you have created. Once you have chosen an application on your list, you will see some more specific information for that application. You will see:
[code]Start URL 1: file manager | view[/code]

If you click on the "view" button, it will open a new window in your web browser, and inside this window you will see the code for your application. If you want to see your source code as it will show up in a text editor, you can press [code]control + U[/code], and this will open the source code for your application.

If you have any further questions or concerns please let us know and we will be happy to assist.

Regards,

Alex Bring
Voxeo Support

SMathew

3/2/2009 6:17 AM (EST)

Hello,

I have uploaded my helloworld application to the root/www folder and recorded the required prompt.But when I tried calling the application with the suggested number, utilizing the given pin, the prompt didnt play.However, an error message "Error serving VXML Application.Failed to connect to VXML Dialog 2-0-486" was played.After recording the audio file, do we need to allocate the same to the respective application?Wasnt able to use Voice Evolution Application Debugger as all my possible methods to use it failed.

Please suggest.

Thanks
Sheryl

voxeoJeffK

3/2/2009 7:32 AM (EST)

Hello,

The problem was you had the StartURL set to an invalid address.

http://C:\Documents and Settings\smathew\Desktop\VXML

I assumed you wanted the helloworld.xml file mapped to the application, so I took the liberty of changing the StartURL to that file.

Please try it again, and let us know if you have any additional difficulties.

Regards,
Jeff Kustermann
Voxeo Support

SMathew

3/2/2009 7:41 AM (EST)

hello voxeoJeffK

Thanks for fixing the Bug!

But it didnt work this time too.

It played a different error message " That... is not available at this moment.I couln't find the Web Page".

Please suggest.

thanks
Sheryl

voxeoJeffK

3/2/2009 7:54 AM (EST)

Hello Sheryl,

This appears to be a rare anomaly that happens to brand new accounts. I've notified our Network Operations team, and they will investigate the situation. We'll update you as we gather information.

regards,
Jeff Kustermann
Voxeo Support

VoxeoDustin

3/2/2009 12:25 PM (EST)

Hey Sheryl,

This has been corrected. I apologize again for any inconvenience this may have caused.

Cheers,
Dustin Hayre
Customer Support Engineer 2
Voxeo Support

SMathew

3/3/2009 7:07 AM (EST)

Hi Dustin,

Thanks...its working fine now!

Could you please let me know how to use Voice Evolution Application Debugger?

Could you also let me know how we can utilize a prompt that we recorded in our vxml.

Sheryl

voxeoJeffK

3/3/2009 8:02 AM (EST)

Hello,

The Debugger is a real-time log viewer to watch the log output of your development code as the application is run. Simply click the link to the Application Debugger to open it, and the call your application. You will be able to see the progress of the application including any errors.

To play recorded prompts in VoiceXML you will want to use the <audio> tag:

<audio src="MySoundFile.wav" maxage="500" maxstale="1000"/>

You will want to make sure that audio is saved in the correct format. We have more details on playing audio on the Prophecy platform here:

http://www.vxml.org/appendixf.htm

If you need any clarification, or additional help please feel free to let us know.

Regards,
Jeff Kustermann
Voxeo Support

dbernardes

5/13/2009 4:10 PM (EDT)

in Portuguese:
Boa tarde, eu sou do Rio de Janeiro/Brasil e estou estudando esta tecnologia para o uso em um projeto universit�rio, gostaria de saber como eu fa�o para testar a meu projeto feito com o OpenVXML(eclipse)?
eu posso utilizar arquivos de audio no formato .mp3 para resposta?

in English:
Good afternoon, I From Rio de Janeiro/Brazil and I'm studying this technology for use in a university project, I wonder as I do to test my project done with OpenVXML (eclipse)?
I can use audio files in. mp3 to answer?
forgive my bad English ...

voxeoblehn

5/13/2009 4:27 PM (EDT)

Hello Diogo,

As long as your code meets the standards of the VoiceXML 2.0 spec, you should have no problems running on our platforms regardless of how it is written. As for the audio files, the following are supported sound formats for the Voxeo VXML platform:

8bit, 8Khz, u-law Wave files (Riff Format)
16bit, 8Khz, PCM Wave files (Riff Format)

8bit, 8Khz, u-law Sphere files
16bit, 8Khz, PCM Sphere files

Please let us know if you have any additional questions or concerns.

Best Regards,

Brian Lehnen
Voxeo Support

Creating an Application

| TOC

| Caching Techniques