Create IM non-inclusive

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

Important: This endpoint also allows the creation of Multi-party Instant Messages (MIM), 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

At least two user IDs must be provided or an error response will be sent.

The caller is not 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.

post

/v1/admin/im/create

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

itemsinteger · int64

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/im/create' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[7215545058313,7215545078461]'

200

400

401

403

500

200

{
  "id": "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"
}

OK

• Two participants 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 participants, then the id of the existing stream will be returned.

• Use Create IM to include the calling user.

🚧 Required Permissions

This endpoint can only be called by Service Users with the User Provisioning role. See Bot Permissions for a list of roles and associated privileges.

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