CallXML 3.0 Development Guide

<destroyconference> element

The <destroyconference> element is used o tear down active sessions spawned via <createconference> after the session has ended. Failure to destroy active conference sessions can result in degradation of system performance in a locally deployed IVR environment. As such, this element is required to be utilized when leveraging the multi-party conferencing functionality in CallXML 3.0

usage

attributes

expr	Data Type: STRING	Default: none - attribute is optional
	The 'expr' attribute is a powerful new addition to the CallXML 3.0 markup that allows the developer to use XPath (http://www.w3.org/TR/xpath), features within applications. When used with the `<assign>` element, this attribute specifies the Xpath data for identifying XML nodes via Location Paths, and the built-in Expressions, and Functions. When using Xpath, note that both the 'expr' and the 'var' and 'value' elements must be specified.'
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.
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 destroyconference value-test >

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

<callxml version="3.0">

<assign var="moderator" value="'false'"/>
<assign var="moderator" value="'true'" test="'$session.callerID;' = '4071112222'"/>

<do label="modBlock">

<playaudio value="welcomeConf.wav"
say="Welcome to the conference bridge."/>
<log>*** MODERATOR = $moderator; ***</log>
</do>

<do label="confBlock" choices="[5 DIGITS]">

<playaudio value="enterConferenceID.wav"
say="Enter your 5 digit conference eye dee now."/>

<wait value="5s"/>

<on event="choice">
<assign var="conferenceName" value="$session.lastchoice;"/>
<log>** CONFERENCE NAME = $conferenceName; **</log>
<goto value="#createJoin"/>
</on>

<on event="maxsilence">
<playaudio value="noMatch.wav" say="I'm sorry, that didnt match anything I was expecting."/>
<goto value="#confBlock"/>
</on>

<on event="choice:nomatch">
<playaudio value="nomatch.wav" say="I'm sorry, I didn't understand that."/>
<goto value="#confBlock"/>
</on>
</do>

<do label="createJoin">
<playaudio value="joinConference.wav" say="You will now join the conference. Press the pound key to leave the conference."/>

<createconference value="$conferenceName;" var="conferenceid"/>
<joinconference value="$conferenceid;" termdigits="#"/>

<on event="hangup">
<log>** HANGUP DETECTED **</log>

<destroyconference value="$conferenceid;" test="$moderator; = 'true'"/>
<exit/>
</on>

</do>


<do label="catchConfExit" choices="#">
<wait value="2s"/>
<on event="choice">
<log>** CAUGHT TERMCHAR FROM CONF **</log>
</on>
</do>

<do label="leaveConference" choices="1,2">
<playaudio value="leaveConference.wav"
say="You have left the conference. Press 1 to re join the conference, or press 2 to join a new conference"/>
<wait value="10s"/>

<on event="choice:1">
<log>** REJOINING CONFERENCE **</log>
<goto value="#createJoin"/>
</on>

<on event="choice:nomatch">
<goto value="#leaveConference"/>
</on>

<on event="choice:2">
<log>** STARTING A NEW CONFERENCE **</log>
<goto value="#modBlock"/>
</on>

<playaudio value="kickedOut.wav"
say="we did not hear anything. we will now end the call."/>
<hangup/>
</do>

<on event="hangup">
<log>** HIGHER SCOPE HANGUP DETECTED **</log>

<destroyconference value="$conferenceid;"/>
<exit/>
</on>

</callxml>

additional links

none

ANNOTATIONS: EXISTING POSTS

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