conference Event

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 events.

Syntax

<conference eid="1344" confId="200">
</conference>

Attributes

Attribute	Data Type	Description
Eid	integer	Event Id. This is an integer value assigned by the Communicator Web Access Server.
confId	integer	Conference Id. This is an integer value assigned by the Communicator Web Access Server. This is a required attribute.

Element Information

Parent Element

Element	Description
cwaEvents	Holds the responses from the asynchronous data channel with which a Unified Communications AJAX API Client polls the server for updates that have taken place.

Child Elements

Element	Occurrence	Description
imSessionReceived	0 or more	Indicates that an instant messaging session invitation is received.
imSessionState	0 or more	Returns data or metadata related to an IM conversation. Possible values are connected, incoming, connecting, or terminated.
messageReceived	0 or more	Returns an IM message received from another participant.
messageIdReceived	0 or more	An identifier returned by the other end indicating which message this is in the sequence.
messageSendFailed	0 or more	Indicates a failure in sending an IM message.
composingState	0 or more	Notifies other users in an IM session that the caller is in the process of typing a message. Possible values are composing or idle.
locked	0 or more	Indicates whether others are permitted to join the conference.
escalationMode	0 or more	Indicates what the mode the conference is in. Possible values are invitingPeer, peer, escalated, or escalating.
role	0 or more	Indicates the role of the participant in a session.
participant	0 or more	Indicates that a participant has been added or updated to the IM session.
participantRemoved	0 or more	Indicates that a participant has been removed from the IM session.
voIPReceived Element	0 or more
voIPTerminated Element	0 or more

Remarks

The conference event element is the parent for all IM-related events that a Unified Communications AJAX API Client application receives. The following example illustrates the request to initiate a conference with two participants. The uri specified in the body of this XML request must be on-line 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.

Examples

In this example, Sally G. has sent a message to Jay A. through a peer-to-peer IM session. The cwaEvents packet contains mode, state, participant, and message information.

<cwaEvents pollWaitTime="2000" ackId="36" sid="83">
   <conference eid="33" confId="1">
      <escalationMode>peer</escalationMode>
   </conference>
   <conference eid="34" confId="1">
     <imSessionState>connected</imSessionState>
   </conference>
   <conference eid="35" confId="1">
      <participant uri="sip:jessicaa@contoso.com" name="Jay"
      role="attendee" />
   </conference>
   <conference eid="36" confId="1">
     <messageReceived sender="sip:sallyg@contoso.com">
        <message>
           <format>X-MMS-IM-Format: FN=Arial; EF=; CO=000000; CS=1;
           PF=00/>
             <content>hello</content>
        </message>
     </messageReceived>
   </conference>
</cwaEvents>

Share via