Get Messages

Get messages from an existing stream.

get

A caller can fetch all unseen messages by passing the timestamp of the last message seen as the since parameter and the number of messages with the same timestamp value already seen as the skip parameter. This means that every message will be seen exactly once even in the case that an additional message is processed with the same timestamp as the last message returned by the previous call, and the case where there are more than maxMessages with the same timestamp value.

This method is intended for historic queries and is generally reliable but if guaranteed delivery of every message in real time is required then the equivilent firehose method should be called.

Path parameters

sidstringrequired

Stream ID

Query parameters

sinceinteger · int64required

Timestamp of first required message.

This is a long integer value representing milliseconds since Jan 1 1970

skipintegeroptional

No. of messages to skip.

limitintegeroptional

Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500.

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstringrequired

Key Manager authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'youragentURL.symphony.com/agent/v4/stream/{sid}/message?since=1' \
  --header 'sessionToken: text' \
  --header 'keyManagerToken: text'

200

204

400

401

403

500

200

[
  {
    "messageId": "text",
    "parentMessageId": "text",
    "timestamp": 1,
    "message": "text",
    "sharedMessage": {
      "messageId": "text",
      "parentMessageId": "text",
      "timestamp": 1,
      "message": "text",
      "sharedMessage": "[Circular Reference]",
      "data": "text",
      "attachments": [
        {
          "id": "text",
          "name": "text",
          "size": 1,
          "images": [
            {
              "id": "text",
              "dimension": "text"
            }
          ]
        }
      ],
      "user": {
        "userId": 1,
        "firstName": "text",
        "lastName": "text",
        "displayName": "text",
        "email": "text",
        "username": "text"
      },
      "stream": {
        "streamId": "text",
        "streamType": "text",
        "roomName": "text",
        "members": [
          {
            "userId": 1,
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        ],
        "external": true,
        "crossPod": true
      },
      "externalRecipients": true,
      "diagnostic": "text",
      "userAgent": "text",
      "originalFormat": "text",
      "disclaimer": "text",
      "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
      "replacing": "text",
      "replacedBy": "text",
      "initialTimestamp": 1,
      "initialMessageId": "text",
      "silent": true
    },
    "data": "text",
    "attachments": [
      {
        "id": "text",
        "name": "text",
        "size": 1,
        "images": [
          {
            "id": "text",
            "dimension": "text"
          }
        ]
      }
    ],
    "user": {
      "userId": 1,
      "firstName": "text",
      "lastName": "text",
      "displayName": "text",
      "email": "text",
      "username": "text"
    },
    "stream": {
      "streamId": "text",
      "streamType": "text",
      "roomName": "text",
      "members": [
        {
          "userId": 1,
          "firstName": "text",
          "lastName": "text",
          "displayName": "text",
          "email": "text",
          "username": "text"
        }
      ],
      "external": true,
      "crossPod": true
    },
    "externalRecipients": true,
    "diagnostic": "text",
    "userAgent": "text",
    "originalFormat": "text",
    "disclaimer": "text",
    "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
    "replacing": "text",
    "replacedBy": "text",
    "initialTimestamp": 1,
    "initialMessageId": "text",
    "silent": true
  }
]

OK

📘 Optional attributes returned

Note that some attributes are returned in the payload only under specific conditions:

• sharedMessage only when the message represented by this class is a wall post sharing another message;

• initialMessageId, initialTimestamp, and replacing only when the corresponding message is sent as an update to another message thanks to Update Message endpoint. Note that the first two attributes relate to the original (and therefore first) message sent, whereas the replacing attribute relates to the message that has been updated by this message;

• replacedBy only when this message has been updated by a new message. It contains the id of the replacing message.

• parentMessageId only when this message is a reply or a forward of another message which id is returned in this attribute.

Pagination usage

• The skip parameter is supposed to be used to skip messages that have the same timestamp as the one specified on since.

• Pagination is supposed to use the since parameter instead of skip and limit.

Examples:

If you want to get two messages at a time skipping the ones you have already seen, the calls should be the following:

1. First call https://acme.symphony.com/agent/v4/stream/sid/message?since=0&limit=2

2. Second call Let's assume here that the timestamp from the message returned on the first call was 1551052800000 and there was no other message with that same timestamp returned.

https://acme.symphony.com/agent/v4/stream/sid/message?since=1551052800000&limit=2&skip=1

It returns the two messages received after or on the timestamp 1551052800000, skipping one message from that same timestamp (which is the one you have already seen).

Note that you can keep doing this process with subsequent calls.

📘 Supported stream types

In addition to conversation streams such as IM, Chat rooms and Wall posts, Symphony also supports other types of streams, some of them reserved for internal use. These other stream types (ACTION, POST, PRIVATE_CHANNEL, MEETING, SUPPRESS_JUSTIFICATION) are not supported by the Get Messages endpoint.

📘 See also:

Message MessageML Message ID Message Format - MessageML PresentationML Message Format - ExtensionML Colors