CallXML 3.0 Porting Guide

The hosted platform for Prophecy 8.0 will reach end-of-life by the end of 2011, along with CallXML 2.0 which will no longer be supported.

If any of your applications use CallXML2.0, you must modify your applications to support the newer CallXML3.0 markup. While there is legacy support for CallXML2.0 in the CallXML3.0 platform, you will need to thoroughly test your applications before using the application in Production.

After the Prophecy 8 hosted platform is upgraded to Prophecy 10, any application with a CallXML2.0 declaration will fail. At a minimum, to use CallXML2.0 markup within the CallXML3.0 platform, you must modify the version declaration in each application that uses CallXML2.0.

Frequently Asked Questions

1: Why do I have to move to CallXML 3.0 and what can I expect?
Voxeo is continuously making improvements to its platform, and the CallXML 2.0 markup uses an antiquated code branch. As part of our efforts to continually enhance our IVR services, CallXML 3.0 is the new standard for development, on the Prophecy 10 hosted platform.

2: What do I need to do in order to get ready?
For any existing applications that are currently deployed and active, you will need to test our applications on the new Prophecy 10 staging platform. The first step to making sure that you are ready for this porting effort is to research what version of IVR software that you are currently using on Voxeo's hosted platform. You can:

Within your code, if your initial declaration reads as <callxml version="2.0">, this indicates that your code will always use the CallXML 2.0 engine. By contrast, if your application code specifies <callxml version="3.0">, then your code probably does not need to be modified for Prophecy 10. However, you should still thoroughly test your application in the Prophecy 10 staging environment.
If there is any doubt at all as to what platform that you are using, we encourage you to create a ticket to contact support as ask about your applications.

3: After testing, how do I migrate my Production applications to the Prophecy platform?
When you are ready to switch your applications from the Staging environment to Production, you can create a new Production mapping and then use the Move command on the Contact Methods tab. You can also create a ticket to contact support and list the applications that you want moved to Production.

4: How do I test my applications?
You should test all call paths, event and error handlers, and text-to-speech formatting, audio files, and resource fetch to ensure that no unforeseen problems occur after migrating to the new platform.

5: What if I have a problem during testing?
If you need help, then the Voxeo Support team is standing by to assist 24 hours a day, 365 days a year.

Prophecy CallXML 3.0 features

The following sections describe the major upgrades and additions to CallXML that have been introduced in the deployment of the CallXML 3.0 markup language.

CallXML 3.0 introduces voice recognition capabilities which are enabled by using the new choices attribute. You can specify comma-delimited grammar choices or a fully detailed JSGF grammar, depending on you application needs.
CallXML 3.0 also comes with native XPath 1.0 support that provides a simple interface to access XML data without the Document Object Model. The inclusion of Xpath support also has several built-in functions that can be used by developers for string manipulation, mathematical calculations, and so forth.
SSML syntax to for fine-grained control over text-to-speech output You can tweak, tune, and polish an application for a better caller experience.
Support for conditional logic operations by using test and value-is/value-is-not attributes.

CallXML Application Porting

You must edit your application to move from CallXML 2.0 to the CallXML 3.0 platform.

While in the Prophecy 8 hosted platform, you could map a CallXML2.0 application to a CallXML3.0 application mapping...this will no longer work on the Prophecy 10 hosting platform. This is because support for CallXML2.0 is no longer supported.

To migrate your code from CallXML2.0 syntax to CallXML3.0 syntax

For all CallXML 3.0 documents, the version information specified in the XML version declaration must be set to 3.0 as shown in the following example: <callxml version="3.0">
The <text> element has been replaced by <say>.
Note: Legacy support for the text element is provided in CallXML3.0.
The various <on[EVENTNAME]> handlers have been replaced with <on> handler elements as follows:
- <onanswer> should be changed to <on event ="answer">
- <oncallfailure> should be changed to <on event ="callfailure">
- <oncparesult> should be changed to <on event ="cparesult">
- <onerror> should be changed to <on event ="error">
- <onexternalevent> should be changed to <on event ="externalevent">
- <onhangup> should be changed to <on event ="hangup">
- <onmaxdigits> should be changed to <on event ="maxdigits">
- <onmaxsilence> should be changed to <on event ="maxsilence">
- <onmaxtime> should be changed to <on event ="maxtime">
- <ontermdigit> should be changed to <on event ="termdigit:#">
Note: Legacy support for the <on[EVENTNAME]> handlers is provided in CallXML3.0.
The initial XML declaration must be defined on the first line of the XML output. Developers must ensure that <?xml version="1.0" encoding="UTF-8"?> is on the first line of all applications.
Outbound call transfer syntax via the <transfer>, <call>, or <createconference> elements, or programmatic outbound dialing via a request to http://api.voxeo.net should be specified using a strict e.164 format, as the Prophecy software is more strict in this regard: CallXML 3.0 code should use a syntax that specifies "tel:+<country code><number>", or "tel:+14072223333".
Any reference of <conference targetsessions="$session.EventsenderID;"/> must be changed to <conference value="$session.EventsenderID;"/>, where targetsessions is replaced with value. For all uses of <conference> and anything related to <join/create/destroyconference>, must be updated as follows because of the changes in attribute naming and usage.
- conference targetsessions should be changed to conference value
- createconference name should be changed to createconference value
- joinconference id should be changed to joinconference value
  Note: The id attribute now has a new meaning for the joinconference element.
- destroyconference id should be changed to destroyconference value
  Note: The id attribute now has a new meaning for the destroyconference element.

Next Step

After you update your CallXML2.0 application, you must save it, and then map the updated application to an Evolution CallXML3.0 application mapping for Prophecy 10 as described in the following procedure.

In Evolution, log in to your account.
On the Account menu, click Application Manager.
Click Add Application, enter an application name, and then select Voice phone calls.

Voice Application Type

Voice URL

Phone Number

Create Application

The new application mapping is created, and the number for the application can be found on the Contact Methods tab.

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page

Cache Manager API

| TOC

| Learning CallXML 3.0