List User Streams

Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).

Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).

POSTyourpodURL.symphony.com/pod/v1/streams/list
Query parameters
Header parameters
Body

Stream filtering criteria.

streamTypesarray of StreamType (object)

Types of streams to search for.

includeInactiveStreamsboolean

Whether to include inactive streams in the list of results.

Example: "false"
Response

OK

Body
idstring

The stream ID.

crossPodboolean

If true, this is a cross-pod stream.

activeboolean

If true, this stream is active.

streamTypeStreamType (object)
streamAttributesConversationSpecificStreamAttributes (object)
roomAttributesRoomSpecificStreamAttributes (object)
Request
const response = await fetch('yourpodURL.symphony.com/pod/v1/streams/list', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "crossPod": false,
    "active": false,
    "streamType": {
      "type": "ROOM"
    },
    "streamAttributes": {
      "members": [
        7215545058313,
        7215545078461
      ]
    },
    "roomAttributes": {
      "name": "text"
    }
  }
]

Request Example

curl -X POST \
https://acme.symphony.com/pod/v1/streams/list \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
	"streamTypes": [
  	{"type": "IM"},
    {"type": "MIM"},
    {"type": "ROOM"},
    {"type": "POST"}
  ],
  "includeInactiveStreams": true
}'

streamTypes

streamTypes: A list of stream types (defined as an object) that will be returned. Options are IM (1-1 instant messages), MIM (multiparty instant messages), ROOM (rooms), POST (the user's wall).

{
	"streamTypes": [
    {"type": "IM"}, 
    {"type": "MIM"}, 
    {"type": "ROOM"}, 
    {"type": "POST"}
  ],
	"includeInactiveStreams": true
}

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

Last updated