Отправка WhatsApp Flow

Описание отправки Flow через шаблон с типом кнопки "flow" либо сервисное (бесплатное) сообщение.

В системе поддерживается запуск сценариев WhatsApp Flows через исходящие сообщения. Flow позволяет собрать данные пользователя (регистрация, запись на курс, заявка, анкета и т.д.) прямо внутри WhatsApp без перехода на внешний сайт.

В системе поддерживаются два типа исходящих сообщений:

1. Запуск Flow через шаблонное сообщение

2. Запуск Flow через Сервисное (бесплатное) сообщение.

Важно: для отправки сценария Flow он должен быть опубликован (published).

Подробнее о создании сценария и публикации здесь.

---

Запуск Flow через шаблонное сообщение

Когда используется:

• Пользователь ещё не писал (нет 24-часового окна);

• Нужно инициировать диалог;

• Нужно отправить форму регистрации / заявку / анкету;

• Нужно запустить лидогенерацию.

1

Создание шаблона c кнопкой Flow

Создание шаблона через addTemplate. Посмотреть метод и пример создания — в API документации.

2

Отправка шаблона с кнопкой Flow

Ожидайте одобрения созданного шаблона от WhatsApp. После одобрения отправьте шаблон через sendTemplate. Посмотреть метод и пример отправки — в API документации.

Отправка шаблона с кнопкой типа FLOW

Пример отправки шаблона с кнопкой типа flow :

  {
      "type": "button",
      "sub_type": "flow",
      "index": "0"
    }

Пример отправки шаблона с кнопкой типом flow с передачей flow_token и flow_action_data.

Используйте flow_action_data , чтобы передать во flow начальные входные данные.

   {
      "type": "button",
      "sub_type": "flow",
      "index": "0",
      "parameters": [
        {
          "type": "action",
          "action": {
            "flow_token": "flow_demo_00001",
            "flow_action_data": {
                    "fname": "Anna",
                    "lname": "Stakina",
                    "age": "30"
            }
          }
        }
      ]
    }

Parameter	Description
flow_token	Необязательный параметр Токен flow, генерируемый компанией и служащий в качестве идентификатора.
flow_action_data	Необязательный параметр JSON-объект с данными для первого экрана

3

Получите сообщение об успешном заполнении Flow

Как только клиент завершит заполнение формы и отправит данные — вы получите уведомление через webhook. Если у вас включена опция сохранения сообщений — данное входящее сообщение с сохраненными параметрами от Flow будет сохранено в методе messages.

Ответ клиента открывает 24-часовое окно для дальнейшей коммуникации либо его продлевает.

---

Запуск Flow через Сервисное (бесплатное) сообщение

Если пользователь уже написал и окно активно:

• Flow можно отправить как интерактивное сообщение

• Не требуется шаблон

• Не требуется предварительная модерация текста

1

Отправка сообщения с кнопкой Flow

Отправляйте сценарий Flow через sendFlow без предварительного одобрения от WhatsApp. Посмотреть метод и пример отправки — в API документации.

Отправка сообщения с кнопкой FLOW

Пример кнопки flow :

{
  "body": "Please complete the flow.",
  "flowId": "25999010459692480",
  "flowToken": "flow_demo_25999010459692480",
  "flowCta": "Open flow"
}

Пример кнопки flow c передачей flowActionPayload. Используйте flowActionPayload, чтобы передать во flow первичные входные данные.

{
  "phone": "{{phone}}",
  "header": "Header",
  "body": "Please complete the flow.",
  "footer": "Footer",
  "flowId": "{{flow_id}}",
  "flowToken": "flow_demo_1234",
  "flowMessageVersion": "3",
  "flowCta": "Button GO!",
  "flowAction": "navigate",
  "flowActionPayload": {
     "screen": "JOIN_NOW",
     "data": { 
           "fname": "Anna",
           "lname": "Stakina",
           "age": "30"
        }
    }
}

2

Получите сообщение об успешном заполнении Flow

Как только клиент завершит заполнение формы и отправит данные — вы получите уведомление через webhook. Если у вас включена опция сохранения сообщений данное входящее сообщение с сохраненными параметрами от Flow будет сохранено в методе messages.