Получить события бота imbot.v2.Event.get

Scope: imbot

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

Метод imbot.v2.Event.get получает события для бота в агентском режиме опроса. Используется для ботов с eventMode: "fetch".

Метод подтверждает получение событий с ID меньше переданного offset. При следующем вызове возвращаются только новые события, начиная с подтвержденного.

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

Когда использовать `imbot.v2.Event.get`

Метод подходит, если:

у бота нет публичного URL для входящих HTTP-запросов
события должен забирать один фоновый агент (worker) по расписанию
нужен явный контроль очереди событий через offset и nextOffset
нужно в одном потоке получать бот-события ONIMBOTV2* и пользовательские ONIMV2* через withUserEvents

Альтернатива: webhook-режим

Вместо polling можно использовать webhook-режим:

в imbot.v2.Bot.register укажите fields.eventMode = webhook
задайте fields.webhookUrl для получения входящих событий
пример webhook-обработчика

Пошаговый запуск обоих вариантов: Быстрый старт.

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

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

Название `Тип`	Описание
botId* `integer`	ID бота
botToken `string`	Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота
offset `integer`	Подтверждает все события с ID меньше указанного значения. При первом вызове не передается
limit `integer`	Максимальное количество возвращаемых событий (1–1000). По умолчанию `100`
withUserEvents `boolean`	Включить пользовательские события (`ONIMV2*`) в ответ вместе с бот-событиями. По умолчанию `false`. Подробнее — ниже

Получение событий бота и пользователя

При withUserEvents: true метод возвращает в одном ответе как бот-события ONIMBOTV2*, так и пользовательские события ONIMV2*.

Требования:

приложение должно иметь скоуп im в дополнение к imbot
текущий пользователь должен быть подписан через im.v2.Event.subscribe
userId определяется из авторизации — указать чужой невозможно

Один offset подтверждает и бот-события, и пользовательские события одновременно.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","offset":1000,"limit":50,"withUserEvents":true}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Event.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"offset":1000,"limit":50,"withUserEvents":true,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Event.get

try {
          const response = await $b24.callMethod('imbot.v2.Event.get', {
            botId: 456,
            offset: 1000,
            limit: 50,
            withUserEvents: true,
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Event.get',
                    [
                        'botId' => 456,
                        'offset' => 1000,
                        'limit' => 50,
                        'withUserEvents' => true,
                    ]
                );
        
            $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.Event.get',
            {
                botId: 456,
                offset: 1000,
                limit: 50,
                withUserEvents: true,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Event.get',
            [
                'botId' => 456,
                'offset' => 1000,
                'limit' => 50,
                'withUserEvents' => true,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            foreach ($result['result']['events'] as $event) {
                echo $event['type'] . ': ' . $event['eventId'] . "\n";
            }
        }

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","offset":1000,"limit":50}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Event.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"offset":1000,"limit":50,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Event.get

try {
          const response = await $b24.callMethod('imbot.v2.Event.get', {
            botId: 456,
            offset: 1000,
            limit: 50,
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Event.get',
                    [
                        'botId' => 456,
                        'offset' => 1000,
                        'limit' => 50,
                    ]
                );
        
            $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.Event.get',
            {
                botId: 456,
                offset: 1000,
                limit: 50,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Event.get',
            [
                'botId' => 456,
                'offset' => 1000,
                'limit' => 50,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            foreach ($result['result']['events'] as $event) {
                echo $event['type'] . ': ' . $event['eventId'] . "\n";
            }
        }

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

HTTP-код: 200

{
            "result": {
                "events": [
                    {
                        "eventId": 1001,
                        "type": "ONIMBOTV2MESSAGEADD",
                        "date": "2025-01-15T10:30:00+03:00",
                        "data": {}
                    }
                ],
                "nextOffset": 1002,
                "hasMore": false
            },
            "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.events `object[]`	Массив событий
result.events[].eventId `integer`	ID события. Передайте в следующем вызове как `offset` для подтверждения
result.events[].type `string`	Тип события. Список типов описан ниже
result.events[].date `datetime`	Дата и время события
result.events[].data `object`	Данные события. Формат зависит от типа события: описание событий
result.nextOffset `integer`	Значение для следующего вызова `offset`. Подтверждает уже обработанные события и сдвигает курсор очереди
result.hasMore `boolean`	`true`, если есть еще необработанные события
time `time`	Информация о времени выполнения запроса

Типы событий

Тип	Описание
`ONIMBOTV2MESSAGEADD`	Новое сообщение боту
`ONIMBOTV2MESSAGEUPDATE`	Сообщение отредактировано
`ONIMBOTV2MESSAGEDELETE`	Сообщение удалено
`ONIMBOTV2JOINCHAT`	Бота добавили в чат
`ONIMBOTV2DELETE`	Бота удалили
`ONIMBOTV2CONTEXTGET`	Передача контекста вызова чата
`ONIMBOTV2COMMANDADD`	Вызвана слэш-команда
`ONIMBOTV2REACTIONCHANGE`	Реакция изменена

События адресованы конкретному боту — по упоминанию @bot или в личном чате. Для ботов типа personal и supervisor доставляются все события в чатах, где бот состоит.

Подробное описание формата данных каждого события: Форматы событий imbot.v2.

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

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

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot not found"
        }

Название `тип`	Описание
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	Бот зарегистрирован другим приложением
`SCOPE_ERROR`	Scope error	Не хватает скоупа `im` — требуется при использовании `withUserEvents: true`
`AUTH_ERROR`	Auth error	Не удалось определить текущего пользователя
`USER_NOT_SUBSCRIBED`	User not subscribed	Пользователь не подписан на события через im.v2.Event.subscribe

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

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

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

Обзор методов

Форматы событий

Получить события бота imbot.v2.Event.get

Когда использовать Когда использовать imbot.v2.Event.get

Альтернатива: webhook-режимАльтернатива: webhook-режим

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

Получение событий бота и пользователяПолучение событий бота и пользователя

Примеры кодаПримеры кода

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

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

Типы событийТипы событий

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

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

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

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