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

Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access Server.

Syntax

<cwaRequests sid = "integer value" xmlns = "http://schemas.microsoft.com/2006/09/rtc/cwa"></cwaRequests>

Attributes

Attribute	Data Type	Description
sid	integer	Session Id. This is an integer value assigned by the Communicator Web Access Server. It is returned to the client as a synchronous response to the initiateSession request. This is a required attribute.
xmlns	string	The namespace of Unified Communications. This is required for all requests exceptlogon.

Element Information

Child Elements

Element	Occurrences	Description
logon	1 or more	Log on to an Office Communicator Web Access server with specified user credentials.
initiateSession	1 or more	Provides a server with required configuration information after the caller is authenticated using a logon request.
terminateSession	1 or more	Signs off from the server and terminates the session.
addGroup	1 or more	Creates a contact group.
updateGroup	1 or more	Updates a contact group.
deleteGroup	1 or more	Deletes a contact group.
addContact	1 or more	Adds a user to the caller's contact list.
updateContact	1 or more	Updates the setting of a contact.
deleteContact	1 or more	Removes a contact from the user's contact list.
acknowledgeSubscriber	1 or more	Updates the subscription to the caller's presence by one or more subscribers.
conference	1 or more	Grouping for conference related requests.
updateContainer	1 or more	Adds members to or remove members from a container.
publishSelfPresence	1 or more	Allows the Unified Communications AJAX API Client application user to make her presence data available to subscribers.
subscribePresence	1 or more	Represents a request to subscribe to the presence of one or more users. To subscribe means to create a permanent request for the current presence information of a contact.
unSubscribePresence	1 or more	Represents a request to cancel a subscription to a URI (contact).
queryPresence	1 or more	Allows the Unified Communications AJAX API Client application user to make a one-time request for the presence of another user.
publishRawCategories	1 or more	Publishes a set of user-defined categories.
search	1 or more	Searches for users.
voIPRedirect	1 or more	Request the server to redirect the VoIP INVITE to specified uri.
voIPTerminate	1 or more	Request the server to terminate the VoIP INVITE.
voIPReplyWithIM	1 or more	Request the server to reply the VoIP INVITE with IM.

Remarks

This element forms the payload per HTTP POST request over a command channel. Multiple requests can be batched together under this element. The maximum number of the requests in a batch is 256 bytes. And the total number of bytes of the batched requests cannot exceed 256000.bytes.

For all requests except for the initial logon request, the Communicator Web Access namespace ("http://schemas.microsoft.com/2006/09/rtc/cwa") must be included.

Examples

<cwaRequests sid="768" xmlns = "http://schemas.microsoft.com/2006/09/rtc/cwa">
   <conference rid="10" confId="1">
      <initiateImSession>
         <uris>
            <uri>user@contoso.com</uri>
         </uris>
         <message>
            <format>X-MMS-IM-Format: FN=Arial; EF=; CO=00000;CS=1; PF=00</format>
            <content>Can we meet for lunch?</content>
         </message>
      </initiateImSession>
   </conference >
   <addContact rid="11">
      <contact uri="jessicaa@contoso.com" name="..." subscribed="Yes"
         tag="Tag" groups="10 12"/>
   </addContact>
   <publishSelfPresence rid="12">
      <cwaCategory name="..." instanceMask="0"/>
   </publishSelfPresence>
</cwaRequests>