Интеграция с Telegram, WhatsApp, MAX и VKontakte через Wappi сервис

Наш сервис интегрирован с мессенджерами Telegram, WhatsApp, MAX и VKontakte для отправки уведомлений через сервис Wappi. Используйте данную инструкцию, чтобы настроить рассылку уведомлений вашим клиентам.

Примечание

При выборе данного способа отправки уведомлений вашим клиентам учитывайте следующую информацию:

  1. Для отправки уведомлений Telegram, WhatsApp, MAX и VKontakte вам требуется оплачивать подписку на сервис Wappi, т.е. сообщения платные так же, как и отправка Sms.

  2. Не все ваши клиенты подключены к мессенджерам, поэтому нужно настраивать в Wappi каскадные рассылки на все виды мессанджеров, чтобы максимально повысить вероятность доставки сообщений.

Настройка Wappi

  1. Создайте личный кабинет Wappi по ссылке: https://wappi.pro/registration?ref=73bf516f

  2. В личном кабинете Wappi добавьте Профили под каждый вид мессенджера (Telegram, WhatsApp, MAX, VKontakte и др.) и настройте Профили.

  3. В личном кабинете Wappi настройте Каскады для каскадной отправки сообщений по всем настроенным мессенджерам.

  4. Скопируйте из личного кабинета Wappi идентификаторы apiToken, profileId и cascadeId для настройки WebHook (смотрите изображения ниже).

  5. После настройки и проверки WebHook оплатите подписку за сервис Wappi.

Параметры apiToken и profileId находятся на странице настройки Профиля. После регистрации сначала нужно создать и настроить Профиль для выбранного мессенджера.

Параметры личного кабинета Wappi

Параметр cascadeId находится на странице редактирования Каскада. После регистрации сначала нужно создать и настроить Каскад после настройки Профилей.

Параметры личного кабинета Wappi

Если у вас будут вопросы по настройке, то напишите в техническую поддержку Torrow.

Параметры WebHook

WebHook для отправки каскадных сообщений с использованием настроенных мессенджеров через Wappi имеет следующий URL: https://hooks.torrow.net/webhook/wappi

Для настройки WebHook используются следующие параметры:

  • cascadeId - идентификатор Каскада в Wappi для отправки сообщений по всем настроенным мессанджерам в формате шестнадцатеричной строки, например: e9f1c45c0bd7a3e8e8ba.

  • apiToken - ключ доступа к Wappi в формате строки, например 9410830193ce4ad56fe4df0378d1a0a8da13672248d94697b3.

  • errorEmail - адрес электронной почты, на который отправлять уведомления об ошибках отправки сообщений.

  • message - сообщение, добавляемое к форматированному сообщению. Например: Вы записаны на услугу.

  • profileId - идентификатор Профиля в Wappi для отправки сообщений с помощью конкретного мессенджера (например, Telegram) в формате строки, например: 58271315-d123. В параметрах WebHook обязательно должен быть либо cascadeId, либо profileId.

Пример WebHook для Wappi:

https://hooks.torrow.net/webhook/wappi?cascadeId=e9f1c45c0bd7a3e8e8ba&apiToken=9410830193ce4ad56fe4df0378d1a0a8da13672248d94697b3&errorEmail=test@gmail.com&message=Вы%20записаны%20на%20услугу

Дополнительные параметры форматирования сообщения:

  • resource_name - название ресурсов, по умолчанию: Услуги/ресурсы

  • detail_section_name - название раздела с деталями заказа, по умолчанию: Детали заказа, Детали записи, Детали мероприятия.

  • case_type_name - название типа события, по умолчанию: заказ, запись, участие в мероприятии

  • hide_detail_section - признак сокрытия раздела с деталями заказа, по умолчанию: false.

  • hide_resource_description - признак сокрытия описания деталей ресурсов, по умолчанию: false.

  • hide_order_duration - признак сокрытия длительности заказа, по умолчанию: false.

  • hide_address - признак сокрытия адреса оказания услуги, по умолчанию: false.

  • hide_service_name - признак сокрытия названия услуги, по умолчанию: false.

  • hide_order_description - признак сокрытия описания заказа, по умолчанию: false.

  • hide_url - признак сокрытия ссылок на услугу и на заказ, по умолчанию: false.

  • hide_contact_info - признак сокрытия контактной информации, по умолчанию true.

  • date_locales - формат даты и времени, по умолчанию: ru-RU, другие значения: en-US

  • timezone - часовой пояс, по умолчанию: Europe/Moscow, другие значения: https://timezonedb.com/time-zones

  • timezone_name - название часового пояса, по умолчанию: Мск, другие значения: указываются при настройке.

  • sign_text - подпись в конце сообщения, по умолчанию: пусто.

Примечание

В текстовых сообщениях нужно использовать ASCII коды: вместо пробела нужно встравлять код %20, вместо переноса строки код %0A

Например: строка%20один%0Aстрока%20два

Вспомогательные параметры отправки сообщения:

  • phone - номер телефона, на который нужно отправить сообщение, которое указано в поле message. Имеет приоритет перед всеми другими параметрами.

Пример WebHook для отправки сообщения на постоянный номер:

https://hooks.torrow.net/webhook/wappi?cascadeId=e9f1c45c0bd7a3e8e8ba&apiTokenInstance=9410830193ce4ad56fe4df0378d1a0a8da13672248d94697b3&errorEmail=test@gmail.com&phone=79819998877&message=Сообщение%20на%20постоянный%20номер

Проверка параметров WebHook:

Для проверки параметров WebHook нужно открыть сформированный URL в браузере и проверить результат выполнения.

Успешная проверка параметров URL

В ответе вызова WebHook вы получите статус проверки (Status):

  1. Success - вызов был успешным, все параметры корректны и WebHook можно подключать к Услуге Torrow.

  2. Error или Wrong parameters - есть ошибки в параметрах WebHook, которые нужно исправить. В поле “ErrorMessage” будет описание ошибок, которые нужно исправить. В поле “WarningMessage” - может находится информация, которая не влияет на работоспособность WebHook, но может быть полезна чтобы настроить WebHook полностью.

Некорректные параметры URL
Некорректные параметры URL

Подключение WebHook к услуге

  1. Откройте Услугу и раскройте раздел “Общие настройки”:

Общие настройки услуги

  1. В разделе “Общие настройки” выберите поле “Интеграции”:

Поле "Интеграции" в "Общих настройках"

  1. В интеграциях включите чекбокс WebHook:

Чекбокс WebHook

  1. Заполните поля для настройки WebHook:

  • Название интеграции - например “Wappi”

  • URL - сформированный выше WebHook

  • Чекбоксы событий, по которым будет вызываться WebHook:

    • Действие по заказу/событию (CaseActionEvent) - уведомление, которое можно подключить в настройках Услуги в поле «Действия»

Настройки WebHook

  1. Откройте редактирование Услуги и выберите поле «Действия»:

Настройки WebHook

  1. В самом низу формы добавьте вид действия, на которое будет отправляться WhatsApp уведомление:

  • Добавьте вид действия «Сообщение участнику о записи»

Вид действия
Результат выбора действия

  1. В настройках Действия поменяйте «Тип действия» на «Интеграция по операции»:

Тип действия
Выбор действия из списка
Результат выбора действия

  1. Выберите WebHook «Wappi», который будет вызываться при выполнении Действия:

Поле WebHook
Выбор WebHook

  1. После сохранения параметров можно проверять Услугу и отправку сообщений в WhatsApp по номеру телефона, указанному в контактной информации при записи на Услугу.

Сохранение параметров

Полезные инструменты для настройки и отладки