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

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
        
const response = await $b24.callMethod('imconnector.connector.data.set', {
          CONNECTOR: 'myconnector',
          LINE: 107,
          DATA: {
            ID: 'channel-123',
            URL: 'https://example.ru/chats/123',
            NAME: 'Канал поддержки',
          },
        });
        console.log(response.getData());
        
$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' => 'Канал поддержки',
                ],
            ]
        );

Обработка ответа

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

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

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

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

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

Предыдущая
Получить статус коннектора
Следующая
Получить список коннекторов