# event.offline.get

URL: https://chugunov.pro/api-bitrix24/events/event-offline-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список офлайн-событий с «очисткой»
Кто может выполнять метод: администратор

## Описание

Метод `event.offline.get` возвращает приложению первые в очереди офлайн-события согласно установкам фильтра. Доступность офлайн-событий можно проверить через метод [feature.get](https://chugunov.pro/api-bitrix24/common/system/feature-get/).

Метод работает только в контексте авторизации [приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

## Параметры

- `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](https://chugunov.pro/api-bitrix24/events/event-bind/)
- `error` `integer` — необязательный. Значения: ```0|1``` — возвращать ли ошибочные записи. По умолчанию `0`

## Ответ

HTTP-статус: 200

```json
{
    "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

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

- `403` — `ACCESS_DENIED`. Access denied!

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

### cURL (OAuth)

```curl
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.get(
        filter={
            "=MESSAGE_ID": 1,
            "=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}")
```

### PHP

```php
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.js

```js
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());
    }
);
```

### PHP CRest

```php
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>';
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/events/event-offline-get.html