Установить настройки коннектора imconnector.connector.data.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imopenlinesКто может выполнять метод: любой пользователь
Метод imconnector.connector.data.set сохраняет в Битрикс24 настройки пользовательского коннектора на указанной открытой линии: идентификатор внешнего канала, ссылки на него и название.
Настройки попадают в интерфейс оператора только после того, как коннектор включен на этой линии: метод imconnector.status должен вернуть STATUS: true.
Когда коннектор выключают вызовом imconnector.activate с параметром ACTIVE: 0, сохраненные настройки удаляются вместе с записью статуса.
Метод работает только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CONNECTOR* |
Строковый код коннектора, который задали в параметре |
|
LINE* |
Идентификатор открытой линии. Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get |
|
DATA* |
Объект настроек канала во внешней системе. Структура объекта подробно описана ниже |
Параметр DATA
Все поля объекта необязательные. Метод не перезаписывает настройки целиком: переданные поля обновляются, а непереданные сохраняют прежние значения.
Пустая строка игнорируется, поэтому очистить уже сохраненное значение методом нельзя.
|
Название |
Описание |
|
ID |
Идентификатор канала во внешней системе, например, Идентификатор нужно взять из внешней системы. Если готового нет, используйте уникальный ключ, например, комбинацию кода коннектора и идентификатора линии: |
|
URL |
Полная ссылка на чат или канал во внешней системе |
|
URL_IM |
Ссылка на чат, которую оператор открывает из интерфейса открытых линий. Если отдельной ссылки для оператора нет, поле можно не передавать — у коннектора останется только |
|
NAME |
Название канала, которое видит оператор |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"CONNECTOR":"myconnector",
"LINE":107,
"DATA":{
"ID":"channel-123",
"URL":"https://example.ru/chats/123",
"NAME":"Канал поддержки"
},
"auth":"**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imconnector.connector.data.set
// 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: 'imconnector.connector.data.set',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
DATA: {
ID: 'channel-123',
URL: 'https://example.com/chats/123',
NAME: 'Support Channel',
},
},
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('Connector data saved:', 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 setConnectorData() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.connector.data.set',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
DATA: {
ID: 'channel-123',
URL: 'https://example.com/chats/123',
NAME: 'Support Channel',
},
},
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('Connector data saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setConnectorData)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.connector.data.set(
connector="myconnector",
line=107,
data={
"ID": "channel-123",
"URL": "https://example.com/chats/123",
"NAME": "Support Channel",
},
).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.connector.data.set',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'DATA' => [
'ID' => 'channel-123',
'URL' => 'https://example.ru/chats/123',
'NAME' => 'Канал поддержки',
],
]
);
BX24.callMethod(
'imconnector.connector.data.set',
{
CONNECTOR: 'myconnector',
LINE: 107,
DATA: {
ID: 'channel-123',
URL: 'https://example.ru/chats/123',
NAME: 'Канал поддержки',
},
},
function(result) {
console.log(result.data());
}
);
$result = CRest::call(
'imconnector.connector.data.set',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'DATA' => [
'ID' => 'channel-123',
'URL' => 'https://example.ru/chats/123',
'NAME' => 'Канал поддержки',
],
]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.connector.data.set", b24.Params{
"CONNECTOR": "myconnector",
"LINE": 107,
"DATA": b24.Params{
"ID": "channel-123",
"URL": "https://example.ru/chats/123",
"NAME": "Канал поддержки",
},
})
if err != nil {
return fmt.Errorf("imconnector.connector.data.set: %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": 1773267900.126,
"finish": 1773267900.489,
"duration": 0.3630001544952393,
"processing": 0.0884850025177002,
"date_start": "2026-03-11T14:25:00+03:00",
"date_finish": "2026-03-11T14:25:00+03:00",
"operating_reset_at": 1773268500,
"operating": 0.0884850025177002
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Всегда |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'DATA' is null or empty",
"argument": "DATA"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Current authorization type is denied for this method Application context required |
Метод вызван не в контексте приложения OAuth |
|
|
|
Argument 'CONNECTOR' is null or empty |
Не передан |
|
|
|
Argument 'LINE' is null or empty |
Не передан |
|
|
|
Argument 'DATA' is null or empty |
Не передан ключ |
В теле ошибки ERROR_ARGUMENT приходит дополнительное поле argument с именем параметра — разбирать текст сообщения не нужно.
Статусы и коды системных ошибок
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.list
- Отменить регистрацию коннектора imconnector.unregister
- Отправить сообщения в Битрикс24 imconnector.send.messages
- Изменить отправленные сообщения imconnector.update.messages
- Удалить отправленные сообщения imconnector.delete.messages
- Обновить статус «доставлено» imconnector.send.status.delivery
- Установить новое имя чата imconnector.chat.name.set
- Как создать коннектор открытых линий для чата на сайте