Установить настройки коннектора imconnector.connector.data.set

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imopenlines

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

Метод 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, 403

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'DATA' is null or empty"
}

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Метод вызван не в контексте приложения OAuth

400

ERROR_ARGUMENT

Argument 'CONNECTOR' is null or empty

Не передан CONNECTOR

400

ERROR_ARGUMENT

Argument 'LINE' is null or empty

Не передан LINE

400

ERROR_ARGUMENT

Argument 'DATA' is null or empty

Не передан DATA

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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