Отменить зарегистрированный обработчик события event.unbind

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

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

Scope: базовый

Кто может выполнять метод: любой пользователь

Метод event.unbind удаляет обработчики события, зарегистрированные приложением методом event.bind. В BX24.js для метода есть обертка BX24.callUnbind.

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

офлайн-события недоступны: вызов с event_type=offline вернет ошибку ACCESS_DENIED
удалить можно только свои обработчики онлайн-событий

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

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

Название `тип`	Описание
event* `string`	Код события, например `ONCRMLEADADD`. Регистр не важен
handler* `string`	URL обработчика, указанный при регистрации. Обязателен для онлайн-событий. При `event_type=offline` значение игнорируется
auth_type `integer`	Идентификатор пользователя, под которым авторизуется обработчик события. Без параметра администратор удаляет обработчики всех пользователей, а пользователь без прав администратора — только свои. Пользователю без прав администратора параметр передавать не нужно: если он передан, допустим только собственный ID целым числом, а строка `"15"` или `0` вернут ошибку `ACCESS_DENIED`. При `event_type=offline` параметр не учитывается Примечание Чтобы удалить только обработчики, которые авторизуются от имени пользователя, вызвавшего событие, администратор передает `auth_type=0`. Обработчики с другим `auth_type` останутся.
event_type `string`	Тип подписки: `online` или `offline`, регистр не важен. По умолчанию `online`. При `offline` метод работает с офлайн-событиями
auth_connector `string`	Ключ источника. Учитывается только при `event_type=offline`: удаляются офлайн-обработчики с тем же `auth_connector`, что передан в event.bind. Без параметра удаляются обработчики без ключа источника

Метод удаляет все обработчики приложения, которые совпали по переданным параметрам.

Примеры кода

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

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "event": "ONCRMLEADADD",
    "handler": "https://www.my-domain.ru/handler/",
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.unbind

// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type EventUnbindResult = {
  count: number
}

try {
  const response = await $b24.actions.v2.call.make<EventUnbindResult>({
    method: 'event.unbind',
    params: {
      event: 'ONCRMLEADADD',
      handler: 'https://www.my-domain.ru/handler/',
      auth_type: 15,
    },
    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('Unbound handlers count:', result.count)
  }
} 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 unbindEvent() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'event.unbind',
        params: {
          event: 'ONCRMLEADADD',
          handler: 'https://www.my-domain.ru/handler/',
          auth_type: 15,
        },
        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('Unbound handlers count:', result.count)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.event.unbind(
        event="ONCRMLEADADD",
        handler="https://www.my-domain.ru/handler/",
        auth_type=15,
    ).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 {
    $eventCode = 'your_event_code'; // Replace with your actual event code
    $handlerUrl = 'https://your.handler.url'; // Replace with your actual handler URL
    $userId = null; // Replace with your actual user ID or leave as null
    $result = $serviceBuilder
        ->getMainScope()
        ->event()
        ->unbind($eventCode, $handlerUrl, $userId);
    print($result->getUnbindedHandlersCount());
} catch (Throwable $e) {
    print('Error: ' . $e->getMessage());
}

require_once('crest.php');

$result = CRest::call(
    'event.unbind',
    [
        'event' => 'ONCRMLEADADD',
        'handler' => 'https://www.my-domain.ru/handler/',
        'auth_type' => 15
    ]
);

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

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

HTTP-статус: 200

Метод возвращает количество удаленных обработчиков.

{
    "result": {
        "count": 1
    },
    "time": {
        "start": 1721298360.468008,
        "finish": 1721298360.553977,
        "duration": 0.0859689712524414,
        "processing": 0.0023431777954101562,
        "date_start": "2024-07-18T12:26:00+02:00",
        "date_finish": "2024-07-18T12:26:00+02:00",
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Результат удаления (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
count `integer`	Количество удаленных обработчиков. Если подходящих обработчиков нет — `0`

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

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied! Offline events unbinding requires administrator access rights"
}

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

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

Статус	Код	Описание	Значение
`400`	`ERROR_ARGUMENT`	Argument 'EVENT' is null or empty	Не передан параметр `event`
`400`	`ERROR_ARGUMENT`	Argument 'HANDLER' is null or empty	Не передан параметр `handler` для онлайн-события
`400`	`ERROR_ARGUMENT`	`Value must be one of {online\|offline}`	Передано недопустимое значение `event_type`
`403`	`ACCESS_DENIED`	Access denied! Offline events unbinding requires administrator access rights	Метод вызвал не администратор с `event_type=offline`
`403`	`ACCESS_DENIED`	Access denied! Event unbinding with AUTH_TYPE requires administrator access rights	Метод вызвал не администратор и передал `auth_type`, не равный своему ID целым числом
`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.unbind

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

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

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

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

Объект resultОбъект result

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

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

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

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