метод REST

event.offline.list

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

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

Описание

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

Метод не помечает события обработанными и не формирует process_id. В записях поле PROCESS_ID пустое, пока события не зарезервированы вызовом event.offline.get с параметром clear=0.

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

Параметры

filter array необязательный

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

order array необязательный

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

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

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

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

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

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

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

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

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

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

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

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "2",
            "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
            "EVENT_NAME": "ONCRMCOMPANYADD",
            "EVENT_DATA": false,
            "EVENT_ADDITIONAL": false,
            "MESSAGE_ID": "2",
            "PROCESS_ID": "",
            "ERROR": "0"
        },
        {
            "ID": "1",
            "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
            "EVENT_NAME": "ONCRMLEADADD",
            "EVENT_DATA": false,
            "EVENT_ADDITIONAL": false,
            "MESSAGE_ID": "1",
            "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 object

Корневой элемент ответа

total integer

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

time time

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

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

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}
Код Описание Значение
403 ACCESS_DENIED Access denied!

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

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