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

Starts an IM session with one or more users.

Syntax

<initiateImSession/>

Element Information

Parent Element

Element	Description
conference	Grouping for conference-related requests.

Child Elements

Element	Occurrences	Description
uris	1	A list of URIs to be invited to the IM session.
message	1	The message to be displayed in the IM invitation.
subject	1	The subject of the IM session.
format	1	The formatting attributes of the message body

Remarks

This request allows the Unified Communications AJAX API Client application to initiate an IM session and invites participants from their contact list. An individual Uri can represent an individual remote user to invite to a one-to-one conference, one of a set of users to be invited to a focus-based conference, or the focus Uri of the conference itself. The focus Uri is normally used to re-join a conference after being disconnected. The client receives a focus Uri asynchronously on the data channel as part of a conference event

Examples

The logged-on user is initiating an IM conversation with another user who is online. This request succeeds if the request contains a valid URI of a user who is online at the time of the request. There must also be content in the message content element.

<conference rid="2">
   <initateImSession>
      <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>Hey,.can we talk?</content>
      </message>
   </initateImSession>
</conference>

Share via