com.avaya.collaboration.call.speech.voicexml.sample

Class SampleVoiceXMLDialog

java.lang.Object

com.avaya.collaboration.call.CallListenerAbstract

com.avaya.collaboration.call.speech.voicexml.sample.SampleVoiceXMLDialog

All Implemented Interfaces:

CallListener

public class SampleVoiceXMLDialog
extends CallListenerAbstract

Sample Code: Start a VoiceXML Dialog on a call

The code below illustrates how to intercept a call and start a VoiceXML dialog. First, to be able to intercept a call, you must implement a class that is annotated with TheCallListener and either implement CallListener or extend CallListenerAbstract. This class is a "listener" that allows you to intercept a call.

Next, you must implement a "VoiceXML dialog listener" class that implements VoiceXMLDialogListener. This class allows you to be notified when important events related to a VoiceXML dialog have occurred. Specifically, when the dialog ends, then the method dialogEvent will be called with the name value pairs specified in the VoiceXML document. If an error occurred starting a VoiceXML dialog then the dialogEvent will be called with the appropriate VoiceXMLDialogCause that indicates an error event.

In the callIntercepted method shown below the following occurs:

• A VoiceXML dialog item is created with a specified document URL
• a VoiceXML dialog is started on one party and a VoiceXML dialog listener listener is provided that provides callback.

The VoiceXML dialog used in the sample is an example of an interactive voice response call that uses Text To Speech and Automatic Speech Recognition.

Since:

3.0

 public class SampleVoiceXMLDialog extends CallListenerAbstract
 {
   private final Logger logger = Logger.getLogger(SampleVoiceXMLDialog.class);
   
   public class MyVoiceXMLDialogListener implements VoiceXMLDialogListener
   {
       private final Participant participant;

       public MyVoiceXMLDialogListener(final Participant participant)
       {
           this.participant = participant;
       }

       @Override
       public void dialogEvent(final UUID requestId, final Map names,
               final VoiceXMLDialogCause dialogEvent)
       {
           logger.info("VoiceXML dialog completed for " + participant);
           participant.getCall().allow();
       }
   }
   
   @Override
   public void callIntercepted(final Call call)
   {
       final VoiceXMLDialogItem voiceXMLDialogItem = SpeechFactory.createVoiceXMLDialogItem();
       try 
       {
           final URI documentUrl = new URI("http://speechserver.test.com/test.vxml");
           voiceXMLDialogItem.setVoiceXMLScript(documentUrl);
           final MyVoiceXMLDialogListener voiceXMLDialogListener = 
                   new MyVoiceXMLDialogListener(call.getCallingParty());
           
           final UUID requestId = SpeechFactory.createSpeechService().startVoiceXMLDialog(
                   call.getCallingParty(), voiceXMLDialogItem, voiceXMLDialogListener);
           logger.info("VoiceXML dialog started with requestId " + requestId.toString());  
       }
       catch(final URISyntaxException e)
       {
           logger.error("Failed to start VoiceXML dialog", e);
       }
   }  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SampleVoiceXMLDialog.MyVoiceXMLDialogListener

Constructor Summary

Constructors

Constructor and Description
SampleVoiceXMLDialog()

Method Summary

Methods

Modifier and Type	Method and Description
void	callIntercepted(Call call) Indicates that the service has intercepted a call.

Methods inherited from class com.avaya.collaboration.call.CallListenerAbstract

addParticipantFailed, callAlerting, callAnswered, callOriginated, callTerminated, mediaDetected, participantDropped

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampleVoiceXMLDialog

public SampleVoiceXMLDialog()

Method Detail

callIntercepted

public void callIntercepted(Call call)

Description copied from interface: CallListener

Indicates that the service has intercepted a call.

Parameters:

call - the intercepted call