callxml elements - conference

CallXML 2.0 Development Guide

This documentation is for CallXML 2, which has been superceded by CallXML 3. The CallXML 2 language is not being updated any longer. CallXML 3, however, has many new features and is actively being enhanced. If you're writing a new CallXML application, you should use CallXML 3. Click here for the CallXML 3.0 documentation.

<conference> element

This element allows multiple lines in separate sessions to be conferenced together so that the parties on each line can talk to each other simultaneously. The list of sessions to conference together is specified by the attribute targetSessions, and can be one more unique session identifiers separated by commas.

usage

<conference targetsessions="(sessionID)" termdigits="(123456789*#|ABCD)">

attributes

targetsessions	Data Type: (sessionID)	Default: none - attribute is required
	This attribute holds one or more unique session identifiers, separated by commas that the CallXML application will conference. An empty value, or an invalid target session will result in an error.
termdigits	Data Type: (123456789*#\|ABCD)	Default: none - attribute is optional
	This attribute holds the list of touch-tone digits which can terminate the conference. Note that for each termdigit specified, there should be an <ontermdigit> handler in the code to catch the event. Allowable values are any one of "012356789*#", the ordinary DTMF (Touch-Tone) keypad possibilities, plus the special keypad tones found on some telephones "ABCD".

possible events

onerror type="document"	Document was unable to be fetched for all the reasons web servers are unavailable
onerror type="invalidconference"	Bad target conference
onerror type="linenotactive"	Trying to issue a telephony event such as <getdigits> or <playaudio> on a non-active line
onerror type="telephony"	Unable to issue a telephony event such as <call> or <playaudio> or <ftp>
onhangup	This event occurs when a session determines that one side of the call has hung up. A typical use for this handler is to execute any necessary clean-up code. See the onhangup element description for further details.
ontermdigit	Used for catching and handling term digit events as they occur in the call flow. See the ontermdigit element description for further details.

code samples

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

<callxml version="2.0">

<block>
<assign var="ParentSessionID" value="$session.ID;"/>
<assign var="NumToCall" value="1112223333"/>

<run value="Call_Target.cfm"
submit="*"
method="get"
var="NewSessionID" />

<block label="HoldMusic">

<text>
Here we will con ference two sessions together.
We can press one at any time to end the conference.
</text>

<playaudio format="audio/wav"
value="RingTone.wav"/>

<onexternalevent value="Success">
<conference targetsessions="$session.EventsenderID;" termdigits="1"/>

<ontermdigit value="1">
<text>
You ended the conference by pressing one.
</text>
</ontermdigit>

<hangup/>
</onexternalevent>

<onexternalevent value="Busy">
<text>
All lines are currently busy.
Please hang up and try your call again later.
</text>
<hangup/>
</onexternalevent>

<onexternalevent value="TimedOut">
<text>
There is no answer.
Please hang up and try your call again later.
</text>
<hangup/>
</onexternalevent>

</block>

</block>

</callxml>

<call_target.xml>

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

<callxml version="2.0">

<block label="B1">

<call value="$NumToCall;"
maxtime="20s"/>

<onanswer>
<sendevent value="Success"
session="$ParentSessionID;"/>
<conference targetsessions="$ParentSessionID;"/>
</onanswer>

<oncallfailure value="busy">
<sendevent value="busy"
session="$ParentSessionID;"/>
</oncallfailure>

<oncallfailure value="noanswer">
<sendevent value="noanswer"
session="$ParentSessionID;"/>
</oncallfailure>

<oncallfailure value="unreachable">
<sendevent value="unreachable"
session="$ParentSessionID;"/>
</oncallfailure>

<oncallfailure value="rejected">
<sendevent value="rejected"
session="$ParentSessionID;"/>
</oncallfailure>

<oncallfailure value="unknown">
<sendevent value="unknown"
session="$ParentSessionID;"/>
</oncallfailure>

<onmaxtime>
<sendevent value="TimedOut"
session="$ParentSessionID;"/>
</onmaxtime>

</block>

</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

answervoice

9/1/2006 11:13 AM (EDT)

Hi,

This code does not function on the platform Map Evolution

MattHenry

9/1/2006 1:55 PM (EDT)

Hello Patrick,

This is a known issue that became apparant with a recent Build of Prophecy. There is an existing bug ticket opened for this issue, (#145348), and when this issue is corrected, we will post back to this thread confirming that the problem has been addressed. In the meantime, you can use the <transfer> element for bridged transfers using the CXML platform.

~Matthew Henry

omcdonald

1/16/2007 9:53 PM (EST)

I am also having the same problem with the conference function. Any ETA for a fix or workaround? Thanks.

VoxeoTony

1/17/2007 12:05 AM (EST)

Hello,

The issue that was posted for this thread originated on a different platform offering for our European MAP platform. This was addressed in bug ticket 145348 and subsequently fixed back on 11/20/2006.

We don't show that your account is utilizing the MAP platform. We would like to assist you with finding out what your issue is with the conference documentation as it pertains to you. If you found that the documentation is incorrect at some level then please post back here. If you feel that this is an issue you would like the support team to assist you with please submit a ticket so that the information we would need to troubleshoot is kept confidential.

Tony