Dialog extension: "audio/wav"

The below sample code illustrates a fully realized CCXML 1.0 application that invokes the "audio/wav" dialog extension. This is a very simple dialog type, where the 'src' attribute determining the .wav file that should be played to the caller. Do note that the complete file will be played, and there is no way to abort the playback with the exception of the <dialogterminate> element being executed. As such, its intended purpose is for short audio prompts, or being used as 'hold music'.

The Voxeo CCXML platform supports a variety of audio formats (see Appendix A for more details). So technically speaking, you are not limited to .wav files only. You may also use HTTP, HTTPS, and FTP formatted URL's for this extension. When playback of the specified audio file has completed, a 'dialog.exit' event will be sent back to the session.

The parameters that are available to the developer are listed below for convenience:

termdigits: specifies a dtmf key that can terminate the playback of the audio file
text: can be used to play back a TTS string instead of a .wav file
voice: denotes the TTS engine to use when streaming a TTS string instead of a .wav file


<?xml version="1.0" encoding="UTF-8" ?> 
<ccxml version="1.0">

  <meta name="author" content="Jeff Menkel"/>
  <meta name="copyright" content="2007 Voxeo Corporation"/>
  <meta name="maintainer" content="YOUR_EMAIL@HERE.COM"/>

  <var name="initState" expr="'state_1'"/>
  <var name="MyCallID"/>

  <eventprocessor statevariable="initState">

    <transition event="connection.alerting" state="state_1">
      <assign name="MyCallID" expr="event$.connectionid"/>
      <send data="'MyEvent'" target="session.id"/> 
    </transition>

    <transition event="MyEvent">
        <accept connectionid="MyCallID"/>     
    </transition>

    <transition event="connection.connected" state="state_1">
      <log expr="'***** CALL WAS ANSWERED *****'"/>
      <dialogstart src="'tastyburger.wav'" type="'audio/wav'"/>
    </transition>
   
    <transition event="error.dialog.notstarted'" state="state_1">
        <log expr="'****** ERROR.DIALOGNOTSTARTED.NAME = ' + event$.name"/>
    </transition>

    <transition event="dialog.exit">
      <log expr="'***** CALL EXITING *****'"/>
      <exit/>
    </transition>

  </eventprocessor>
</ccxml>

Note that you may also download the complete code for testing by clicking here. Copy and paste is SO last-century....

ANNOTATIONS: EXISTING POSTS

amaghazaji

8/4/2008 9:41 PM (EDT)

This code wont work unless you make a few changes to it. you need to Add xmlns and connectionid's.

My problem is the create call is timing out after 60 seconds even though I set the timeout to 90 and it is giving "unknown" as the reason for disconnecting the attempted outcall. any ideas on how to increase that?

<?xml version="1.0" encoding="UTF-8" ?>
<ccxml version="1.0" xmlns="http://www.w3.org/2002/09/ccxml" xmlns:voxeo="http://community.voxeo.com/xmlns/ccxml">

<var name="state0" expr="'init'"/>
<var name="callid_in"/>
<var name="callid_out"/>
<var name="holdMusicDlg"/>
<var name="mainVXMLDlg"/>

<eventprocessor statevariable="state0">





<transition state="init" event="connection.alerting">
<log expr="'ACCEPTING INBOUND CALL'"/>
<accept/>
</transition>





<transition state="init" event="connection.connected" name="evt">
<log expr="'INBOUND CALL CONNECTED / STARTING MAIN VXML DIALOG'"/>
<assign name="callid_in" expr="evt.connectionid"/>
<assign name="state0" expr="'mainVXMLDialog'"/>
<dialogstart src="'testVXML.xml'" dialogid="mainVXMLDlg" connectionid="callid_in"/>
</transition>








<transition state="mainVXMLDialog" event="dialog.exit" name="evt">
<log expr="'FINISHED MAIN VXML DIALOG / CALLERS ANSWER IS: ' + evt.values.answer"/>
<if cond="'1' == evt.values.answer">
<assign name="state0" expr="'calling'"/>
<dialogstart src="'testholdmusic.xml'" dialogid="holdMusicDlg" connectionid="callid_in"/>

<createcall dest="'sip:xxx'" timeout="'90s'" />
<else/>
<exit/>
</if>
</transition>





<transition state="calling" event="connection.failed" name="evt">
<log expr="'OUTBOUND CALL FAILED Reason:' + evt.reason + ':' + evt.info"/>
<assign name="state0" expr="'callfailed'"/>
<dialogterminate dialogid="holdMusicDlg" immediate="true"/>
</transition>

<transition state="callfailed" event="dialog.exit">
<assign name="state0" expr="'playingCallFailed'"/>
<dialogstart src="'testcallfaild.xml'" connectionid="callid_in"/>
</transition>

<transition state="playingCallFailed" event="dialog.exit">
<log expr="'DISCONNECTING INBOUND CALL'"/>
<disconnect/>
</transition>






<transition state="calling" event="connection.connected" name="evt">
<log expr="'OUTBOUND CALL CONNECTED / STARTING WHISPER DIALOG'"/>
<assign name="callid_out" expr="evt.connectionid"/>
<assign name="state0" expr="'callAccepted'"/>
<dialogstart src="'testwhisper.xml'" connectionid="callid_out"/>
</transition>






<transition state="callAccepted" event="dialog.exit" name="evt">
<log expr="'WHISPER DIALOG ENDED / KILLING HOLD MUSIC ----'" />
<assign name="state0" expr="'endHoldMusic'"/>
<dialogterminate dialogid="holdMusicDlg" immediate="true"/>
</transition>






<transition state="endHoldMusic" event="dialog.exit">
<log expr="'HOLD MUSIC ENDED'"/>
<assign name="state0" expr="'bridged'"/>
<send name="'bridgeCall'" target="session.id" delay="'4s'"/>
</transition>

<transition event="bridgeCall" state="bridged">
<join id1="callid_in" id2="callid_out" duplex="'full'"/>
<log expr="'JOIN CALLS LEGS'"/>
</transition>

<transition event="connection.disconnected" name="evt">
<if cond="callid_in == evt.connectionid">
<exit/>
</if>
</transition>

<transition event="error.*" name="evt">
<log expr="'AN ERROR HAS OCCURED (' + evt.reason + ')'"/>
<exit/>
</transition>
</eventprocessor>
</ccxml>

VoxeoDustin

8/4/2008 10:11 PM (EDT)

Hey Amaghazaji,

In our hosted environment, we will try the outbound call over three different carriers. If all attempts fail to complete, our session border controllers will return that the call failed, even if the application set timeout has not expired. In a Premise installation, this value would be honored as long as you set it or until your VoIP provider returned a failure code.

Cheers,
Dustin

D: Dialog Extensions

| TOC

| Dialog Extension: x-fetchdigits