Получить события пользователя im.v2.Event.get

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

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

Scope: im

Кто может выполнять метод: авторизованный пользователь

Метод im.v2.Event.get получает события для текущего пользователя в режиме опроса.

Для получения событий пользователь должен быть предварительно подписан через im.v2.Event.subscribe. Без подписки события не записываются и метод вернет пустой массив.

Метод использует подтверждение через offset: передайте nextOffset из предыдущего ответа, чтобы получить следующую порцию событий.

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

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

Название
Тип

Описание

offset
integer

Подтверждает обработанные события и возвращает события, начиная с этого значения. Передайте nextOffset из предыдущего ответа

limit
integer

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

Примеры кода

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

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

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

try {
  const response = await $b24.callMethod('im.v2.Event.get', {
    offset: 2000,
    limit: 50,
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.v2.event.get(
        offset=2000,
        limit=50,
    ).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(
            'im.v2.Event.get',
            [
                'offset' => 2000,
                '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(
    'im.v2.Event.get',
    {
        offset: 2000,
        limit: 50,
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'im.v2.Event.get',
    [
        'offset' => 2000,
        'limit' => 50,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    foreach ($result['result']['events'] as $event) {
        echo $event['type'] . ': ' . $event['eventId'] . "\n";
    }
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.v2.Event.get", b24.Params{
	"offset": 2000,
	"limit":  50,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.v2.Event.get: %w", err)
}

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

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

HTTP-статус: 200

{
    "result": {
        "events": [
            {
                "eventId": 2001,
                "type": "ONIMV2MESSAGEADD",
                "date": "2025-01-15T10:30:00+03:00",
                "data": {}
            }
        ],
        "nextOffset": 2002,
        "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

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

Типы событий

Тип

Описание

ONIMV2MESSAGEADD

Новое сообщение в чате

ONIMV2MESSAGEUPDATE

Сообщение отредактировано

ONIMV2MESSAGEDELETE

Сообщение удалено

ONIMV2REACTIONCHANGE

Реакция на сообщение изменена

ONIMV2JOINCHAT

Новый участник в чате

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

Эксклюзивность получения событий

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

Это ограничение намеренное: предполагается, что один агент должен мгновенно реагировать на события. Несколько агентов, обрабатывающих одни и те же события одного пользователя, приводят к дублирующимся и противоречивым ответам.

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

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

Метод не генерирует специфических ошибок. Если пользователь не подписан через im.v2.Event.subscribe, метод вернет пустой массив events.

Название
тип

Описание

error
string

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

error_description
string

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

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

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

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

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

Предыдущая
Отписаться от событий
Следующая
Форматы событий