Получить контекст сообщения imbot.v2.Chat.Message.getContext

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.Chat.Message.getContext возвращает сообщение вместе с соседними, до и после него. Так бот может разобрать историю диалога.

Метод доступен только для ботов типа supervisor и personal. Подробнее — Типы ботов.

Параметры метода

Обязательные параметры отмечены *

Название
Тип

Описание

botId*
integer

ID бота, целое число больше 0

botToken
string

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте актуальный токен: указанный при регистрации бота или новый, если токен сменили методом imbot.v2.Bot.update. Со старым токеном метод вернет ошибку BOT_OWNERSHIP_ERROR

messageId*
integer

ID центрального сообщения. Можно взять из message.id события ONIMBOTV2MESSAGEADD

range
integer

Количество сообщений в каждую сторону от центрального (1–50). По умолчанию 50. Значение меньше 1 метод заменяет на 1, больше 50 — на 50

Примеры кода

Как использовать примеры в документации

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","messageId":789,"range":20}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.Message.getContext

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"messageId":789,"range":20,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.Message.getContext

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type MessageContextResult = {
  messages: Array<{
    id: number
    authorId: number
    text: string
  }>
  hasPrevPage: boolean
  hasNextPage: boolean
}

try {
  const response = await $b24.actions.v2.call.make<MessageContextResult>({
    method: 'imbot.v2.Chat.Message.getContext',
    params: {
      botId: 456,
      botToken: 'my_bot_token',
      messageId: 789,
      range: 20,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Messages:', result.messages.length, '| hasPrevPage:', result.hasPrevPage, '| hasNextPage:', result.hasNextPage)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getContext() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imbot.v2.Chat.Message.getContext',
        params: {
          botId: 456,
          botToken: 'my_bot_token',
          messageId: 789,
          range: 20,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Messages:', result.messages.length, '| hasPrevPage:', result.hasPrevPage, '| hasNextPage:', result.hasNextPage)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getContext)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.chat.message.get_context(
        bot_id=456,
        bot_token="my_bot_token",
        message_id=789,
        range=20,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.v2.Chat.Message.getContext',
            [
                'botId' => 456,
                'botToken' => 'my_bot_token',
                'messageId' => 789,
                'range' => 20,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'result: '. print_r($result, true);
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error: '. $exception->getMessage();
}

BX24.callMethod(
    'imbot.v2.Chat.Message.getContext',
    {
        botId: 456,
        botToken: 'my_bot_token',
        messageId: 789,
        range: 20,
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.v2.Chat.Message.getContext',
    [
        'botId' => 456,
        'botToken' => 'my_bot_token',
        'messageId' => 789,
        'range' => 20,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: '. $result['error_description'];
} else {
    foreach ($result['result']['messages'] as $message) {
        echo $message['id']. ': '. $message['text']. "\n";
    }
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Chat.Message.getContext", b24.Params{
	"botId":     456,
	"botToken":  "my_bot_token",
	"messageId": 789,
	"range":     20,
})
if err != nil {
	return fmt.Errorf("imbot.v2.Chat.Message.getContext: %w", err)
}

var item struct {
	HasPrevPage bool `json:"hasPrevPage"`
	HasNextPage bool `json:"hasNextPage"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.HasPrevPage, item.HasNextPage)

Обработка ответа

HTTP-статус: 200

В примере у сообщений и пользователей показаны не все поля. Полный состав — в описании объектов Message и User.

{
    "result": {
        "messages": [
            {
                "id": 785,
                "chatId": 5,
                "authorId": 1,
                "date": "2026-03-19T14:25:00+03:00",
                "text": "Добрый день!",
                "isSystem": false,
                "uuid": null,
                "forward": null,
                "params": [],
                "viewedByOthers": true
            },
            {
                "id": 789,
                "chatId": 5,
                "authorId": 2,
                "date": "2026-03-19T14:30:00+03:00",
                "text": "Привет! Как дела?",
                "isSystem": false,
                "uuid": null,
                "forward": null,
                "params": [],
                "viewedByOthers": true
            }
        ],
        "users": [
            {
                "id": 1,
                "active": true,
                "name": "John Smith",
                "bot": false,
                "type": "user"
            },
            {
                "id": 2,
                "active": true,
                "name": "Anna Davis",
                "bot": false,
                "type": "user"
            }
        ],
        "hasPrevPage": false,
        "hasNextPage": false
    },
    "time": {
        "start": 1773919860.123,
        "finish": 1773919860.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2026-03-19T14:31:00+03:00",
        "date_finish": "2026-03-19T14:31:00+03:00"
    }
}

Возвращаемые данные

Название
Тип

Описание

result
object

Результат запроса

result.messages
Message[]

Массив сообщений от старых к новым, включая центральное. Если история чата для бота скрыта, сообщений, отправленных до его добавления, в массиве нет. Скрыть историю можно при добавлении бота в чат (подробное описание)

result.users
User[]

Авторы сообщений (подробное описание)

result.hasPrevPage
boolean

true, если перед центральным сообщением набралось range сообщений. Более ранних сообщений при этом может не быть

result.hasNextPage
boolean

Есть ли более поздние сообщения

time
time

Информация о времени выполнения запроса

Поля объекта Message

Поле
Тип

Описание

id
integer

Идентификатор сообщения

chatId
integer

Идентификатор чата

authorId
integer

Идентификатор автора сообщения. 0 у системных сообщений

date
string

Дата отправки сообщения

text
string

Текст сообщения

isSystem
boolean

Системное сообщение

uuid
string|null

UUID сообщения, если его передали при отправке, или null

forward
object|null

Данные о пересылке, если сообщение переслано, или null. Состав полей — в описании объекта Message

params
object|array

Дополнительные параметры сообщения: вложения, клавиатура, файлы и другие. Если параметров нет — пустой массив []. Описание ключей — Объект params

viewedByOthers
boolean

Сообщение просмотрено другими участниками

chat_id
integer

То же, что chatId. Поле старого формата

author_id
integer

То же, что authorId. Поле старого формата

block
object|null

Служебное поле, у обычных сообщений null

Поля объекта User

Поле
Тип

Описание

id
integer|null

Идентификатор пользователя. null у системных сообщений

active
boolean

Пользователь активен

name
string

Имя и фамилия пользователя

bot
boolean

Признак пользователя-бота

type
string

Тип пользователя, например user — сотрудник, bot — чат-бот

Полное описание всех полей объектов — на странице Объекты и поля

Пагинация

Чтобы получить более поздние сообщения, вызовите метод снова и передайте в messageId наибольший id из текущей выборки. Для более ранних передайте наименьший id.

В новую выборку снова войдут сообщение из messageId и не больше range уже полученных сообщений с другой стороны от него. Отбрасывайте повторы по id. Если новых сообщений не прибавилось, вы дошли до начала или конца истории.

Обработка ошибок

HTTP-статус: 400

{
    "error": "BOT_TYPE_NOT_ALLOWED",
    "error_description": "Method is available only for supervisor and personal bots"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Значение

BOT_TOKEN_NOT_SPECIFIED

Bot token not specified (botToken is required for webhook auth)

Не указан botToken. Обязателен при авторизации через вебхук

BOT_ID_REQUIRED

botId is required

Не указан botId или он меньше 1

BOT_NOT_FOUND

Bot not found

Бот не найден

BOT_OWNERSHIP_ERROR

Bot was installed by another rest application

Бот зарегистрирован другим приложением или с другим botToken

BOT_TYPE_NOT_ALLOWED

Method is available only for supervisor and personal bots

Метод доступен только для ботов типа supervisor и personal

MESSAGE_NOT_FOUND

MESSAGE_NOT_FOUND

Сообщение не найдено

ACCESS_DENIED

ACCESS_DENIED

Бот не состоит в закрытом чате с этим сообщением. Сообщения открытых чатов бот может читать без участия в них

MESSAGE_ACCESS_DENIED

MESSAGE_ACCESS_DENIED

Бот состоит в чате, но сообщение отправлено до добавления бота, а история чата для бота скрыта

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить сообщение
Следующая
Добавить реакцию на сообщение