метод REST scope: imopenlines

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

Ответ

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.