initiateImSession Request

  • Article

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>
   <uris>
      <uri>sip:jessicaa@contoso.com</uri>
   </uris>
   <message>
      <format>text/plain</format>
      <content>We need to talk!</content>
      <Format>X-MMS-IM-Format: FN=Arial; EF=; CO=000000; CS=1; PF=00]</Format>
   </message>
   <subject>Contoso New Building Plans</subject>
</initiateImSession>

The following sections describe attributes, parent elements, and child elements.

Element Information

Parent Element

Element

Description

conference

Grouping for conference-related requests.

Child Elements

Element

Occurrence

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.

Remarks

This request allows the Unified Communications AJAX API Client application to initiate an IM session and invites participants from their contact list.

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.

Request

<conference confId="1" 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>

Resultant events

<requestAccepted rid="1">
   <sid>15</sid>
   <uri> sip:jessicaa@contoso.com</uri>
   <PollWaitTime>3000</PollWaitTime>
</requestAccepted>
<requestAccepted rid="2">
   <initiateImSessionAccepted rid="2" confId="1" />
</requestAccepted>