Загрузка чата

GET /v1/chats/:dialogId/load

Открывает чат одним запросом: карточка чата, первая страница сообщений, закреплённые сообщения, участники и файлы. Первая страница строится вокруг последнего прочитанного сообщения, а если чат помечен непрочитанным — вокруг метки.

Параметры

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

Облегчённая загрузка. shallow=true открывает чат: в data приходят карточка чата, его участники и контекст чата — recentConfig, parentChat, copilot, messagesAutoDeleteConfigs, callInfo, — но нет страницы сообщений, закреплённых сообщений, файлов и флагов hasPrevPage / hasNextPage. Это вызов для шапки чата или экрана настроек. Облегчённая загрузка тоже может сделать вас участником. Для обычного личного ключа сотрудника это разрешённое именованное чтение существующего чата. shallow=false — полная загрузка. Запрос без shallow получает тот же ответ полной загрузки и те же отказы.

Ключ только чтения. В режиме READONLY этот запрос читает существующий чат: передайте его chatN либо числовой ID собеседника, подтверждённый в последних диалогах того же сотрудника. Для me проверяется уже существующий личный диалог. Проверка просматривает не больше 4000 исходных строк последних диалогов. Если привязка не подтверждена, ответ — 403 WRITE_BLOCKED_READONLY_KEY, без обращения к методу, который мог бы создать чат. Границы проверки и разрешённых эффектов чтения — в правах доступа.

Исключение для этих именованных чтений действует только для обычного личного ключа сотрудника — как с вебхуком, так и с ранее настроенными OAuth-токенами. Ключ приложения с пользовательской Bearer-сессией, менеджмент-ключ и ключ с неподтверждённым видом владельца в режиме READONLY получают 403 WRITE_BLOCKED_READONLY_KEY до проверки привязки существующего чата и вызова именованного метода мессенджера. Обычные чтения без этих эффектов остаются доступны ключам приложений. Режим с записью не меняется.

Примеры

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

curl "https://vibecode.bitrix24.tech/v1/chats/chat42/load?messageLimit=30" \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl "https://vibecode.bitrix24.tech/v1/chats/chat42/load?messageLimit=30" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/load?messageLimit=30', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Чат:', data.chat.name)
console.log('Сообщения:', data.messages.length, 'ещё раньше:', data.hasPrevPage)

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/load?messageLimit=30', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Чат:', data.chat.name)
console.log('Сообщения:', data.messages.length, 'ещё раньше:', data.hasPrevPage)

curl — облегчённая загрузка

curl "https://vibecode.bitrix24.tech/v1/chats/chat42/load?shallow=true" \
  -H "X-Api-Key: YOUR_API_KEY"

Поля ответа

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

{
  "success": true,
  "data": {
    "chat": {
      "id": 42,
      "dialogId": "chat42",
      "name": "Проект",
      "type": "chat",
      "owner": 5,
      "role": "member"
    },
    "messages": [
      {
        "id": 1002,
        "chatId": 42,
        "authorId": 7,
        "date": "2026-09-20T10:01:00+03:00",
        "text": "Всё готово",
        "params": {}
      }
    ],
    "pins": [],
    "users": [],
    "files": [],
    "reactions": [],
    "hasPrevPage": true,
    "hasNextPage": false
  }
}

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

422 — чата нет на портале:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Указанный чат не существует",
    "hint": "dialogId must be a userId (number as string) for DMs or \"chat{N}\" for group chats. Examples: \"1\" for user 1, \"chat123\" for group chat 123. Create a group chat first via POST /v1/bots/:botId/chats if needed.",
    "b24Code": "CHAT_NOT_FOUND"
  }
}

Ошибки

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

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

Открытие чата может сделать вас участником. Если чат разрешает автовступление — например, чаты комментариев, коллабы, чаты задач, — вызов добавляет текущего пользователя в участники, как открытие чата в интерфейсе Битрикс24. Это поведение портала, эндпоинт его не скрывает. Ключу READONLY эта операция чтения разрешена как точечное исключение. Права пользователя и скоуп im всё ещё проверяются. Открытие само не отмечает сообщения прочитанными. Другие эффекты загрузки чата — обновление присутствия, быстрый доступ к файлам после проверки прав, подписка на обновления чата и фоновое событие внешнего чата — перечислены в правах доступа. Для коллаба или рабочей группы это фоновое событие может запустить отложенное преобразование проекта. То же исключение для автовступления относится к ленте в режиме v2 и к сообщениям вокруг сообщения.

Ключи ответа. Ключи-имена полей приводятся к camelCase: параметр сообщения FILE_ID приходит как fileId. Ключи-данные остаются как есть: ключи словаря data.copilot.roles — коды ролей, и copilot_assistant приходит как copilot_assistant — тем же значением, что role у чата и сообщения в data.copilot, поэтому роль находится прямым обращением roles[role]. Поля внутри роли приводятся к camelCase.

Дальше — лента. Более старые сообщения читайте лентой в режиме v2 с lastId, равным наименьшему id страницы.

Облегчённая загрузка — без сообщений. После shallow=true страницу сообщений дочитывайте лентой в режиме v2, а чтобы открыть чат на конкретном сообщении, используйте загрузку вокруг сообщения.

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

• Чтение сообщений
• Сообщения вокруг сообщения
• Загрузка вокруг сообщения
• Счётчики непрочитанного