imconnector.register

Scope: imconnector Права на выполнение: для всех

Метод регистрации нового типа коннектора.

Примечание. Если нужно чтобы коннектор отображался в общем списке коннекторов в виджете на сайте, нужно использовать метод imconnector.connector.data.set. Пример использования.

Параметры

Параметр Описание С версии

ID Уникальный идентификатор коннектора. Лучше предварять своим префиксом, дабы избежать пересечения с текущими и возможными будущими ID коннекторов. Можно использовать: цифры, буквы, знак подчеркивания.

NAME Отображаемое имя коннектора.

ICON

Массив описания иконки коннектора, где:

DATA_IMAGE - DATA-представление иконки SVG.

Пример

COLOR - цвет. Пример: #1900ff
SIZE - размер. Пример: 90%
POSITION - позиция SVG. Пример: center

PLACEMENT_HANDLER Ссылка на URL обработчика встройки, который будет вызываться для показа пользователям интерфейса настройки коннектора в слайдере. Подробнее о механизме встройки читайте в учебном курсе. В отличии от базового механизма встройки, в данном случае указывается только URL обработчика, т. е. нет нужды указывать на конкретный идентификатор места встройки.

ICON_DISABLED

Массив описания иконки коннектора для неактивного варианта, где:

DATA_IMAGE - DATA-представление иконки SVG. Для конвертации можно использовать сервис http://www.grumpicon.com/.

Пример

COLOR - цвет. Пример: #1900ff
SIZE - размер. Пример: 90%
POSITION - позиция SVG. Пример: center

DEL_EXTERNAL_MESSAGES Можно ли удалять входящие сообщения? По умолчанию: да.

EDIT_INTERNAL_MESSAGES Можно ли редактировать свои сообщения? По умолчанию: да.

DEL_INTERNAL_MESSAGES Можно ли удалять свои сообщения? По умолчанию: да.

NEWSLETTER Можно ли использовать канал для CRM-рассылки? По умолчанию: да.

NEED_SYSTEM_MESSAGES Можно ли отправлять системные сообщения в канал? По умолчанию: да.
Примеры: приветствие, завершающая реплика и т. п.

NEED_SIGNATURE Можно ли отправлять подпись в самом сообщении? По умолчанию: да.
Пример: перед текстом сообщения добавляется строка с именем оператора.

CHAT_GROUP Y\N. По умолчанию - Y/ Является ли чат данного канала с внешней стороны групповым. По умолчанию писать не могут. Так же не создаются лиды и прочие crm сущности.

COMMENT Описание для обработчика места встройки (см. параметр PLACEMENT_HANDLER).

Примечание: курсивом выделены необязательные параметры.