IM Info

Returns information about a particular IM conversation.

Get information about a partcular IM.

get

Path parameters

idstringRequired

IM streamId

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

OK

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

get

/v1/im/{id}/info

HTTPcURLJavaScriptPython

GET /pod/v1/im/{id}/info HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "V1IMAttributes": {
    "pinnedMessageId": "vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ"
  },
  "IMSystemInfo": {
    "id": "usnBKBkH_BVrGOiVpaupEH___okFfE7QdA",
    "creationDate": 1610520703317,
    "active": true
  }
}

📘 Stream ID

The stream ID can be located in the Symphony web or desktop client by clicking on the timestamp of any message in the conversation. This will open the Message Status module overlay, and the Conversation ID can be found in the overlay footer.

The stream ID in the UI is in Standard Base64 encoding. When the stream ID needs to be used in a URL, it should be in URLSafe Base64 encoding. To obtain the URLSafe Base64 stream ID, replace forward slashes with underscores, replace pluses with minuses, and ignore any trailing equal signs.

See Overview of streams for details.

🚧 Required Permissions

Streams information can only be requested by:

• Members of the IM

• Compliance Officers and Super Compliance Officers who are not members of the stream

• Service Users with the User Provisioning role (members or not members of the stream)

See Bot Permissions for a list of roles and associated privileges.