Очистить записи в очереди офлайн-событий event.offline.clear

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: базовый

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

Метод event.offline.clear удаляет из очереди записи пакета, полученного методом event.offline.get с clear=0. Так приложение подтверждает, что обработало эти записи. Записи, которые не удалось обработать, пометьте методом event.offline.error. Порядок работы с пакетами описан в статье Офлайн-события.

В облачном Битрикс24 режим с резервированием пакетов зависит от тарифа — проверьте его методом feature.get с кодом rest_offline_extended. В коробочной версии режим доступен всегда, а feature.get вместо Y возвращает строку <язык>_selfhosted, например ru_selfhosted.

Метод работает только в контексте авторизации приложения. Права на методы событий описаны в разделе Права доступа.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
process_id* `string`	Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром `clear=0`. Значение также есть в поле `PROCESS_ID` записей, которые возвращает метод event.offline.list. Не передавайте пустую строку: метод не вернет ошибку и удалит из очереди все записи приложения вне пакетов, в том числе помеченные ошибкой
id `array`	Массив значений поля `ID` записей, которые нужно удалить, — целые числа больше `0`. Игнорируется, если передан параметр `message_id`. По умолчанию и при пустом массиве удаляются все записи пакета `process_id`
message_id `array`	Массив значений поля `MESSAGE_ID` записей, которые нужно удалить, — строки из 32 символов. По умолчанию и при пустом массиве удаляются все записи пакета `process_id`
auth_connector `string`	Ключ источника. Передайте то же значение, с которым пакет получен методом `event.offline.get`, иначе метод ничего не удалит. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE`

Примеры кода

Как использовать примеры в документации

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
    "id": [2],
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.offline.clear

// 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.clear',
    params: {
      process_id: 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
      id: [2],
    },
    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('Clear result:', 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 clearOfflineEvents() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'event.offline.clear',
        params: {
          process_id: 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
          id: [2],
        },
        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('Clear result:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', clearOfflineEvents)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.offline.clear(
        process_id="yh3gu929sf0d32lsfysqas2y1hlpp09q",
        bitrix_id=[2],
    ).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.clear',
            [
                'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
                'id'        => [2],
            ]
        );

    $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 clearing offline event: ' . $e->getMessage();
}

BX24.callMethod(
    "event.offline.clear",
    {
        "process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
        "id": [2]
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'event.offline.clear',
    [
        'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
        'id' => [2]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "event.offline.clear", b24.Params{
	"process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
	"id":         []int{2},
})
if err != nil {
	return fmt.Errorf("event.offline.clear: %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": 1721300421.210707,
        "finish": 1721300421.331026,
        "duration": 0.12031912803649902,
        "processing": 0.0022459030151367188,
        "date_start": "2024-07-18T13:00:21+02:00",
        "date_finish": "2024-07-18T13:00:21+02:00",
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `boolean`	Всегда `true`, если метод не вернул ошибку. Количество удаленных записей метод не возвращает: ответ `true`, даже если по переданным значениям записи не найдены
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 403

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	`ERROR_ARGUMENT`	Argument 'PROCESS_ID' is null or empty	Не передан параметр `process_id`
`400`	`ERROR_ARGUMENT`	Value must be array of integers	Параметр `id` передан не массивом или содержит значение меньше `1`
`400`	`ERROR_ARGUMENT`	Value must be array of MESSAGE_ID values	Параметр `message_id` передан не массивом или содержит строку не из 32 символов
`403`	`ACCESS_DENIED`	Access denied!	Метод вызвал не администратор
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Метод вызван не в контексте приложения, например через вебхук
`403`	`WRONG_LICENSE`	This feature is not enabled for the current license: auth_connector	Передан `auth_connector`, а тариф не поддерживает ключи источников

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

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

Зарегистрировать ошибки обработки очереди

Очистить записи в очереди офлайн-событий event.offline.clear

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение