Получить список офлайн-событий event.offline.list
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Кто может выполнять метод: любой пользователь
Метод event.offline.list для чтения текущей очереди без внесения изменений в ее состояние в отличие от event.offline.get. Доступность офлайн-событий можно проверить через метод feature.get.
Метод работает только в контексте авторизации приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Фильтр записей. По умолчанию отдаются все записи, без фильтрации. Поддерживается фильтрация по полям: |
|
order |
Сортировка записей. Поддерживается сортировка по тем же полям, что и в фильтре, на вход принимается массив вида |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'event.offline.list',
{
"filter": {
"ERROR": 0
},
"order": {
"ID": "DESC"
}
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('event.offline.list', { "filter": { "ERROR": 0 }, "order": { "ID": "DESC" } }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('event.offline.list', { "filter": { "ERROR": 0 }, "order": { "ID": "DESC" } }, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'event.offline.list',
[
'filter' => [
'ERROR' => 0,
],
'order' => [
'ID' => 'DESC',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching offline events: ' . $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>';
Обработка ответа
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 |
Корневой элемент ответа |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список доступных событий events
- Зарегистрировать новый обработчик события event.bind
- Получить список зарегистрированных обработчиков событий event.get
- Отменить зарегистрированный обработчик события event.unbind
- Безопасность в обработчиках
- Особенности, преимущества и недостатки офлайн-событий
- Получить список офлайн-событий с «очисткой» event.offline.get
- Очистить записи в очереди офлайн-событий event.offline.clear
- Зарегистрировать ошибки обработки очереди офлайн-событий event.offline.error
- Событие изменения очереди onOfflineEvent