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

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

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

Scope: базовый

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

Метод event.offline.list читает очередь офлайн-событий приложения, которое его вызвало. В отличие от event.offline.get, он не резервирует записи и не выдает process_id. Чтобы подтвердить или пометить записи ошибочными, получите их методом event.offline.get с clear=0.

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

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

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

Название
тип

Описание

filter
object

Фильтр записей. Без фильтра метод возвращает все записи. Фильтровать можно по полям: ID, TIMESTAMP_X, EVENT_NAME, MESSAGE_ID, PROCESS_ID, ERROR.

TIMESTAMP_X передается в формате ISO 8601, ERROR — 0 или 1.

Перед именем поля ставится операция: =, >, <, >=, <=, @ — значение входит в массив, % — подстрока. Без операции работает точное совпадение. Пример: {">ID": 100, "=EVENT_NAME": "ONCRMLEADADD"}. Отрицание ! не поддерживается: метод вернет ошибку ERROR_ARGUMENT

order
object

Сортировка записей по тем же полям, что и в фильтре, в виде {"поле": "ASC"} или {"поле": "DESC"}. По умолчанию — {"ID": "ASC"}

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

auth_connector
string

Ключ источника. Очередь офлайн-событий разделена по источникам. Передайте то же значение auth_connector, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом rest_auth_connector, иначе метод вернет ошибку WRONG_LICENSE

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "filter": {
        "ERROR": 0
    },
    "order": {
        "ID": "DESC"
    },
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.offline.list
// 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 each OfflineEventItem returned in result[]
type OfflineEventItem = {
  ID: string
  TIMESTAMP_X: ISODate
  EVENT_NAME: string
  EVENT_DATA: unknown
  EVENT_ADDITIONAL: unknown
  MESSAGE_ID: string
  PROCESS_ID: string
  ERROR: string
}

try {
  // event.offline.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers ignore `order` (they always sort by ID ASC and log a warning)
  // — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<OfflineEventItem[]>({
    method: 'event.offline.list',
    params: {
      filter: {
        ERROR: 0,
      },
      order: {
        ID: 'DESC',
      },
      start: 0,
    },
    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.length, result)
  }
} 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 fetchOfflineEvents() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // event.offline.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers ignore `order` (they always sort by ID ASC and log a warning)
      // — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'event.offline.list',
        params: {
          filter: {
            ERROR: 0,
          },
          order: {
            ID: 'DESC',
          },
          start: 0,
        },
        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.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchOfflineEvents)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.list(
        filter={
            "ERROR": 0,
        },
        order={
            "ID": "DESC",
        },
        start=0,
    ).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}")

Пример as_list

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.list(
        filter={
            "ERROR": 0,
        },
        order={
            "ID": "DESC",
        },
    ).as_list().response
    result = bitrix_response.result
    for item in result:
        print(item)
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}")

Пример as_list_fast

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.list(
        filter={
            "ERROR": 0,
        },
    ).as_list_fast(descending=True).response
    result = bitrix_response.result
    for item in result:
        print(item)
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.list',
            [
                'filter' => [
                    'ERROR' => 0,
                ],
                'order' => [
                    'ID' => 'DESC',
                ],
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    "event.offline.list",
    {
        "filter": {
            "ERROR": 0
        },
        "order": {
            "ID": "DESC"
        }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'event.offline.list',
    [
        'filter' => [
            'ERROR' => 0
        ],
        'order' => [
            'ID' => 'DESC'
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "event.offline.list", b24.Params{
	"filter": b24.Params{
		"ERROR": 0,
	},
	"order": b24.Params{
		"ID": "DESC",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("event.offline.list: %w", err)
}

var items []struct {
	ID              b24.ID          `json:"ID"`
	TimestampX      string          `json:"TIMESTAMP_X"`
	EventName       string          `json:"EVENT_NAME"`
	EventData       json.RawMessage `json:"EVENT_DATA"`
	EventAdditional json.RawMessage `json:"EVENT_ADDITIONAL"`
	MessageID       string          `json:"MESSAGE_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.TimestampX)
}

// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
	fmt.Println("всего:", *res.Total)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "2",
            "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
            "EVENT_NAME": "ONCRMCOMPANYADD",
            "EVENT_DATA": {
                "FIELDS": {
                    "ID": "45"
                }
            },
            "EVENT_ADDITIONAL": {
                "user_id": "1"
            },
            "MESSAGE_ID": "4f2a9c1e7b3d5a6f8e0c2b4d6a8f1e3c",
            "PROCESS_ID": "",
            "ERROR": "0"
        },
        {
            "ID": "1",
            "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
            "EVENT_NAME": "ONCRMLEADADD",
            "EVENT_DATA": {
                "FIELDS": {
                    "ID": "123"
                }
            },
            "EVENT_ADDITIONAL": {
                "user_id": 0
            },
            "MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
            "PROCESS_ID": "",
            "ERROR": "0"
        }
    ],
    "total": 2,
    "time": {
        "start": 1721299537.90267,
        "finish": 1721299538.02201,
        "duration": 0.11934018135070801,
        "processing": 0.0029511451721191406,
        "date_start": "2024-07-18T12:45:37+02:00",
        "date_finish": "2024-07-18T12:45:38+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
array

Записи очереди (подробное описание). Если подходящих записей нет, возвращается пустой массив

total
integer

Общее количество найденных записей

next
integer

Значение start для следующей страницы. Возвращается, если найдено больше записей, чем помещается на текущей странице

time
time

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

Элемент списка

Название
тип

Описание

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

PROCESS_ID
string

Идентификатор пакета, которым запись зарезервирована методом event.offline.get с clear=0. Пустая строка, если запись не зарезервирована

ERROR
string

1 — запись помечена ошибочной методом event.offline.error, 0 — нет

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

HTTP-статус: 403

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

ERROR_ARGUMENT

Filter field not allowed: …

В filter передано поле не из списка

400

ERROR_ARGUMENT

Filter operation not allowed: …

В 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, а тариф не поддерживает ключи источников

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

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

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

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