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

Scope: imbot

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

Метод imbot.v2.Chat.Message.getContext возвращает окно сообщений вокруг указанного. Используется для анализа истории диалога.

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

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

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

Название
Тип

Описание

botId*
integer

ID бота

botToken
string

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

Передавайте тот же botToken, который был указан при регистрации чат-бота

messageId*
integer

ID центрального сообщения

range
integer

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

Примеры кода

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

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
        
try {
          const response = await $b24.callMethod('imbot.v2.Chat.Message.getContext', {
            botId: 456,
            messageId: 789,
            range: 20,
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Chat.Message.getContext',
                    [
                        'botId' => 456,
                        '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,
                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,
                '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";
            }
        }

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

HTTP-код: 200

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

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

Название
Тип

Описание

result
object

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

result.messages
Message[]

Массив сообщений от старых к новым (подробное описание)

result.users
User[]

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

result.hasPrevPage
boolean

Есть ли более ранние сообщения

result.hasNextPage
boolean

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

time
time

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

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

Поле
Тип

Описание

id
integer

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

chatId
integer

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

authorId
integer

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

date
string

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

text
string

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

isSystem
boolean

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

uuid
string

Внешний идентификатор сообщения

forward
object

Данные о пересланном сообщении

params
object

Дополнительные параметры сообщения

viewedByOthers
boolean

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

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

Поле
Тип

Описание

id
integer

Идентификатор пользователя

active
boolean

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

name
string

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

bot
boolean

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

type
string

Тип пользователя

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

Пагинация

Для загрузки следующей страницы вызовите метод повторно, передав в messageId ID последнего сообщения из текущей выборки. Для предыдущей — ID первого сообщения.

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

HTTP-статус: 400, 403

{
            "error": "BOT_TYPE_NOT_ALLOWED",
            "error_description": "Bot type not allowed"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

BOT_TOKEN_NOT_SPECIFIED

Bot token is not specified

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

BOT_ID_REQUIRED

Bot ID is required

Не указан botId

BOT_NOT_FOUND

Bot not found

Бот не найден

BOT_OWNERSHIP_ERROR

Bot is registered by another application

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

BOT_TYPE_NOT_ALLOWED

Bot type not allowed

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

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

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