GetReadUsers

[POST] .../v1/chatmessage/getreadusers

Returns users who read the message. Use this method to show read receipts for one chat message while respecting the retention period configured by server settings. The request body is required and id must identify the message when filters are not used; public filters metadata exposes id as the request filters, while limit and offset page the users. The response returns ChatMessageReadUser records with user profile data and read_date and access is scoped to the current user's visibility of the message. Missing body, missing id, denied access, missing message, expired read-receipt retention, profile lookup failures and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of result items.
offset Int32 Optional Result set offset.

Filterable Fields

Field Type Description
id string Message UUID. Required filter field.

Request Example

{
  "filters": [
    {
      "field": "id",
      "operator": "Equal",
      "value": "4b9727ec-a389-4274-95b6-069350000001"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of ChatMessageReadUser Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "user_id": 42,
      "user_name": "Alex Carter",
      "user_photo_url": null,
      "read_date": 1767225600
    }
  ],
  "next_offset": 50,
  "total": 1
}