Настройка интеграции#
Make — это визуальная платформа для проектирования, которая позволяет автоматизировать задачи, подключая веб-приложения (такие, как Discord, Slack, Gmail). Автоматизированные процессы, создаваемые в Make, называются Scenarios (сценариями).
В сервисе Make платформа Green-API имеет свое приложение (альтернативная ссылка на приложение), с его помощью Вы сможете отправлять сообщения в WhatsApp.
Чтобы воспользоваться приложением Green API, нужно получить регистрационный токен и ID инстанса в личном кабинете. Для тестирования нашего API рекомендуем воспользоваться бесплатным тарифом разработчика.
Порядок настройки интеграции:
1. Настройка приложения Make
2. Настройка приложения Green API
3. Создание сценария
4. Получение сообщения
5. Отправка сообщения
1. Настройка приложения Make#
- Войдите или зарегистрируйте учетную запись в Make.
- Установите приложение Green-API в Make. Для этого перейдите по ссылке.
-
Нажмите кнопку
Install
.
-
Выберите организацию куда будет устанавливаться приложение Green-API и нажмите кнопку
Install
.
-
На странице
Installed Apps
можете проверить доступность приложения в Вашей организации.
2. Настройка приложения Green API#
- Войдите или зарегистрируйте учетную запись в Green API.
- Создайте инстанс на бесплатном тарифе "Developer". Для этого в личном кабинете нажмите кнопку
Создать инстанс
. После для тестирования выберите тариф "Developer".
![create-instance](../assets/setup/create-instance.png)
![developer](../assets/setup/developer.png)
-
Авторизуйте телефон. Для этого:
Можно отсканировать QR-код на странице настройки инстанса. В мобильном приложении WhatsApp или WhatsApp Business войдите в связанные устройства и отсканируйте полученный QR-код.
Или запросите шестизначный код авторизации для привязки по номеру телефона. В мобильном приложении WhatsApp или WhatsApp Business войдите в связанные устройства и нажмите
Связать по номеру телефона
.
После успешной авторизации, инстанс должен получить статус
Авторизован
.
Проверить статус инстанса вы можете используя методGetStateInstance
.
- Требуется скопировать значения
idInstance
иapiTokenInstance
для работы со сценариями Make.
![console](../assets/setup/console.png)
3. Создание сценария#
Scenario (сценарий) - автоматизированный процесс, создаваемый в Make. Каждый сценарии состоит из триггера и действия. При срабатывании триггера в одном из приложений Make автоматически выполняет действие в другом.
Алгоритм создания сценария:
- Войдите или зарегистрируйте учетную запись в Make
- В боковом меню нажмите кнопку
Scenarios
![go-to-scenarios](../assets/setup/go-to-scenarios.png)
- На странице сценариев нажмите
Create a new scenario
, чтобы создать новый сценарий
![create-new-scenario](../assets/setup/create-new-scenario.png)
Важно
После создания сценария на странице Make появится знак плюс (добавление приложения).
Для автоматической активации вашего сценария необходимо сначала настроить триггер
(для активации сценария при получении сообщения) и затем настроить соответствующее действие
(для автоматической отправки сообщения).
Сценарий успешно создан!
4. Получение сообщения#
Для получения сообщении в Make требуется настроить триггер.
Триггер - это событие, которое запускает ваш сценарий. Например, это может быть новое сообщение в WhatsApp, новая запись в Google Sheets, или что-то ещё.
Для получения сообщении в приложении Green API реализованы два вида триггера:
1. New Message Webhook
2. Last Incoming Messages
Выберите триггер, который соответствует вашим потребностям.
1. New Message Webhook#
New Message Webhook - триггер срабатывает на получение нового входящего сообщения в WhatsApp. Триггер основан на веб-хуках.
Плюсы:
+ Минимальное время срабатывания триггера
+ Более подробная информация о входящем сообщении
Минусы:
- Триггер можно использовать только для одной интеграции на один инстанс Green-api
- Если настройки инстанса поменять вручную, триггер может реагировать и на другие уведомления кроме входящих сообщении
Настройка инстанса
При использовании триггера New Message Webhook автоматически устанавливается настройка инстанса:
"webhookUrl": "вебхуксервер make",
"incomingWebhook": "yes"
2. Last Incoming Messages#
Last Incoming Messages - триггер срабатывает на получение нового входящего сообщения в WhatsApp. Триггер основан на методе lastIncomingMessages.
Плюсы:
+ Можно использовать этот триггер для разных интеграций на один инстанс Green-api
+ Триггер реагирует только на входящие сообщения
Минусы:
- Время срабатывания триггера складывается из времени добавления сообщения в журнал и частоты запроса метода сервисом Make (зависит от типа учетной записи Make)
Настройка инстанса
При использовании триггера Last Incoming Messages автоматически устанавливается настройка инстанса:
"incomingWebhook": "yes"
Настройка триггера#
Порядок настройки триггера:
- Создайте новый сценарий
- Нажмите на знак плюс, в списке приложении найдите Green API
![green-api-application-search](../assets/setup/green-api-application-search.png)
- Выберите один из методов получения сообщении
![triggers](../assets/setup/triggers.png)
Тегы триггеров
В Make тегом ACID
отмечаются методы для триггера. В нашем случае, триггерами являются методы получения сообщении.
Описание методов.
- Нажмите
add
чтобы добавить адрес, с которого будут приходить вебхуки.
![add-webhook](../assets/setup/add-webhook.png)
- На окне
Create a webhook
нажмитеadd
чтобы добавить подключение.
![create-webhook](../assets/setup/create-webhook.png)
- Вставьте значения Вашего инстанса
idInstance
иapiTokenInstance
(Получение сообщений будет вестись с номера привязанного к этому инстансу)
Значения инстанса
- Войдите в личный кабинет Green-API
- Перейдите в настройки инстанса, нажав на нужный инстанс из списка
- Скопируйте значения
idInstance
иapiTokenInstance
Также можете вставить скопированные значения из раздела "Настройка приложения Green API"
![make-green-api-form](../assets/setup/make-green-api-form.png)
Поле Connection name
Поле Connection name - можно использовать для названия добавляемого инстанса (например "рабочий номер", или "продажи").
Это позволит вам легко найти нужную вам учетную запись в списке доступных при создании интеграций.
- В окне
Create a connection
нажмитеSave
, чтобы сохранить - Соединение с добавленным инстансом будет успешным, если Make отобразит ваш номер в формате
phoneNumber@c.us
в списке "Connection" (подключении).
![successful-test](../assets/setup/connection-check.png)
- Чтобы триггер реагировал на сообщения любого контакта или чата в поле "Only From Specify Chat" выберите вариант
No
.
![specify-chat-no](../assets/setup/specify-chat-no.png)
Определенный контакт
Чтобы триггер реагировал на сообщения от определенного контакта в поле "Only From Specify Chat" выберите вариант Yes
.
- Выберите вариант
Manual
, чтобы ввести номер вручную:
![specify-chat-yes-manual](../assets/setup/specify-chat-yes-manual.png)
При заполнении номера вручную, требуется вводить в формате phoneNumber@c.us
. Например: 0100123456789@c.us
.
phoneNumber
— полный номер телефона в международном формате. Не используйте плюс, нули, скобки или дефисы при вводе номера телефона в международном формате..
- Выберите вариант
From Contact List
, чтобы выбрать номер из списка контактов:
![specify-chat-yes-contactlist](../assets/setup/specify-chat-yes-contactlist.png)
-
В окне
Create a webhook
нажмитеSave
, чтобы сохранить. После нажмитеOK
-
Сделайте тест, нажав кнопку
Run once
. Если в выбранном чате есть входящие сообщения, и тест успешен, нажмите налупу
, чтобы увидеть какие поля будут доступны при настройке действия.
![test-trigger](../assets/setup/test-trigger.png)
Готово! Триггер настроен, готов к использованию!
5. Отправка сообщения#
Для отправки сообщении требуется настроить действие в Make.
Добавьте действия, которые должны выполняться после срабатывания триггера. Это могут быть отправка сообщении, заполнение ячеек, обновление данных или другие действия в других приложениях или сервисах.
Настройку действия нужно выполнять после настройки триггера, чтобы сообщения отправлялись автоматический.
Также, можно настроить только действие, без триггера. Но в даннам случае сценарий необходимо запускать самостоятельно.
Действия#
Все действия повторяют методы Green API, подробнее о методах Green API можно прочитать в документации.
Методы отправки сообщения:
-
Send Message - отправка текстового сообщения.
-
Send Contact - отправка карточки контакта.
-
Send File by Url - отправка файла по URL.
-
Send Location Message - отправка геопозиции.
Краткие описания методов
-
Методы для работы с группами:
- Create Group - создание группового чата
- Update Group Name - смена наименования группового чата
- Set Group Picture - устанавка аватар группы
- Get Group Data - получение данных группового чата
- Add Group Participant - добавление участника в групповой чат
- Remove Group Participant - удаление участника из группового чата
- Set Group Admin - назначение участника группового чата администратором
- Remove Admin - лишение у участника прав администрирования группового чата
-
Очереди
- Show Messages Queue - получение списка сообщений, находящихся в очереди на отправку
- Clear Messages Queue - очистка очереди сообщений на отправку
-
Информация о чате
- Check Whatsapp - проверка наличия аккаунта WhatsApp на номере телефона
- Get Avatar - получение аватара корреспондента или группового чата
- Get Contacts - получение списка контактов текущего аккаунта
- Get Contact Info - получение информации о контакте
-
Настройки
- Get Settings - получение текущих настроек инстанса
- Set Settings - установка настроек инстанса
-
Другие
- Download File - скачивание принятых и отправленных файлов
- Set Profile Picture - установка аватара аккаунта
Настройка действия#
Порядок настройки действия:
- Чтобы добавить действие нажмите на полукруг рядом с триггером. После появится пустой серый круг со знаком плюс (добавление приложения).
Действие без триггера
- Cоздайте новый сценарий
- Продолжайте настройку по следующим пунктам
Внимание! В данном случае сценарий необходимо запускать самостоятельно.
-
Выберите приложение для исполнения действия, для этого в списке приложении найдите Green API.
-
Выберите один из методов отправки сообщения. Например, метод SendMessage
-
Из списка
Connection
выберите готовое подключение или добавьте подключение, нажав кнопкуadd
.При добавлении нового подключения, заполните данные Вашего инстанса
idInstance
иapiTokenInstance
(Отправка сообщений будет вестись с номера привязанного к этому инстансу).
После нажмитеSave
, чтобы сохранить.
![connection-action](../assets/setup/connection-action.png)
Поле Connection name
Поле Connection name - можно использовать для названия добавляемого инстанса (например "рабочий номер", или "продажи").
Это позволит вам легко найти нужную вам учетную запись в списке доступных при создании интеграций.
- В поле
Chat ID source
выберите удобный вам вариант внесения номера чата. ВариантManual
- введение номера вручную. ВариантFrom Contact List
- выбирать номер из списка контактов.
![chat-id](../assets/setup/chat-id.png)
- Поле
Chat Id
заполните вручную или выберите из списка контактов. При заполнении вручную номер надо вводить в форматеphoneNumber@c.us
. ПолеMessage
сформируйте из полей триггера, которую запустили во время теста. После нажмитеOK
.
![chat-id-and-message](../assets/setup/chat-id-and-message.png)
phoneNumber
phoneNumber
— полный номер телефона в международном формате.
Не используйте плюс, нули, скобки или дефисы при вводе номера телефона в международном формате..
Например: 0100123456789@c.us
.
- Сделайте тест, нажав кнопку
Run once
. Если тест успешен, нажмите налупу
, чтобы увидеть детали результата действия.
![test-action](../assets/setup/test-action.png)
Готово! Действие настроено, готово к использованию!