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

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

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

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

Метод event.offline.get возвращает приложению первые в очереди офлайн-события согласно установкам фильтра. Доступность офлайн-событий можно проверить через метод feature.get.

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

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

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

Название
тип

Описание

filter
array

Фильтр записей. По умолчанию отдаются все записи, без фильтрации. Поддерживается фильтрация по полям: ID, TIMESTAMP_X, EVENT_NAME, MESSAGE_ID со стандартными операциями типа =, >, <, <= и так далее.

Важно: тип операции ставится перед именем поля фильтрации

order
array

Сортировка записей. Поддерживается сортировка по тем же полям, что и в фильтре, на вход принимается массив вида [поле=>ASC|DESC]. По умолчанию — [TIMESTAMP_X:ASC]

limit
integer

Количество выбираемых записей. По умолчанию 50

Дополнительные параметры

Название
тип

Описание

clear
integer

Значения: 0|1 — удалять ли выбранные записи. По умолчанию 1

process_id
string

Идентификатор процесса. Используется, если понадобится повторно выбрать еще необработанные текущим процессом записи

auth_connector
string

Ключ источника. Используется, если значение auth_connector было указано в методе event.bind

error
integer

Значения: 0|1 — возвращать ли ошибочные записи. По умолчанию 0

Примечание

Метод поддерживает многопоточный разбор. То есть допускается несколько параллельных запросов к /rest/event.offline.get (с соблюдением ограничений на количество запросов в единицу времени), и каждый из них получит разные наборы записей.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=MESSAGE_ID":1,"=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': 1,
        '=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': 1,
            '=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>
try {
    $response = $b24Service
        ->core
        ->call(
            'event.offline.get',
            [
                'filter' => [
                    '=MESSAGE_ID' => 1,
                    '=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": 1,
            "=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' => 1,
            '=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": false,
                "EVENT_ADDITIONAL": false,
                "MESSAGE_ID": "1"
            }
        ]
    },
    "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

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

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

HTTP-статус: 403

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

ACCESS_DENIED

Access denied!

Метод запустил не администратор

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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