Skip to content

Latest commit

 

History

History
81 lines (64 loc) · 6.5 KB

imconnector-register.md

File metadata and controls

81 lines (64 loc) · 6.5 KB
Raw

Зарегистрировать коннектор imconnector.register

{% note warning "Мы еще обновляем эту страницу" %}

Тут может не хватать некоторых данных — дополним в ближайшее время

{% endnote %}

{% if build == 'dev' %}

{% note alert "TO-DO не выгружается на prod" %}

  • не указана типы параметров
  • отсутствуют примеры
    • в структуре не было этих файлов, а на них ссылки из Примечания: imconnector.connector.data.set и cases/example_connector_chat

{% endnote %}

{% endif %}

Scope: imopenlines

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

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

{% note info "Примечание" %}

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

{% endnote %}

Параметры

#| || Параметр | Описание | С версии || || ID^*^ unknown | Уникальный идентификатор коннектора. Настоятельно рекомендуется добавлять в начале идентификатора свой уникальный префикс, чтобы избежать пересечения с текущими и возможными будущими идентификаторами других коннекторов. Для формирования идентификатора можно использовать: цифры, буквы в нижнем регистре и знак подчеркивания. | || || NAME^*^ unknown | Отображаемое имя коннектора. | || || ICON^*^ unknown | Массив описания иконки коннектора, где:

  • DATA_IMAGE^*^ unknown - DATA-представление иконки SVG. Пример
  • COLOR - цвет. Пример: #1900ff
  • SIZE - размер. Пример: 90%
  • POSITION - позиция SVG. Пример: center | || || PLACEMENT_HANDLER^*^ unknown | Ссылка на URL обработчика встройки, который будет вызываться для показа пользователям интерфейса настройки коннектора в слайдере. Подробнее | || || ICON_DISABLED unknown | Массив описания иконки коннектора для неактивного варианта, где:
  • DATA_IMAGE^*^ - DATA-представление иконки SVG. Пример
  • COLOR - цвет. Пример: #1900ff
  • SIZE - размер. Пример: 90%
  • POSITION - позиция SVG. Пример: center | || || DEL_EXTERNAL_MESSAGES unknown | Можно ли удалять входящие сообщения? По умолчанию: да. | || || EDIT_INTERNAL_MESSAGES unknown | Можно ли редактировать свои сообщения? По умолчанию: да. | || || DEL_INTERNAL_MESSAGES unknown | Можно ли удалять свои сообщения? По умолчанию: да. | || || NEWSLETTER unknown | Можно ли использовать канал для CRM-рассылки? По умолчанию: да. | || || NEED_SYSTEM_MESSAGES unknown | Можно ли отправлять системные сообщения в канал? Примеры: приветствие, завершающая реплика и т. п. По умолчанию: да. | || || NEED_SIGNATURE unknown | Можно ли отправлять подпись в самом сообщении? Пример: перед текстом сообщения добавляется строка с именем оператора. По умолчанию: да. | || || CHAT_GROUP unknown | Y/N. Является ли чат данного канала с внешней стороны групповым. По умолчанию: Y. По умолчанию писать не могут. Также не создаются лиды и прочие crm сущности.| || || COMMENT unknown | Описание для обработчика места встройки (см. параметр PLACEMENT_HANDLER). | || |#

{% include Сноска о параметрах %}

[*ключ_пример]:

data:image/svg+xml;charset=US-ASCII,%3Csvg%20version%3D%221.1%22%20id%3D%22Layer_1%22%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20x%3D%220px%22%20y%3D%220px%22%0A%09%20viewBox%3D%220%200%2070%2071%22%20style%3D%22enable-background%3Anew%200%200%2070%2071%3B%22%20xml%3Aspace%3D%22preserve%22%3E%0A%3Cpath%20fill%3D%22%230C99BA%22%20class%3D%22st0%22%20d%3D%22M34.7%2C64c-11.6%2C0-22-7.1-26.3-17.8C4%2C35.4%2C6.4%2C23%2C14.5%2C14.7c8.1-8.2%2C20.4-10.7%2C31-6.2%0A%09c12.5%2C5.4%2C19.6%2C18.8%2C17%2C32.2C60%2C54%2C48.3%2C63.8%2C34.7%2C64L34.7%2C64z%20M27.8%2C29c0.8-0.9%2C0.8-2.3%2C0-3.2l-1-1.2h19.3c1-0.1%2C1.7-0.9%2C1.7-1.8%0A%09v-0.9c0-1-0.7-1.8-1.7-1.8H26.8l1.1-1.2c0.8-0.9%2C0.8-2.3%2C0-3.2c-0.4-0.4-0.9-0.7-1.5-0.7s-1.1%2C0.2-1.5%2C0.7l-4.6%2C5.1%0A%09c-0.8%2C0.9-0.8%2C2.3%2C0%2C3.2l4.6%2C5.1c0.4%2C0.4%2C0.9%2C0.7%2C1.5%2C0.7C26.9%2C29.6%2C27.4%2C29.4%2C27.8%2C29L27.8%2C29z%20M44%2C41c-0.5-0.6-1.3-0.8-2-0.6%0A%09c-0.7%2C0.2-1.3%2C0.9-1.5%2C1.6c-0.2%2C0.8%2C0%2C1.6%2C0.5%2C2.2l1%2C1.2H22.8c-1%2C0.1-1.7%2C0.9-1.7%2C1.8v0.9c0%2C1%2C0.7%2C1.8%2C1.7%2C1.8h19.3l-1%2C1.2%0A%09c-0.5%2C0.6-0.7%2C1.4-0.5%2C2.2c0.2%2C0.8%2C0.7%2C1.4%2C1.5%2C1.6c0.7%2C0.2%2C1.5%2C0%2C2-0.6l4.6-5.1c0.8-0.9%2C0.8-2.3%2C0-3.2L44%2C41z%20M23.5%2C32.8%0A%09c-1%2C0.1-1.7%2C0.9-1.7%2C1.8v0.9c0%2C1%2C0.7%2C1.8%2C1.7%2C1.8h23.4c1-0.1%2C1.7-0.9%2C1.7-1.8v-0.9c0-1-0.7-1.8-1.7-1.9L23.5%2C32.8L23.5%2C32.8z%22/%3E%0A%3C/svg%3E%0A