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
// 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 do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — 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 do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — 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}")
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.offline.list(
filter={
"ERROR": 0,
},
order={
"ID": "DESC",
},
).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();
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>';
// 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 bool `json:"EVENT_DATA"`
EventAdditional bool `json:"EVENT_ADDITIONAL"`
MessageID b24.ID `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": 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! |

