метод REST scope: imbot

imbot.v2.Event.get

Получить события бота

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

Описание

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

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

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

Параметры

botId integer обязательный

ID бота

botToken string необязательный

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

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

offset integer необязательный

Подтверждает все события с ID меньше указанного значения. При первом вызове не передается

limit integer необязательный

Максимальное количество возвращаемых событий (1–1000). По умолчанию 100

withUserEvents boolean необязательный

Включить пользовательские события (ONIMV2*) в ответ вместе с бот-событиями. По умолчанию false. Подробнее — ниже

Примеры запроса

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

Ответ

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"
    }
}

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

HTTP-статус: 400

{
    "error": "BOT_NOT_FOUND",
    "error_description": "Bot not found"
}
Код Описание Значение
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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.