Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/viewers.md индекс документации — /llms.txt

Кто просмотрел сообщение

GET /v1/chats/messages/:messageId/viewers

Возвращает просмотры сообщения — кто и когда его увидел. Чат определяется по сообщению, dialogId не нужен.

Параметры

Параметр Тип Обяз. По умолч. Описание
messageId (path) number да — ID сообщения, положительное целое — из ленты чата (GET /v1/chats/:dialogId/messages) или из ответа отправки
lastId (query) number нет — Курсор: id последнего просмотра предыдущей страницы. Граница исключающая
order (query) string нет desc desc — от новых просмотров к старым, asc — от старых к новым
limit (query) number нет 50 Просмотров на странице. От 1 до 200: значение вне диапазона срезается, переданное и применённое значения — в meta.requestedLimit и meta.appliedLimit

Другие параметры и повторы отклоняются с 400 INVALID_PARAMS.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/messages/1002/viewers?limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/messages/1002/viewers?limit=20" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/viewers?limit=20', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Просмотрели:', data.views.map((v) => v.userId))

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/viewers?limit=20', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Просмотрели:', data.views.map((v) => v.userId))

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.views array Просмотры страницы
data.views[].id number ID просмотра — курсор lastId следующей страницы
data.views[].messageId number ID сообщения
data.views[].userId number ID пользователя, который просмотрел сообщение
data.views[].dateView string Время просмотра (ISO 8601)
data.users array Профили пользователей из views
data.hasNextPage boolean false — просмотров в выбранном направлении больше нет
meta.requestedLimit number Переданный limit, когда он вышел за диапазон от 1 до 200
meta.appliedLimit number Применённое значение limit — только если он был приведён к границе

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "views": [
      {
        "id": 9001,
        "messageId": 1002,
        "userId": 5,
        "dateView": "2026-09-20T10:05:00+03:00"
      }
    ],
    "users": [
      {
        "id": 5,
        "active": true,
        "name": "Иван Петров",
        "firstName": "Иван",
        "lastName": "Петров",
        "type": "user"
      }
    ],
    "hasNextPage": false
  }
}

Пример ответа при ошибке

422 — сообщения нет на портале:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "MESSAGE_NOT_FOUND",
    "b24Code": "MESSAGE_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, параметр кроме lastId, order, limit, повтор параметра или некорректное значение. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул код NOT_FOUND. Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code. Сюда же приходит отсутствующее сообщение: MESSAGE_NOT_FOUND
403 BITRIX_ACCESS_DENIED У пользователя нет доступа к чату сообщения — Битрикс24 отказал с кодом ACCESS_DENIED
403 WRITE_BLOCKED_READONLY_KEY Ключ READONLY: вызов может добавить пользователя в чат, поэтому отказ происходит до обращения к Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

Известные особенности

Вызов может сделать вас участником. Как и контекст сообщения, он может условно добавить текущего пользователя в чат. Из-за возможного вступления ключи READONLY получают 403 WRITE_BLOCKED_READONLY_KEY до обращения к Битрикс24. Сам вызов не отмечает сообщение прочитанным. Права пользователя в Битрикс24 и скоуп im сохраняются.

Смотрите также