.. _wazzup24-label:
=========================================================
Интеграция с WhatsApp через Wazzup24 сервис
=========================================================
.. |галка| image:: media/galka.png
:width: 21
:alt: alternative text
Наш сервис интегрирован с WhatsApp для отправки уведомлений через сервис Wazzup24. Используйте данную инструкцию, чтобы настроить рассылку уведомлений вашим клиентам через WhatsApp.
.. note::
При выборе данного способа отправки уведомлений вашим клиентам учитывайте следующую информацию:
1. Отправка уведомлений WhatsApp платная, так же как и отправка Sms.
2. В отличие от Sms-уведомлений, в WhatsApp вы платите за 1 день переписки с вашим клиентом, а не за отдельные сообщения.
3. Не все ваши клиенты имеют WhatsApp, поэтому не все клиенты будут получать уведомления. По статистике, примерно 12% клиентов не имеют WhatsApp.
Настройка Wazzup24
----------------------------
1. Создайте личный кабинет Wazzup24 по ссылке: https://wazzup24.com/?utm_p=zGYFL7
2. В личном кабинете настройте канал.
3. Настройте интеграцию с CRM: требуется добавить "Использовать API".
4. Скопируйте ключ API, которые будет добавлен в URL WebHook ниже.
5. Скопируйте идентификатор канала из URL настройки канала.
6. Оплатите подписку Pro и выше, чтобы была возможность писать первым в WhatsApp.
Если у вас будут вопросы по настройке, то напишите в `техническую поддержку Torrow`_.
.. _`техническую поддержку Torrow`: https://t.me/TorrowSupport
Параметры WebHook
----------------------------
WebHook для отправки WhatsApp сообщения через Wazzup24 имеет следующий URL: https://hooks.torrow.net/webhook/wazzup24
Для настройки WebHook используются следующие параметры:
* **key_api** - ключ для подключения к Wazzup24 в формате строки, например f8f1955587ac4d8894cee95f92dcaca4.
* **channel_id** - идентификатор канала в формате строки GUID, например: 3344fab4-b01b-4232-b9cb-a15ec3acc053.
* **chat_type** - тип чата для указанного канала. В данный момент поддерживается значение whatsapp.
* **errorEmail** - адрес электронной почты, на который отправлять уведомления об ошибках отправки WhatsApp сообщений.
* **message** - сообщение, добавляемое к форматированному сообщению WhatsApp. Например: Вы записаны на услугу.
Пример WebHook:
.. code-block::
https://hooks.torrow.net/webhook/wazzup24?key_api=f8f1955587ac6d7894cee95f92dcaca4&channel_id=3349fab8-b01b-4232-b9cb-a15ec3acc053&chat_type=whatsapp&errorEmail=test@test.ru&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** - подпись в конце сообщения, по умолчанию: пусто.
.. note::
В текстовых сообщениях нужно использовать `ASCII`_ коды: вместо пробела нужно встравлять код **%20**, вместо переноса строки код **%0A**
Например: **строка%20один%0Aстрока%20два**
.. _`ASCII`: https://www.eso.org/~ndelmott/url_encode.html
Проверка параметров WebHook:
----------------------------
Для проверки параметров WebHook нужно открыть сформированный URL в браузере и проверить результат выполнения.
.. figure:: media/wazzup24/CheckResultSuccess.png
:width: 80 %
:alt: Успешная проверка параметров URL
:align: center
------------------------------------
В ответе вызова WebHook вы получите статус проверки (Status):
1. **Success** - вызов был успешным, все параметры корректны и WebHook можно подключать к Услуге Torrow.
2. **Error** или **Wrong parameters** - есть ошибки в параметрах WebHook, которые нужно исправить. В поле **“ErrorMessage”** будет описание ошибок, которые нужно исправить. В поле **“WarningMessage”** - может находится информация, которая не влияет на работоспособность WebHook, но может быть полезна чтобы настроить WebHook полностью.
.. figure:: media/wazzup24/CheckResultWrong.png
:width: 80 %
:alt: Некорректные параметры URL
:align: center
------------------------------------
.. figure:: media/wazzup24/CheckResultError.png
:width: 80 %
:alt: Некорректные параметры URL
:align: center
------------------------------------
Подключение WebHook к услуге
----------------------------------
1. Откройте Услугу и раскройте раздел **“Общие настройки”**:
.. figure:: media/wazzup24/ServiceOptions.png
:width: 80 %
:alt: Общие настройки услуги
:align: center
----------------------------------
2. В разделе **“Общие настройки”** выберите поле **“Интеграции”**:
.. figure:: media/wazzup24/ServiceIntegration.png
:width: 80 %
:alt: Поле "Интеграции" в "Общих настройках"
:align: center
----------------------------------
3. В интеграциях включите чекбокс **WebHook**:
.. figure:: media/wazzup24/ServiceWebhook.png
:width: 80 %
:alt: Чекбокс WebHook
:align: center
----------------------------------
4. Заполните поля для настройки WebHook:
* **Название интеграции** - например “wazzup24”
* **URL** - сформированный выше WebHook
* Чекбоксы событий, по которым будет вызываться WebHook:
* **Действие по заказу/событию (CaseActionEvent)** - уведомление, которое можно подключить в настройках Услуги в поле "Действия"
.. figure:: media/wazzup24/WebhookOptions.png
:width: 80 %
:alt: Настройки WebHook
:align: center
------------------------------------
5. Откройте редактирование Услуги и выберите поле "Действия":
.. figure:: media/wazzup24/Action01.png
:width: 80 %
:alt: Настройки WebHook
:align: center
------------------------------------
6. В самом низу формы добавьте вид действия, на которое будет отправляться WhatsApp уведомление:
* Добавьте вид действия "Сообщение участнику о записи"
.. figure:: media/wazzup24/Action02.png
:width: 80 %
:alt: Вид действия
:align: center
------------------------------------
.. figure:: media/wazzup24/Action03.png
:width: 80 %
:alt: Результат выбора действия
:align: center
------------------------------------
7. В настройках Действия поменяйте "Тип действия" на "Интеграция по операции":
.. figure:: media/wazzup24/Action04.png
:width: 80 %
:alt: Тип действия
:align: center
------------------------------------
.. figure:: media/wazzup24/Action05.png
:width: 80 %
:alt: Выбор действия из списка
:align: center
------------------------------------
.. figure:: media/wazzup24/Action06.png
:width: 80 %
:alt: Результат выбора действия
:align: center
------------------------------------
8. Выберите WebHook "wazzup24", который будет вызываться при выполнении Действия:
.. figure:: media/wazzup24/Action07.png
:width: 80 %
:alt: Поле WebHook
:align: center
------------------------------------
.. figure:: media/wazzup24/Action08.png
:width: 80 %
:alt: Выбор WebHook
:align: center
------------------------------------
9. После сохранения параметров можно проверять Услугу и отправку сообщений в WhatsApp по номеру телефона, указанному в контактной информации при записи на Услугу.
.. figure:: media/wazzup24/Action09.png
:width: 80 %
:alt: Сохранение параметров
:align: center
------------------------------------
Полезные инструменты для настройки и отладки
----------------------------------------------
* Отправка Webhook: https://reqbin.com
* Ловец WebHook: https://webhook.site или https://hookbin.com
* `Пример файла JSON`_
.. _`Пример файла JSON`: media/wazzup24/Sample_JSON.json
.. raw:: html
.. raw:: html