CallXML 2.0 Development Guide

Home | Frameset Home

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.

<joinconference> element

The joinconference element is used in conjunction with the createconference element to create multiparty conferencing. Specifically, this element allows you to join a caller to a specific existing conference.

usage

attributes

entertone	Data Type: string - URI	Default: Optional (true)
	The entertone attribute allows the developer to modify or turn off entirely, the default tone that plays when a user joins an existing conference. Allowable values are 'false' or the user may specify a wav file to play instead of the default 'beep' tone that is normally heard.
exittone	Data Type: string - URI	Default: Optional (true)
	The exittone attribute allows the developer to modify or turn off entirely, the default tone that plays when a user leaves an existing conference. Allowable values are 'false' or the user may specify a wav file to play instead of the default 'beep' tone that is normally heard.
id	Data Type: ID	Default: Required
	The id attribute is used to specify a unique conference identifier. The value is set to the session variable of $conferenceid; which is used internally by the CallXML platform.
listenonly	Data Type: (true\|false)	Default: Optional (false)
	The listenonly attribute allows the developer to specify that a member of the conferenece may eavesdrop only, and effectively create a half-duplex conference, (i.e. listenonly='true' means that a conference particpant will not be heard by other members of the conference)
termdigits	Data Type: (123456789*#\|ABCD)	Default: none - attribute is optional
	This attribute holds the list of touch-tone digits which can terminate the current caller action. 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

none

code samples

<Joinconference> sample

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

<inputdigits
label = "getconid"
value = "enterConferenceID.wav"
var = "conferenceName"
maxdigits = "10"
termdigits = "#"
cleardigits = "false"
maxtime = "30s"
maxsilence = "5s">

<ontermdigit value="#"/>
<onmaxsilence>
<playaudio value="noInput.wav"/>
<goto value="#getconid"/>
</onmaxsilence>
<onmaxtime/>
<onmaxdigits/>
</inputdigits>

<playaudio value="joinConference.wav"/>
<block label="test">
<createconference name="$conferenceName;" var="conferenceid" />
<joinconference id="$conferenceid;" termdigits="#"/>
<ontermdigit>
<playaudio value="leaveConference.wav" termdigits="123"/>
<wait value="3000s" termdigits="123"/>
<ontermdigit value="2">
<goto value="#test"/>
</ontermdigit>
<ontermdigit value="3">
<goto value="#getconid"/>
</ontermdigit>
</ontermdigit>
</block>

</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page