Message Status

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

Get the read status of a particular message.

get

Path parameters

midstringRequired

Message ID

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

404

Not Found: Message ID does not exist.

application/json

500

Server error, see response body for further details.

application/json

get

HTTPcURLJavaScriptPython

GET /pod/v1/message/{mid}/status HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "author": {
    "userId": 7078106103901,
    "firstName": "Gustav",
    "lastName": "Mahler",
    "displayName": "Gustav Mahler",
    "email": "[e-mail]",
    "userName": "gmahler",
    "timestamp": 1531968487845
  },
  "read": [
    {
      "userId": 7078106103901,
      "firstName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[e-mail]",
      "userName": "gmahler",
      "timestamp": 1531968487845
    }
  ],
  "delivered": [
    {
      "userId": 7078106103901,
      "firstName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[e-mail]",
      "userName": "gmahler",
      "timestamp": 1531968487845
    }
  ],
  "sent": [
    {
      "userId": 7078106103904,
      "firsName": "Benjamin",
      "lastName": "Britten",
      "displayName": "Benjamin Britten",
      "email": "[e-mail]",
      "userName": "bbritten",
      "timestamp": 1484156123000
    },
    {
      "userId": 7078106103901,
      "firsName": "Gustav",
      "lastName": "Mahler",
      "displayName": "Gustav Mahler",
      "email": "[e-mail]",
      "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