метод REST

event.offline.get

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

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

Описание

Метод 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`

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

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

Ответ

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!"
}
Код Описание Значение
403 ACCESS_DENIED Access denied!

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

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