conference request Element

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Groups conference-related requests.

Syntax

<conference rid="string value" confId="integer value"/>

Attributes

Attribute	Data Type	Description
rid	String	Request Id. This is a string value assigned by the Unified Communications client. This is a required attribute.
confId	Integer	Conference Id. This is an integer value assigned by the Unified Communications client. This is a required attribute. Filled with zero for initial conference request.

Element Information

Parent Element

Element	Description
cwaRequests	Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access server.

Child Elements

Element	Occurrences	Description
initiateImSession	1	Starts an IM session with one or more users.
acceptImSession	1	Accepts an incoming IM session.
terminateImSession	1	Closes the logged-on user out of an IM session.
sendMessage	1	Sends an IM message to an IM session.
notifyComposing	1	Notifies other users in an IM session that the caller is in the process of typing a message. Valid values are composing or idle.
inviteParticipants	1	Invite others to participate in this conference.
ejectParticipant	1	Remove a participant from a conference.
promoteParticipant	1	Allows a user to lock the conference by promoting a participant to conference leader.
lock	1	Indicates whether potential participants are permitted to join the conference.
voIPRedirect	0 or more	Request the server to redirect the VoIP INVITE to specified uri.
voIPTerminate	0 or more	Request the server to terminate the VoIP INVITE.
voIPReplyWithIM	0 or more	Request the server to reply the VoIP INVITE with IM.

Remarks

The conference request element is the parent for all IM and VoIP-related requests. The confId attribute is assigned by Communicator Web Access server on the request to initiate an IM session. If the conference request is an initiateImSession request, the confId attribute must not be present. Following conference related requests must use the confId returned by Communicator Web Access server in the reply to the initial request.

Examples

The example below illustrates the request to initiate a conference with two participants. The URI specified in the body of this XML request must be online and available for a conference. If an URI is not specified or the specified URI is not available, the Communicator Web Access server returns requestFailed synchronously on the command channel.

<cwaRequests sid="5" xmlns=".../cwa">
   <conference rid="6">
     <initiateImSession>
        <uris>
          <uri>sip:jessicaa@contoso.com</uri>
        </uris>
        <message>
           <format>X-MMS-IM-Format: FN=Arial; EF=; CO=000000; CS=1;
           PF=00</format>
           <content>Can we meet for lunch?</content>
        </message>
     </initiateImSession>
   </conference>
</cwaRequests>