Отменить регистрацию коннектора imconnector.unregister

Scope: imopenlines

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

Метод imconnector.unregister удаляет пользовательский коннектор.

Метод работает только в контексте приложения.

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

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

Название `тип`	Описание
ID* `string`	Идентификатор коннектора, который был передан при регистрации в imconnector.register

Примеры кода

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

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":"myconnector","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imconnector.unregister

const response = await $b24.callMethod('imconnector.unregister', {
          ID: 'myconnector',
        });
        console.log(response.getData());

$result = $b24Service->core->call(
            'imconnector.unregister',
            [
                'ID' => 'myconnector',
            ]
        );

BX24.callMethod(
            'imconnector.unregister',
            {
              ID: 'myconnector',
            },
            function(result) {
              console.log(result.data());
            }
        );

$result = CRest::call(
            'imconnector.unregister',
            [
                'ID' => 'myconnector',
            ]
        );

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

HTTP-статус: 200

{
            "result": {
            "result": true
            },
            "time": {
            "start": 1738065600.11,
            "finish": 1738065600.25,
            "duration": 0.14,
            "processing": 0.06,
            "date_start": "2025-01-28T12:00:00+00:00",
            "date_finish": "2025-01-28T12:00:00+00:00"
            }
        }

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

Название `тип`	Описание
result `boolean`	`true`, если регистрация коннектора снята
time `time`	Информация о времени выполнения запроса

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

В методе возможны два формата ошибок.

HTTP-статус: 200 с result = false

  {
              "result": {
                  "result": false,
                  "error": "APPLICATION_UNREGISTRATION_ERROR",
                  "error_description": "Ошибка снятия регистрации приложения"
              }
          }

HTTP-статус: 403 для системной ошибки авторизации

  {
              "error": "WRONG_AUTH_TYPE",
              "error_description": "Current authorization type is denied for this method Application context required"
          }

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

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

Статус	Код	Описание	Значение
`200`	`APPLICATION_UNREGISTRATION_ERROR`	Ошибка снятия регистрации приложения	Не удалось удалить коннектор по `ID` для текущего приложения
`200`	`NO_APPLICATION_ID`	Не удалось получить ID приложения	В контексте запроса не найдено приложение
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	Метод вызван не в контексте приложения OAuth

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить список коннекторов

Отправить сообщения в Битрикс24

Отменить регистрацию коннектора imconnector.unregister

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

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

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

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

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

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

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

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