Зарегистрировать ошибки обработки очереди офлайн-событий event.offline.error
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
базовыйКто может выполнять метод: администратор
Метод event.offline.error помечает записи зарезервированного пакета офлайн-событий как ошибочные. Такие записи снимаются с резерва и больше не попадают в обычную выдачу event.offline.get. Получить их можно методом event.offline.get с параметром error=1.
Режим с резервированием пакетов доступен не на всех тарифах. Проверьте его методом feature.get с кодом rest_offline_extended.
Метод работает только в контексте авторизации приложения. Права на методы событий описаны в разделе Права доступа.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
process_id* |
Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром |
|
message_id* |
Массив значений поля |
|
auth_connector |
Ключ источника. Передайте то же значение, с которым пакет получен методом |
Важно
Метод помечает ошибочными только записи пакета с переданным process_id. Записи с теми же MESSAGE_ID, которые еще не обработаны и не входят в этот пакет, метод удаляет из очереди. Поэтому с чужим или неверным process_id метод ничего не пометит, удалит записи и вернет true. С пустой строкой в process_id метод пометит ошибочными записи, которые еще не зарезервированы в пакет, а записи с теми же ключами из других пакетов удалит.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
"message_id": ["b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3"],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.offline.error
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'event.offline.error',
params: {
process_id: 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
message_id: ['b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3'],
},
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 error registered:', 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 registerOfflineError() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'event.offline.error',
params: {
process_id: 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
message_id: ['b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3'],
},
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 error registered:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', registerOfflineError)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.offline.error(
process_id="yh3gu929sf0d32lsfysqas2y1hlpp09q",
message_id=[
"b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
],
).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}")
try {
$response = $b24Service
->core
->call(
'event.offline.error',
[
'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
'message_id' => ['b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error handling offline event: ' . $e->getMessage();
}
BX24.callMethod(
"event.offline.error",
{
"process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
"message_id": ["b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3"]
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'event.offline.error',
[
'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
'message_id' => ['b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "event.offline.error", b24.Params{
"process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
"message_id": []string{"b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3"},
})
if err != nil {
return fmt.Errorf("event.offline.error: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1721300231.498173,
"finish": 1721300231.596196,
"duration": 0.0980229377746582,
"processing": 0.0019490718841552734,
"date_start": "2024-07-18T12:57:11+02:00",
"date_finish": "2024-07-18T12:57:11+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Всегда |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Argument 'PROCESS_ID' is null or empty |
Не передан параметр |
|
|
|
Value must be array of MESSAGE_ID values |
Параметр |
|
|
|
Access denied! |
Метод вызвал не администратор |
|
|
|
Current authorization type is denied for this method |
Метод вызван не в контексте приложения, например через вебхук |
|
|
|
This feature is not enabled for the current license: auth_connector |
Передан |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- События: обзор методов и событий
- Получить список доступных событий events
- Зарегистрировать новый обработчик события event.bind
- Получить список зарегистрированных обработчиков событий event.get
- Отменить зарегистрированный обработчик события event.unbind
- Безопасность в обработчиках
- Офлайн-события
- Получить список офлайн-событий event.offline.list
- Получить список офлайн-событий с «очисткой» event.offline.get
- Очистить записи в очереди офлайн-событий event.offline.clear
- Событие при появлении новых записей в очереди офлайн-событий onOfflineEvent