Message Status

Get the status of a particular message: sent, delivered, and read.

Get the read status of a particular message.

GETyourpodURL.symphony.com/pod/v1/message/{mid}/status

Path parameters

mid*string

Message ID

Header parameters

Response

200400401403404500

OK

Body

application/json

authorMessageStatusUser (object)

readarray of MessageStatusUser (object)

All users who have read that message, in any Symphony client.

deliveredarray of MessageStatusUser (object)

All users who have at least one Symphony client to which the message has been delivered, and not read yet.

sentarray of MessageStatusUser (object)

All users to whom the message has been sent and received by the Symphony system, but not yet delivered to any user's Symphony client.

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/message/{mid}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "author": {
    "userId": 7078106103901,
    "firstName": "Gustav",
    "lastName": "Mahler",
    "displayName": "Gustav Mahler",
    "email": "[email protected]",
    "userName": "gmahler",
    "timestamp": 1531968487845
  },
  "read": [
    {
      "userId": 7078106103901,
      "firstName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[email protected]",
      "userName": "gmahler",
      "timestamp": 1531968487845
    }
  ],
  "delivered": [
    {
      "userId": 7078106103901,
      "firstName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[email protected]",
      "userName": "gmahler",
      "timestamp": 1531968487845
    }
  ],
  "sent": [
    {
      "userId": 7078106103904,
      "firsName": "Benjamin",
      "lastName": "Britten",
      "displayName": "Benjamin Britten",
      "email": "[email protected]",
      "userName": "bbritten",
      "timestamp": 1484156123000
    },
    {
      "userId": 7078106103901,
      "firsName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[email protected]",
      "userName": "gmahler",
      "timestamp": 1531968487845
    }
  ]
}

The response indicates the status of the message for internal and external users:

• sent: All users to whom the message has been sent and received by the Symphony system, but not yet delivered to any user's Symphony client.

• delivered: All users who have at least one Symphony client to which the message has been delivered, and not read yet.

• read: All users who have read that message, in any Symphony client.

Note:

• For security reasons, the response excludes userName for external users.

• If a message is suppressed, the sent array will never contain any users as the message would no longer be accessible to users who have not already seen it. If the message has been read or delivered prior to being suppressed, the relevant arrays are available.

📘 known exceptions

• If the user was on the stream when the message was sent and the stream had "viewHistory" (for rooms) enabled, he can get the message status. • If the user is a member of the stream, he can get the message status.

📘 See also

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