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

Настройка интеграции#

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.

    install

  • Выберите организацию куда будет устанавливаться приложение Green-API и нажмите кнопку Install.

    install-organization

  • На странице Installed Apps можете проверить доступность приложения в Вашей организации.

    check-installed-app

2. Настройка приложения Green API#

  • Войдите или зарегистрируйте учетную запись в Green API.
  • Создайте инстанс на бесплатном тарифе "Developer". Для этого в личном кабинете нажмите кнопку Создать инстанс. После для тестирования выберите тариф "Developer".

create-instance

developer

  • Авторизуйте телефон. Для этого:

    Можно отсканировать QR-код на странице настройки инстанса. В мобильном приложении WhatsApp или WhatsApp Business войдите в связанные устройства и отсканируйте полученный QR-код.

    scan-qr

    Или запросите шестизначный код авторизации для привязки по номеру телефона. В мобильном приложении WhatsApp или WhatsApp Business войдите в связанные устройства и нажмите Связать по номеру телефона.

    scan-qr

После успешной авторизации, инстанс должен получить статус Авторизован.
Проверить статус инстанса вы можете используя метод GetStateInstance.

  • Требуется скопировать значения idInstance и apiTokenInstance для работы со сценариями Make.

console

3. Создание сценария#

Scenario (сценарий) - автоматизированный процесс, создаваемый в Make. Каждый сценарии состоит из триггера и действия. При срабатывании триггера в одном из приложений Make автоматически выполняет действие в другом.

Алгоритм создания сценария:

  • Войдите или зарегистрируйте учетную запись в Make
  • В боковом меню нажмите кнопку Scenarios

go-to-scenarios

  • На странице сценариев нажмите Create a new scenario, чтобы создать новый сценарий

create-new-scenario

Важно

После создания сценария на странице 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-application-search

  • Выберите один из методов получения сообщении

triggers

Тегы триггеров

В Make тегом ACID отмечаются методы для триггера. В нашем случае, триггерами являются методы получения сообщении.
Описание методов.

  • Нажмите add чтобы добавить адрес, с которого будут приходить вебхуки.

add-webhook

  • На окне Create a webhook нажмите add чтобы добавить подключение.

create-webhook

  • Вставьте значения Вашего инстанса idInstance и apiTokenInstance (Получение сообщений будет вестись с номера привязанного к этому инстансу)
Значения инстанса
  • Войдите в личный кабинет Green-API
  • Перейдите в настройки инстанса, нажав на нужный инстанс из списка
  • Скопируйте значения idInstance и apiTokenInstance

Также можете вставить скопированные значения из раздела "Настройка приложения Green API"

make-green-api-form

Поле Connection name

Поле Connection name - можно использовать для названия добавляемого инстанса (например "рабочий номер", или "продажи").
Это позволит вам легко найти нужную вам учетную запись в списке доступных при создании интеграций.

  • В окне Create a connection нажмите Save, чтобы сохранить
  • Соединение с добавленным инстансом будет успешным, если Make отобразит ваш номер в формате phoneNumber@c.us в списке "Connection" (подключении).

successful-test

  • Чтобы триггер реагировал на сообщения любого контакта или чата в поле "Only From Specify Chat" выберите вариант No.

specify-chat-no

Определенный контакт

Чтобы триггер реагировал на сообщения от определенного контакта в поле "Only From Specify Chat" выберите вариант Yes.

  • Выберите вариант Manual, чтобы ввести номер вручную:

specify-chat-yes-manual

При заполнении номера вручную, требуется вводить в формате phoneNumber@c.us. Например: 0100123456789@c.us.

phoneNumber — полный номер телефона в международном формате. Не используйте плюс, нули, скобки или дефисы при вводе номера телефона в международном формате..

  • Выберите вариант From Contact List, чтобы выбрать номер из списка контактов:

specify-chat-yes-contactlist

  • В окне Create a webhook нажмите Save, чтобы сохранить. После нажмите OK

  • Сделайте тест, нажав кнопку Run once. Если в выбранном чате есть входящие сообщения, и тест успешен, нажмите на лупу, чтобы увидеть какие поля будут доступны при настройке действия.

test-trigger

Готово! Триггер настроен, готов к использованию!

5. Отправка сообщения#

Для отправки сообщении требуется настроить действие в Make.

Добавьте действия, которые должны выполняться после срабатывания триггера. Это могут быть отправка сообщении, заполнение ячеек, обновление данных или другие действия в других приложениях или сервисах.

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

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

Действия#

Все действия повторяют методы Green API, подробнее о методах Green API можно прочитать в документации.

Методы отправки сообщения:

Краткие описания методов
  1. Методы для работы с группами:

    • Create Group - создание группового чата
    • Update Group Name - смена наименования группового чата
    • Set Group Picture - устанавка аватар группы
    • Get Group Data - получение данных группового чата
    • Add Group Participant - добавление участника в групповой чат
    • Remove Group Participant - удаление участника из группового чата
    • Set Group Admin - назначение участника группового чата администратором
    • Remove Admin - лишение у участника прав администрирования группового чата
  2. Очереди

    • Show Messages Queue - получение списка сообщений, находящихся в очереди на отправку
    • Clear Messages Queue - очистка очереди сообщений на отправку
  3. Информация о чате

    • Check Whatsapp - проверка наличия аккаунта WhatsApp на номере телефона
    • Get Avatar - получение аватара корреспондента или группового чата
    • Get Contacts - получение списка контактов текущего аккаунта
    • Get Contact Info - получение информации о контакте
  4. Настройки

    • Get Settings - получение текущих настроек аккаунта
    • Set Settings - установка настроек аккаунта
  5. Другие

    • Download File - скачивание принятых и отправленных файлов
    • Set Profile Picture - установка аватара аккаунта

Настройка действия#

Порядок настройки действия:

  • Чтобы добавить действие нажмите на полукруг рядом с триггером. После появится пустой серый круг со знаком плюс (добавление приложения).
    add-action
Действие без триггера

Внимание! В данном случае сценарий необходимо запускать самостоятельно.

  • Выберите приложение для исполнения действия, для этого в списке приложении найдите Green API.

    empty-action

  • Выберите один из методов отправки сообщения. Например, метод SendMessage

    send-message

  • Из списка Connection выберите готовое подключение или добавьте подключение, нажав кнопку add.

    При добавлении нового подключения, заполните данные Вашего инстанса idInstance и apiTokenInstance (Отправка сообщений будет вестись с номера привязанного к этому инстансу).
    После нажмите Save, чтобы сохранить.

connection-action

Поле Connection name

Поле Connection name - можно использовать для названия добавляемого инстанса (например "рабочий номер", или "продажи").
Это позволит вам легко найти нужную вам учетную запись в списке доступных при создании интеграций.

  • В поле Chat ID source выберите удобный вам вариант внесения номера чата. Вариант Manual - введение номера вручную. Вариант From Contact List - выбирать номер из списка контактов.

chat-id

  • Поле Chat Id заполните вручную или выберите из списка контактов. При заполнении вручную номер надо вводить в формате phoneNumber@c.us. Поле Message сформируйте из полей триггера, которую запустили во время теста. После нажмите OK.

chat-id-and-message

phoneNumber

phoneNumber — полный номер телефона в международном формате.
Не используйте плюс, нули, скобки или дефисы при вводе номера телефона в международном формате..
Например: 0100123456789@c.us.

  • Сделайте тест, нажав кнопку Run once. Если тест успешен, нажмите на лупу, чтобы увидеть детали результата действия.

test-action

Готово! Действие настроено, готово к использованию!

Примеры использования приложения Green API#

Как сделать обмен сообщениями между WhatsApp и Slack

Как сделать обмен сообщениями между WhatsApp и Discord