LaunchVXML method

Last Updated : Jun 23, 2021 |
Prolog information
Metadata
Keywords:
This method initiates an outbound call on an available MPP, then starts the specified VoiceXML application. If successful, it 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
The actual launch of the VoiceXML application is handled by the default CCXML page, which is also responsible for returning success or failure back to the Application Interface web service.
When the VoiceXML application is invoked, the first VoiceXML page is prepared. If this succeeds, the outbound call is placed by the system. If the call connects and the dialog starts without error, then the VoiceXML application returns a successful launch code. Otherwise, the application returns an appropriate error code.
Note:
If the initial VoiceXML page cannot be prepared for any reason, the Application Interface web service does not place the outbound call. Therefore a customer will never be bothered by an outbound call that cannot possibly start correctly.
For information about the status codes returned by the CCXML page, see Returning the status of a LaunchCCXML request.
Note:
If a CCXML application launches 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 launches 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 launch a dialog with English ASR or TTS. The application can determine that the caller prefers Spanish and so, the second dialog is launched with Spanish ASR or TTS.
Important:
The return values are described Return values.

Parameters

Parameter
Type
Description
toURI
String
The number or destination to be contacted by the outbound application.
This parameter can be prefixed with one of the following strings:
  • 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.
fromURI
String
Calling address information to pass with the outbound call.
applicationName
String
Name of the VoiceXML 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 VoiceXML 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.avaya.telephone. Therefore, the variable should be referenced in your application as session.avaya.telephone.parametername.
For example, if you specify UserCounter=0 in the web service, you would reference session.avaya.telephone.UserCounter in your application.
Tip:
If you want to enable call classification for this call, see Call classification with the LaunchVXML method.
uuiInfo
String
The Application Interface web service passes any information in this parameter to the platform telephony layer included in the outbound call.
connectTimeoutSecs
Integer
The maximum amount of time, in seconds, to wait for the outbound call to be connected.
Enter a value between 0 and 59.
If this parameter is set to 0 (zero) or omitted, Experience Portal uses the default value of 120 seconds.
zone
String
This is the zone name where request should be directed. (Optional).

Data returned

Parameter
Type
Description
sessionID_returned
String
If the VoiceXML 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 resource information returned is the information for the zone specified in the request. If no zone is specified, the resource information returned is the information for the default zone.