Create IM

Creates a new instant message conversation or returns an existing IM between the specified users and the calling user.

Important: This endpoint also allows the creation of Multi-party Instant Messages, which are not supported anymore. If you need to create a chat with several participants, please create a room instead.

Create a new single or multi party instant message conversation between the caller and specified users.

At least one user ID must be provided or an error response will be sent.

The caller is implicitly included in the members of the created chat.

Duplicate users will be included in the membership of the chat but the duplication will be silently ignored.

If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned.

This method was incorrectly specified to take a query parameter in version 1.0 of this specification but now expects a JSON array of user IDs in the body of the request.

POSTyourpodURL.symphony.com/pod/v1/im/create

Header parameters

Body

application/json

List of (integer) User IDs of participants

itemsinteger (int64)

Response

200400401403500

OK

Body

application/json

idstring

Example: "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/im/create', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      7215545058313,
      7215545078461
    ]),
});
const data = await response.json();

Response

200400401403500

{
  "id": "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"
}

• The calling user is implicitly included as a member of the instant message conversation.

• One other participant must be specified.

• If a user ID appears in the list multiple times, duplicates will be ignored.

• If there is an existing IM conversation with the specified participant, then the id of the existing stream will be returned.

• Use Create IM or MIM non-inclusive to exclude the calling user.

When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

A user needs to have the entitlement isExternalIMEnabled if he wants to create a crosspod IM (User entitlements are set on Admin Portal).

External users must be connected with the caller before adding them.

📘 Overview of streams

A stream is like a container for messages exchanged between two or more users via a given instant message (IM) or chat room. For more information, refer to Overview of streams.