imconnector.connector.data.set
Установить настройки коннектора
Описание
Метод imconnector.connector.data.set устанавливает настройки канала во внешней системе для пользовательского коннектора и указанной открытой линии.
Метод работает только в контексте приложения.
Параметры
CONNECTOR
string
обязательный
Строковый код коннектора, который задали в параметре ID при вызове imconnector.register
LINE
integer
обязательный
Идентификатор открытой линии.
Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get
DATA
object
обязательный
Объект настроек канала во внешней системе. Метод не поддерживает отдельную установку или изменение одного поля: настройки записываются и перезаписываются через этот объект целиком.
Структура объекта подробно описана ниже
Параметр DATA
ID
string
необязательный
Идентификатор канала во внешней системе, например channel-123.
Идентификатор нужно взять из внешней системы. Если готового нет, используйте уникальный ключ, например, комбинацию ID коннектора и линии: myconnector_line107
URL
string
необязательный
Полная ссылка на чат или канал во внешней системе
URL_IM
string
необязательный
Полная ссылка на чат в формате для интерфейса оператора. Если отдельной ссылки для оператора нет, используйте значение URL
NAME
string
необязательный
Название канала для отображения в интерфейсе
Примеры запроса
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": 1738065600.11,
"finish": 1738065600.20,
"duration": 0.09,
"processing": 0.04,
"date_start": "2025-01-28T12:00:00+00:00",
"date_finish": "2025-01-28T12:00:00+00:00"
}
}
Возвращаемые данные
result
boolean
true, если данные сохранены
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'DATA' is null or empty"
}
| Код | Описание | Значение |
|---|---|---|
403 |
WRONG_AUTH_TYPE |
Current authorization type is denied for this method Application context required |
400 |
ERROR_ARGUMENT |
Argument 'CONNECTOR' is null or empty |
400 |
ERROR_ARGUMENT |
Argument 'LINE' is null or empty |
400 |
ERROR_ARGUMENT |
Argument 'DATA' is null or empty |

