Получить список офлайн-событий с «очисткой» event.offline.get

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

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

Scope: базовый

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

Метод event.offline.get возвращает приложению первые записи из очереди офлайн-событий, подходящие под фильтр. У метода два режима:

clear=1, по умолчанию — выдает записи и сразу удаляет их из очереди
clear=0 — резервирует записи пакетом и возвращает его process_id. Обработку пакета подтверждают методом event.offline.clear, ошибки отмечают методом event.offline.error

Режим с резервированием пакетов доступен не на всех тарифах. Проверьте его методом feature.get с кодом rest_offline_extended.

Метод работает только в контексте авторизации приложения. Права на методы событий описаны в разделе Права доступа.

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

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

Название `тип`	Описание
filter `object`	Фильтр записей. По умолчанию метод возвращает все записи. Фильтровать можно по полям: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`. Перед именем поля укажите операцию: `=`, `>`, `<`, `>=`, `<=`. Без операции работает точное совпадение. Отрицание `!` не поддерживается, такой фильтр вернет ошибку `ERROR_ARGUMENT`. Пример: `{">ID": 100, "=EVENT_NAME": "ONCRMLEADADD"}`. Значение — строка или число, массив не поддерживается. `TIMESTAMP_X` передайте в формате ISO 8601, например `2024-07-18T12:32:31+02:00`
order `object`	Сортировка записей по тем же полям, что и в фильтре, в виде `{"поле": "ASC"}` или `{"поле": "DESC"}`. По умолчанию — `{"TIMESTAMP_X": "ASC"}`
limit `integer`	Количество выбираемых записей, целое число больше `0`. По умолчанию 50
clear `integer`	Удалять ли выбранные записи: `1` — удалить сразу, `0` — зарезервировать пакетом. По умолчанию `1`. Значение `0` без режима `rest_offline_extended` вернет ошибку `WRONG_LICENSE`
process_id `string`	Идентификатор ранее зарезервированного пакета. Передайте его, чтобы повторно получить записи пакета, которые еще не подтверждены. С `clear=1` метод удалит весь пакет, включая записи, которые не вошли в ответ из-за `limit`. Чтобы оставить записи, передайте `clear=0`
auth_connector `string`	Ключ источника. Передайте то же значение `auth_connector`, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE`
error `integer`	`1` — вернуть только записи, помеченные ошибочными методом event.offline.error, `0` — только записи без такой пометки. По умолчанию `0`

Примечание

Метод можно вызывать параллельно: каждый запрос получит свой набор записей, который не пересекается с другими. Учитывайте ограничения на частоту запросов.

Примеры кода

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

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=MESSAGE_ID":"b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3","=EVENT_NAME":"ONCRMLEADADD",">=ID":1},"auth_connector":"BxTest","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/event.offline.get

// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type OfflineGetResult = {
  process_id: string | null,
  events: {
    ID: string,
    TIMESTAMP_X: ISODate,
    EVENT_NAME: string,
    EVENT_DATA: unknown,
    EVENT_ADDITIONAL: unknown,
    MESSAGE_ID: string,
  }[],
}

try {
  const response = await $b24.actions.v2.call.make<OfflineGetResult>({
    method: 'event.offline.get',
    params: {
      filter: {
        '=MESSAGE_ID': 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
        '=EVENT_NAME': 'ONCRMLEADADD',
        '>=ID': 1,
      },
      auth_connector: 'BxTest',
    },
    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('Offline events:', result.events, 'Process ID:', result.process_id)
  }
} 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 getOfflineEvents() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'event.offline.get',
        params: {
          filter: {
            '=MESSAGE_ID': 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
            '=EVENT_NAME': 'ONCRMLEADADD',
            '>=ID': 1,
          },
          auth_connector: 'BxTest',
        },
        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('Offline events:', result.events, 'Process ID:', result.process_id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.get(
        filter={
            "=MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
            "=EVENT_NAME": "ONCRMLEADADD",
            ">=ID": 1,
        },
        auth_connector="BxTest",
    ).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(
            'event.offline.get',
            [
                'filter' => [
                    '=MESSAGE_ID' => 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
                    '=EVENT_NAME' => 'ONCRMLEADADD',
                    '>=ID' => 1
                ],
                'auth_connector' => 'BxTest'
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

BX24.callMethod(
    "event.offline.get",
    {
        "filter": {
            "=MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
            "=EVENT_NAME": "ONCRMLEADADD",
            ">=ID": 1
        },
        "auth_connector": "BxTest"
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'event.offline.get',
    [
        'filter' => [
            '=MESSAGE_ID' => 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
            '=EVENT_NAME' => 'ONCRMLEADADD',
            '>=ID' => 1
        ],
        'auth_connector' => 'BxTest'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

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

HTTP-статус: 200

{
    "result": {
        "process_id": null,
        "events": [
            {
                "ID": "1",
                "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
                "EVENT_NAME": "ONCRMLEADADD",
                "EVENT_DATA": {
                    "FIELDS": {
                        "ID": "123"
                    }
                },
                "EVENT_ADDITIONAL": {
                    "user_id": "1"
                },
                "MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3"
            }
        ]
    },
    "time": {
        "start": 1721299720.388504,
        "finish": 1721299720.509809,
        "duration": 0.12130498886108398,
        "processing": 0.008239030838012695,
        "date_start": "2024-07-18T12:48:40+02:00",
        "date_finish": "2024-07-18T12:48:40+02:00",
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Идентификатор пакета и выбранные записи очереди (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
process_id `string`	Идентификатор пакета. Заполнен, если метод вызван с `clear=0` или с параметром `process_id`, иначе равен `null`. Передайте его в event.offline.clear или event.offline.error
events `array`	Записи очереди (подробное описание). Если подходящих записей нет, возвращается пустой массив

Элемент массива events

Название `тип`	Описание
ID `string`	Идентификатор записи в очереди
TIMESTAMP_X `datetime`	Время записи события в очередь или его последнего повтора
EVENT_NAME `string`	Код события, например `ONCRMLEADADD`
EVENT_DATA `object` или `boolean`	Данные события — те же, что приходят в обработчик онлайн-события, например `FIELDS.ID`. Если у события нет данных, поле пустое: `false` или `null`
EVENT_ADDITIONAL `object`	Данные авторизации события. Поле `user_id` содержит идентификатор пользователя, который выполнил действие. Если действие выполнено без пользователя, например агентом, `user_id` равен `0`
MESSAGE_ID `string`	Ключ записи. Повторное событие с теми же данными обновляет незарезервированную запись, а не добавляет новую. Если запись уже зарезервирована пакетом, повтор создаст новую запись. Передайте значение в параметр `message_id` методов event.offline.clear и event.offline.error

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

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}

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

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

Статус	Код	Описание	Значение
`400`	`ERROR_ARGUMENT`	Value must be positive integer	Параметр `limit` меньше `1`
`400`	`ERROR_ARGUMENT`	Filter field not allowed: …	В `filter` передано поле не из списка
`400`	`ERROR_ARGUMENT`	Filter operation not allowed: …	В `filter` передана неподдерживаемая операция, например `!`
`400`	`ERROR_ARGUMENT`	The value of an argument '…' has an invalid type	В `filter` передан массив вместо строки или числа
`400`	`ERROR_ARGUMENT`	The filter is not an array.	Параметр `filter` передан не объектом
`400`	`ERROR_ARGUMENT`	The order is not an array.	Параметр `order` передан не объектом
`400`	`ERROR_ARGUMENT`	Order field not allowed: …	В `order` передано поле не из списка
`400`	`ERROR_ARGUMENT`	`Order direction should be one of {ASC\|DESC}`	В `order` передано направление не `ASC` и не `DESC`
`403`	`ACCESS_DENIED`	Access denied!	Метод вызвал не администратор
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Метод вызван не в контексте приложения, например через вебхук
`403`	`WRONG_LICENSE`	This feature is not enabled for the current license: auth_connector	Передан `auth_connector`, а тариф не поддерживает ключи источников
`403`	`WRONG_LICENSE`	This feature is not enabled for the current license: extended offline events handling	Метод вызван с `clear=0`, а режим `rest_offline_extended` недоступен

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

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

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

Была ли статья полезна?

Получить список офлайн-событий

Очистить очереди офлайн-событий

Получить список офлайн-событий с «очисткой» event.offline.get

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

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

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

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

Объект resultОбъект result

Элемент массива eventsЭлемент массива events

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

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

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

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