Get read receipts for multiple messages

GET https://z.u1v.ru/api/v1/messages/read_receipts

Returns compact read-receipt data for a bounded list of messages. This endpoint applies the same access checks and privacy filtering as GET /messages/{message_id}/read_receipts.

It is intended for clients that need read-status previews for several visible outgoing messages without issuing one HTTP request per message.

Usage examples

curl -sSX GET -G https://z.u1v.ru/api/v1/messages/read_receipts \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'message_ids=[31, 32]'

Parameters

Response

Return values

• read_receipts: object

  A mapping from message ID strings to arrays of user IDs whose read status is visible to the current user.

  • User IDs with a visible read receipt for this message.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "read_receipts": {
        "31": [
            3,
            7
        ],
        "32": []
    },
    "result": "success"
}

Returned when a message ID is inaccessible, read receipts are disabled, or too many message IDs are requested.

{
    "code": "BAD_REQUEST",
    "msg": "Too many message IDs requested.",
    "result": "error"
}