Print

Returning the status of a LaunchCCXML request

About this task

If you invoke a CCXML application using the Application Interface web service LaunchCCXML method, the application started must return the status of that start using a custom event. This allows the CCXML application to determine whether the start was successful instead of relying on the limited information available to the Application Interface web service.

For example, if the CCXML application starts correctly but no one answers the outgoing call, the Application Interface web service still considers the call to be a success because the application started correctly. The CCXML application, on the other hand, may consider that call a failure because no one answered. In this case, the CCXML application would return a failure code to the Application Interface web service, and the Application Interface web service would return the failure code to Experience Portal.

noteNote:

For information on the status related return values that the CCXML application sends, see CCXML application status return values.

Procedure

  1. Create a custom event handler in your application that sends the results back to the Application Interface web service.
  2. In the custom event handler, create a variable called status that contains the status you want to return to the Application Interface web service.

    For example, if the call was not answered, you could assign status the value "no answer" using the <var name="status" expr="no answer"/> tag.

  3. Send the response to the Application Interface web service using a <send> tag with the format: <send name="avaya.launchresponse" targettype="avaya_platform" target="session.id" namelist="status"/>, where session.id is the session identifier assigned to the session by Experience Portal.