All pages
Powered by GitBook
1 of 1

Loading...

Overview of Streams

A Stream is like a container for messages exchanged between two or more users via a given 1 to 1 chat (IM) or chat room.

Each Stream has a unique ID also known as a Conversation ID, that is returned when the IM or chat room is created using the Create Instant Message, Create Non-inclusive Instance Message, and Create Room v3 endpoints respectively. This ID can then be used in subsequent endpoints to perform operations on the IM or chat room.

On the Symphony Messaging web or desktop client, this ID can be found by clicking on the timestamp of any message in the conversation. This will open the Message Status module, where the Conversation ID can be found, as shown in the following picture.

The Conversation ID in the Symphony Messaging Web Client is in Standard Base64 encoding and need to be converted to be URLSafe. Conversation IDs returned in API responses are already URLSafe Base64 encoding.

URLSafe Base64 Conversion

To obtain the URLSafe Base64 Conversation ID:

The following list shows the existing endpoints:

Replace forward slashes / with underscores _
  • Replace pluses + with minuses -

  • Ignore any trailing equal signs =

  • For example, the URLSafe Base64 encoding oflX1hwfmQ+AK/k/a/BB0y2n///q2+0KfbdA== converts to lX1hwfmQ-AK_k_a_BB0y2n___q2-0KfbdA.

    Create IM
    Create IM non-inclusive
    Create Room v3
    Update Room v3
    Room Info v3
    De/Re-activate Room
    Room Members
    Add Member
    Share
    Remove Member
    Promote Owner
    Demote Owner
    Search Rooms v3
    List User Streams
    Stream Info v2
    List Streams for Enterprise v2
    Stream Members