Отменить регистрацию коннектора imconnector.unregister
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imopenlinesКто может выполнять метод: любой пользователь
Метод imconnector.unregister удаляет пользовательский коннектор.
Метод работает только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ID* |
Идентификатор коннектора, который был передан при регистрации в imconnector.register |
Примеры кода
Как использовать примеры в документации
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
// 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 UnregisterResult = {
result: boolean
}
try {
const response = await $b24.actions.v2.call.make<UnregisterResult>({
method: 'imconnector.unregister',
params: {
ID: 'myconnector',
},
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(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 unregisterConnector() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.unregister',
params: {
ID: 'myconnector',
},
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(result.result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', unregisterConnector)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.unregister(
bitrix_id="myconnector",
).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}")
$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',
]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.unregister", b24.Params{
"ID": "myconnector",
})
if err != nil {
return fmt.Errorf("imconnector.unregister: %w", err)
}
var item struct {
Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result)
Обработка ответа
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 |
|
|
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 |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Ошибка снятия регистрации приложения |
Не удалось удалить коннектор по |
|
|
|
Не удалось получить ID приложения |
В контексте запроса не найдено приложение |
|
|
|
Current authorization type is denied for this method Application context required |
Метод вызван не в контексте приложения OAuth |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Зарегистрировать коннектор imconnector.register
- Активировать коннектор imconnector.activate
- Получить статус коннектора imconnector.status
- Установить настройки коннектора imconnector.connector.data.set
- Получить список коннекторов imconnector.list
- Отправить сообщения в Битрикс24 imconnector.send.messages
- Изменить отправленные сообщения imconnector.update.messages
- Удалить отправленные сообщения imconnector.delete.messages
- Обновить статус «доставлено» imconnector.send.status.delivery
- Установить новое имя чата imconnector.chat.name.set