Mark Messages as Read

1.   / 
2. API   / 
3. Message   / 
4. Read

---

Description

wss message_read

The message_read request marks messages as read on the server and notifies other online users about this.

Request Parameters

Name	Type	Description
cid	string	Conversation ID where messages are located
ids	array[string]	Array of messages that need to be marked

Note

If ids is omit, we mark all unread messages as read.

Response Fields

Response

{
  "id": "RequestId",
  "success": true
}

Example

Request

{
  "request": {
    "message_read": {
      "cid": "63077ad836b78c3d82af0812",
      "ids": ["63480e68f4794709f802a2fa", "63077ad836b78c3d82af0866"]
    },
    "id": "RequestId"
  }
}

Caution

Conversation type c do not support read status.

Then, all the users whose messages we read will receive the following message:

Event

{
  "message_read": {
    "cid": "63077ad836b78c3d82af0812",
    "ids": ["63480e68f4794709f802a2fa", "63077ad836b78c3d82af0866"],
    "from": "634ec51c0b65918393dca5bf"
  }
}

See Also

SAMA chat server API: Messages Based on ease of use, and with easy-to-understand documentation and articles on how to set up and use our APIs, we want to show that it is REAL to build communication into your application.

DataBase Records Collection of complete objects stored in the database.