Перейти к содержанию

Каналы общения

В этом разделе настраиваются коммуникационные каналы, которые Webim принимает наряду с чатом на сайте: мессенджеры, социальные сети, почта и собственный канал по API.

Страница открывается в левом меню: Настройки → Каналы общения. На ней две вкладки — Активные каналы и Отключенные каналы. Каналы сгруппированы по типу, в том же порядке, что и ниже. Новый канал создаётся кнопкой Добавить в группе нужного типа. Заголовок формы зависит от типа, например Добавление канала MAX или Добавление Telegram-бота.

В строке уже созданного канала действие Состояние канала открывает сводку. В ней разделы Общее, Опрос, Webhook и, для Telegram, На стороне провайдера (Telegram).

Работоспособность каналов зависит не только от Webim. Мессенджеры и социальные сети меняют условия доступа к своим API, операторы связи влияют на качество соединения, регуляторы могут ограничивать работу отдельных сервисов. Такие изменения находятся вне контроля Webim, и сервис не гарантирует бесперебойную работу каналов в подобных случаях.

При редактировании уже сохранённого канала часть чувствительных данных в форме отображается частично скрытой (маскируется): полное значение в интерфейсе недоступно. Чтобы изменить такое поле, введите новое значение целиком. Незаполненные поля не маскируются.

Замаскированное значение показывается в поле ввода как подсказка (placeholder): часть символов заменена на звёздочки (*). Для адреса прокси у IPv4 видны только первые два октета (например, 192.168.*.*), у домена — первая и последняя метки (например, proxy.***.local). Порт, если он указан, не маскируется (например, 192.168.*.*:3128). Для URL видны схема и замаскированный хост, путь заменяется на *** (например, https://api.***.local/***); порт в URL тоже остаётся видимым. Для токенов и паролей начало скрыто звёздочками, в конце может оставаться короткий фрагмент.

Например, для Telegram частично скрываются URL API бота Telegram, адрес (хост) прокси, URL прокси вебхука, токен авторизации бота и пароль прокси. Аналогично маскируются секреты других каналов.

Общие поля формы

У большинства каналов форма содержит одни и те же поля. Ниже — их подписи в интерфейсе. Поля, которые есть только у конкретного типа, перечислены в его разделе.

Название параметра Описание
Название канала Название, которое видит оператор в РМО.
Системные сообщения Отправлять ли в канал системные сообщения Webim.
Выбор отдела Не нужен или Обязателен.
Обращение для отдела Отдел, в который попадут диалоги, если выбор отдела не нужен.
Доступные для выбора отделы Отделы, из которых посетитель выбирает, если выбор обязателен. Подсказка списка — Все.
Внешний идентификатор Идентификатор канала для бота ЦРТ. Подробнее — в разделе Внешний идентификатор.
Автоотключение при ошибках Сколько подряд невосстановимых ошибок (например, неверный токен) допускается до автоматического отключения канала. 0 — не отключать.
Использовать прокси Включает блок настроек прокси для запросов канала. В части форм флажок подписан Для использования прокси.

Если отделов, доступных для выбора, нет, вместо списка форма показывает текст Нет доступных для выбора отделов.

Внешний идентификатор

Внешний идентификатор используется в одном случае: его получает бот ЦРТ. В остальной работе Webim он не участвует, и заполнять его нужно, только если к аккаунту подключён такой бот.

Значение в поле Внешний идентификатор задаёте Вы: это идентификатор канала, под которым его знает бот ЦРТ. Мессенджер это значение не выдаёт. Длина — до 255 символов.

Поле есть в форме канала и в форме размещения на сайте, только если включена настройка Constance ENABLE_EXTERNAL_ID (см. Общие настройки). Пока она выключена, поле скрыто, и при сохранении канала записанный идентификатор не меняется. Если настройка выключена в момент создания, каналу записывается служебное значение из 32 шестнадцатеричных символов. После включения настройки оно видно в поле, и его можно заменить. Пустое поле при сохранении очищает идентификатор.

В запросе к боту ЦРТ идентификатор передаётся в поле channel_id:

  • Для диалога из канала общения — внешний идентификатор канала. Если он пуст, передаётся внутренний номер канала Webim.

  • Для диалога с сайта — внешний идентификатор размещения, с которого начат диалог. Если он пуст или размещение не определено, передаётся 0.

Настройка ENABLE_EXTERNAL_ID управляет только видимостью поля: записанный идентификатор, в том числе служебный, передаётся боту и при выключенной настройке. Внутренний номер канала идёт в том же запросе отдельно, в поле webim_channel_id.

Значение из одних цифр без ведущих нулей, не больше 9 007 199 254 740 991, передаётся числом. Остальные значения, в том числе с ведущими нулями, передаются строкой.

MAX

Интеграция мессенджера MAX. Подключение описано в инструкции. Форма называется Добавление канала MAX.

Название параметра Описание
Токен аутентификации бота Токен бота в MAX.
Ответное сообщение на /start Текст ответа на команду /start, если поле заполнено.
Начать диалог на /start Начинать диалог сразу после команды /start.
Измененная ссылка на кнопке Кнопка канала ведёт на max://max.ru/<bot> вместо https://max.ru/<bot>.

ВКонтакте

Интеграция сообщества ВКонтакте. Подключение описано в инструкции. Форма называется Добавление сообщества ВКонтакте.

Название параметра Описание
Ключ доступа Ключ доступа сообщества, выданный ВКонтакте.
Адрес сервера URL Webim, который нужно указать в настройках Callback API сообщества. Поле заполняется сервисом, его копируют в ВКонтакте.
Код подтверждения Строка из поля Строка, которую должен вернуть сервер в настройках Callback API. Её вставляют в форму до сохранения. После сохранения в поле остаётся маска; чтобы заменить код, введите новое значение целиком.
Секретный ключ Ключ, который форма показывает до сохранения. Его копируют в настройки Callback API сообщества. После сохранения в поле остаётся маска, и при редактировании ключ не меняется.

Одноклассники

Интеграция группы Одноклассники. Подключение описано в инструкции. Форма называется Добавление группы Одноклассники.

Название параметра Описание
Токен авторизации группы Токен группы в Одноклассниках.

Telegram

Интеграция бота Telegram. Подключение описано в инструкции. Форма называется Добавление Telegram-бота.

Название параметра Описание
Токен авторизации бота Токен, который выдаёт BotFather.
Ответное сообщение на /start Текст ответа на команду /start, если поле заполнено.
Начинать диалог на /start Начинать диалог сразу после команды /start.
Измененная ссылка на кнопке Кнопка канала ведёт на tg://resolve?domain=<bot> вместо https://t.me/<bot>.
Предложить оценить оператора Запрос оценки после того, как оператор закрыл диалог.
Режим опроса (polling) Бот забирает обновления опросом getUpdates. Вебхук при этом снимается. Нужен, когда у Telegram нет доступа к адресу вебхука.
URL API бота Telegram Адрес сервера Bot API для исходящих команд. Пустое поле — настройка аккаунта или сервера. По умолчанию используется https://api.telegram.org.
Пропустить проверку SSL для Bot API Для сервера Bot API с самоподписанным сертификатом.

Блок Групповые чаты описан в инструкции по Telegram. У сохранённого бота форма также показывает ссылку Бот и время Вебхук установлен.

Viber

Интеграция публичного аккаунта Viber. Подключение описано в инструкции. Форма называется Добавление канала Viber.

Название параметра Описание
Токен авторизации публичного аккаунта Токен публичного аккаунта Viber.
Измененная ссылка на кнопке Меняет ссылку кнопки канала на формат приложения Viber.

LINE

Интеграция мессенджера LINE. Подключение описано в инструкции. Форма называется Добавление канала LINE.

Название параметра Описание
Токен доступа к каналу Долгоживущий channel access token из настроек Messaging API.
Секретный токен канала Channel secret из основных настроек канала.

Электронная почта

Письма забираются по IMAP, ответы уходят по SMTP. Подключение описано в инструкции. Форма называется Добавление электронной почты и делится на блоки Настройки SMTP и Настройки IMAP. Перед сохранением можно нажать Проверить соединение. На форме также есть Выбор отдела, Внешний идентификатор и Автоотключение при ошибках.

Название параметра Описание
Электронная почта Адрес, от имени которого уходят ответы. Блок Настройки SMTP.
Адрес сервера, Порт, Логин, Пароль, Шифрование Параметры SMTP и, отдельно, те же подписи в блоке Настройки IMAP. Шифрование: Без шифрования, SSL или TLS.

Если порт SMTP не указан, используется 25, а при шифровании SSL — 465. Если порт IMAP не указан, используется 143, а при SSL — 993. Логин и пароль SMTP можно оставить пустыми, если сервер не требует авторизации.

Кастомный канал

Универсальный канал для своей системы обмена сообщениями. Форма называется Добавление кастомного канала. Поля формы описаны в инструкции. Формат запросов — Webim Custom Channel API.

Название параметра Описание
Ваш секретный ключ Ключ, которым Webim подписывает сообщения на Ваш сервер.
Адрес сервера URL, на который Webim отправляет события о новых сообщениях.
Наш секретный ключ Ключ, которым Вы подтверждаете запросы к Webim. Полное значение форма показывает только до первого сохранения; после сохранения в поле остаётся маска.
Идентификатор канала Появляется после сохранения. До сохранения в поле подсказка Будет присвоен после сохранения канала.