conference Request

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.

This is the request that provides the context for all IM-related and VoIP-related requests.

Syntax

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

Attributes

Attribute	Data Type	Description
rid	string	Represents the client-assigned instance ID for this request. 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.

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	Occurrence	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.
sendInfo	1	Sends a system message using the SIP INFO verb.
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 invitation to specified SIP URI representing an Office Communicator user.
voIPTerminate	0 or more	Request the server to terminate the VoIP invitation.
voIPReplyWithIM	0 or more	Request the server to reply the VoIP invitation with a new 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. While the conference parent element of the request to initiate an IM session (initiateImSession) contains the confId attribute, it is ignored for this request. Following conference-related requests must use the confId returned by Communicator Web Access Server in the reply to the initial request.