CallXML 3.0 Development Guide

<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

attributes

id	Data Type: (element id)	Default: none - attribute is optional
	The new 'id' attribute in CallXML3.0 is applicable to all container and action elements. Specifying this attribute allows yet another level of control and event handling when events occur and are caught by the `<on>` element. When an event occurs, the handler will first check the event, and then verify that the handler has a handler specific to the 'id' attribute to execute. This allows the developer to plan a specific course of action for events based on where in the application that they occur.
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".
test	Data Type: CDATA	Default: Optional
	The 'test' attribute is a new supplement to the CallXML markup that permits the developer to execute the contents of a container element, or action element, based on whether or not the specified condition is met. If the defined condition is met, then the code contained within the element is then executed. If the condition is not met, then the application resumes execution with the next sequential container container element in the document.
value	Data Type: (sessionID)	Default: 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.
value-is	Data Type: STRING	Default: none - attribute is optional
	Another new attribute, 'value-is', grants the developer with the ability to perform conditional logic upon container elements, or action elements for the first time within the CallXML markup. The value specified in the 'value-is' attribute specifies a string to compare against any 'value' attributes. If the 'value' and 'value-is' equate to 'true', then the element specified will execute. If the value equates to 'false' then the element will be skipped during document execution.
value-is-not	Data Type: STRING	Default: none - attribute is optional
	Another new attribute, 'value-is-not', grants the developer with the ability to perform conditional logic upon container elements, or action elements, for the first time within the CallXML markup. The value specified in the 'value-is-not' attribute specifies a string to compare against any 'value' attributes. If the 'value' and 'value-is-not' equate to 'false', then the element specified will execute. If the value equates to 'true' then the element will be skipped during document execution.

code samples

<3.0 conference - value - termdigits>

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

<callxml version="3.0">

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

<run value="call_target.xml"
submit="*"
method="get"
var="NewSessionID" />

<do label="HoldMusic"
repeat="25">

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

<on event="externalevent:Success">
<log>*** EVENT = SUCCESS ***</log>
<conference value="$session.EventsenderID;"
termdigits="1"/>

<on event="termdigits:1">
<say>
You ended the conference by pressing one.
</say>
<hangup/>
</on>

<on event="externalevent:busy">
<log>*** EVENT = BUSY ***</log>
<prompt value="Sorry, but the number is busy"/>
</on>

<on event="externalevent:noanswer">
<log>*** EVENT = NOANSWER ***</log>
<prompt value="It looks like no one is home"/>
</on>

<on event="externalevent:unreachable">
<log>*** EVENT = UNREACHABLE ***</log>
<prompt value="Your called party is unreachable"/>
</on>

<on event="externalevent:rejected">
<log>*** EVENT = REJECTED ***</log>
<prompt value="Looks like your call recipient rejected the call"/>
</on>

<on event="externalevent:unknown">
<log>*** EVENT = UNKNOWN ***</log>
<prompt value="Received an unknown call failure. Panic at will"/>
</on>

<on event="externalevent:TimedOut">
<log>*** EVENT = TIMED OUT ***</log>
<prompt value="Max time for the call was reached, now disconnecting."/>
</on>

</do>

</block>

</callxml>

<3.0 conference - valueis>

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

<callxml version="3.0">

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

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

<do label="HoldMusic"
repeat="25">

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

<on event="externalevent:Success">
<log>*** EVENT = SUCCESS ***</log>

<conference value="$session.EventsenderID;"/>
value-is="StopMusic"/>

<conference value="$session.EventsenderID;"/>
value-is-not="HoldMusic"/>

<conference value="$session.EventsenderID;"
value-is="HoldMusic"/>

<hangup/>
</on>

<on event="externalevent:busy">
<log>*** EVENT = BUSY ***</log>
<prompt value="Sorry, but the number is busy"/>
</on>

<on event="externalevent:noanswer">
<log>*** EVENT = NOANSWER ***</log>
<prompt value="It looks like no one is home"/>
</on>

<on event="externalevent:unreachable">
<log>*** EVENT = UNREACHABLE ***</log>
<prompt value="Your called party is unreachable"/>
</on>

<on event="externalevent:rejected">
<log>*** EVENT = REJECTED ***</log>
<prompt value="Looks like your call recipient rejected the call"/>
</on>

<on event="externalevent:unknown">
<log>*** EVENT = UNKNOWN ***</log>
<prompt value="Received an unknown call failure. Panic at will"/>
</on>

<on event="externalevent:TimedOut">
<log>*** EVENT = TIMED OUT ***</log>
<prompt value="Max time for the call was
reached, now disconnecting."/>
</on>

</do>

</block>

</callxml>

<3.0 conference test>

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

<callxml version="3.0">

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

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

<do label="HoldMusic"
repeat="25">

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

<on event="externalevent:Success">
<log>*** EVENT = SUCCESS ***</log>

<conference value="$session.EventsenderID;"/>
test="5 = 6"/>

<conference value="$session.EventsenderID;"/>
test="1!=1"/>

<conference value="$session.EventsenderID;"
test="6 = 6"/>

<hangup/>
</on>

<on event="externalevent:busy">
<log>*** EVENT = BUSY ***</log>
<prompt value="Sorry, but the number is busy"/>
</on>

<on event="externalevent:noanswer">
<log>*** EVENT = NOANSWER ***</log>
<prompt value="It looks like no one is home"/>
</on>

<on event="externalevent:unreachable">
<log>*** EVENT = UNREACHABLE ***</log>
<prompt value="Your called party is unreachable"/>
</on>

<on event="externalevent:rejected">
<log>*** EVENT = REJECTED ***</log>
<prompt value="Looks like your call recipient rejected the call"/>
</on>

<on event="externalevent:unknown">
<log>*** EVENT = UNKNOWN ***</log>
<prompt value="Received an unknown call failure. Panic at will"/>
</on>

<on event="externalevent:TimedOut">
<log>*** EVENT = TIMED OUT ***</log>
<prompt value="Max time for the call was
reached, now disconnecting."/>
</on>

</do>

</block>

</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

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