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

Получить сообщение

GET /v1/bots/:botId/messages/:messageId

Возвращает сообщение по его ID.

Ограничение по типу бота. Метод доступен только для ботов с type ∈ {personal, supervisor}. Для остальных типов — bot и openline — ответ 422 с кодом BITRIX_ERROR, машиночитаемый код причины приходит в поле error.b24Code со значением BOT_TYPE_NOT_ALLOWED. Тип задаётся при регистрации через POST /v1/bots и не меняется без перерегистрации.

Параметры

Параметр Тип Обяз. Описание
botId (path) number да ID бота
messageId (path) number да ID сообщения

Примеры

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

Terminal
curl https://vibecode.bitrix24.tech/v1/bots/42/messages/1501 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl https://vibecode.bitrix24.tech/v1/bots/42/messages/1501 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1501', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Сообщение:', data.text)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1501', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
id number ID сообщения
chatId number ID чата
authorId number ID автора
date string Дата отправки (ISO 8601)
text string Текст сообщения
isSystem boolean Системное сообщение
params object Дополнительные параметры сообщения

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

JSON
{
  "success": true,
  "data": {
    "id": 1501,
    "chatId": 123,
    "authorId": 1,
    "date": "2026-03-31T10:00:00+03:00",
    "text": "Привет, бот!",
    "isSystem": false,
    "params": {}
  }
}

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

422 — тип бота не personal и не supervisor:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Bot type not allowed",
    "b24Code": "BOT_TYPE_NOT_ALLOWED"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
422 BITRIX_ERROR (error.b24Code: BOT_TYPE_NOT_ALLOWED) Тип бота не personal и не supervisor
422 BITRIX_ERROR Другая ошибка Битрикс24, текст в message
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Типичный сценарий: бот получил событие с replyId и хочет прочитать исходное сообщение, на которое ответил пользователь.

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