метод REST
scope: imopenlines
imconnector.unregister
Отменить регистрацию коннектора
Описание
Метод imconnector.unregister удаляет пользовательский коннектор.
Метод работает только в контексте приложения.
Параметры
ID
string
обязательный
Идентификатор коннектора, который был передан при регистрации в 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
boolean
true, если регистрация коннектора снята
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 200
{
"result": {
"result": false,
"error": "APPLICATION_UNREGISTRATION_ERROR",
"error_description": "Ошибка снятия регистрации приложения"
}
}
| Код | Описание | Значение |
|---|---|---|
200 |
APPLICATION_UNREGISTRATION_ERROR |
Ошибка снятия регистрации приложения |
200 |
NO_APPLICATION_ID |
Не удалось получить ID приложения |
403 |
WRONG_AUTH_TYPE |
Current authorization type is denied for this method Application context required |

