LaunchCCXML method

Last Updated : Sep 01, 2020 |
Prolog information
Metadata
Keywords:
This method starts the specified CCXML application, and, if successful, returns the:
  • Experience Portal session ID for the new session
  • Total number of outbound resources available, both used and unused
  • Total number of unused SIP outbound resources
  • Total number of unused H.323 outbound resources
Important:
The CCXML application started must return the status of that start using a custom event as described in Returning the status of a LaunchCCXML request. For information on return values, see CCXML application status return values. The return values are described Return values.
Note:
If a CCXML application starts multiple VoiceXML applications, each of these applications can use a different speech server. Prior to Experience Portal 7.0, multiple applications used only one speech server. This feature comes into play if you have different languages loaded onto different speech servers.
When a CCXML application starts a VoiceXML dialog by name, the configured ASR or TTS is used. If the configured ASR or TTS changes, the current ASR or TTS resources are released and new resources are seized before the dialog starts.
For example, a CCXML application can start a dialog with English ASR or TTS. The application can determine that the caller prefers Spanish and so, the second dialog is opened with Spanish ASR or TTS.

Parameters

Parameter
Type
Description
toURI
String
Provides a hint to the Application Interface web service about what resources this CCXML application requires.
The options are:
  • Blank (no input): Indicates that there are no requirements.
  • tel: Use this for an H.323 or SIP connection, or a mix of both.
  • sip: Use this for a standard SIP connection.
  • sips: Use this for a secure SIP connection.
applicationName
String
Name of the CCXML application to run once the outbound call has connected.
Important:
The applicationName must match the name that was specified when the application was added to Avaya Experience Portal through the EPM.
For an application that is assigned to a non-default zone, include the zone information using the format: ZoneId:applicationName
You can view all application names on the Applications page.
You can retrieve the zone Id information using the getZoneInfo method of the Management Interface web service.
applicationURL
String
Parameters that should be appended to URL specified for the application in the EPM.
This allows you to invoke the application with different arguments as needed.
parameters
String
One or more name-value variable pairs that will be passed to the CCXML application when it is invoked. Each pair should be in the format parametername=value, and multiple pairs should be separated by a ; (semi-colon).
Note:
When the web service passes the parameter to the application, it appends the namespace session.values.avaya.ParameterMap. Therefore, the variable should be referenced in your application as session.values.avaya.ParameterMap.parametername.
For example, if you specify UserCounter=0 in the web service, you would reference session.values.avaya.ParameterMap.UserCounter in your application.
uuiInfo
String
The Application Interface web service passes any information in this parameter to the platform telephony layer included in the outbound call.
launchTimeout
Integer
The maximum amount of time, in seconds, to wait for the CCXML application to be start before returning an error message.
zone
String
Zone name where request should be directed. This is the zone name. (Optional).

Data returned

Parameter
Type
Description
sessionID_returned
String
If the CCXML application connected successfully, the Application Interface web service sets this return value to the session ID Experience Portal assigned to the new CCXML session.
totalRes_returned
Integer
Total number of outbound resources available, both used and unused.
unusedSIP_returned
Integer
Total number of unused SIP outbound resources.
unusedH323_returned
Integer
Total number of unused H.323 outbound resources.
Note:
If zones are enabled, the returned resource information is the information for either the zone specified in the request, or for the default zone, if no zone was specified.

CCXML application status return values

Status
App Intf WS rc
Application
"success" `
0
"networkdisconnect"
0
"nearenddisconnect"
0
"farenddisconnect"
0
"calltransferred"
0
"parse error"
0x22 (Invalid URL)
"uri not found"
0x22 (Invalid URL)
"fetch timeout"
0x13 (Failed)
LaunchCCXML only
"web server error"
0x13 (Failed)
LaunchCCXML only
"fetch error"
0x13 (Failed)
LaunchCCXML only
"unknown error"
0x13 (Failed) v
LaunchCCXML only
"noresource"
0x2 (No Resource)
"busy"
0x10 (Busy)
"networkbusy"
0x10 (Busy)
"noanswer"
0x11 (No Answer)
"noroute"
0x20 (Invalid URI)
LaunchVXML only
"unknown"
0x12 (Network Refusal)
LaunchVXML only
"internalerror"
0x12 (Network Refusal)
LaunchVXML only
"glare"
0x12 (Network Refusal)v
LaunchVXML only
"invalidstate"
0x12 (Network Refusal)
LaunchVXML only
"fax detected"
0x16 (Fax Detected)
Note:
All return values generated by the LaunchVXML and LaunchCCXML may not have a mapping to the status that the CCXML application sends.