Управление WhatsApp Flows

​

Что это такое

​

Перед началом работы

• Подключите WABA, которой будет принадлежать Flow.
• Спроектируйте экраны и модель данных в корректном Flow JSON-документе.
• Определите, требуется ли для Flow эндпоинт данных.
• Выберите категории, описывающие сценарий использования Flow.
• Оставляйте новые наработки в DRAFT до завершения валидации и предварительного просмотра.

​

Как это работает

1. Создайте Flow с метаданными и, при необходимости, его структурой JSON.
2. Получите Flow и исправьте все ошибки валидации.
3. Обновите метаданные или загрузите исправленный файл Flow JSON.
4. Сгенерируйте общедоступный URL предварительного просмотра для тестирования заинтересованными сторонами.
5. Опубликуйте Flow, когда он будет готов к отправке в сообщениях.
6. Выведите опубликованный Flow из эксплуатации, когда его использование больше не требуется.

​

Запрос

​

Создание Flow

curl --request POST https://api.ycloud.com/v2/whatsapp/flows \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "wabaId": "WABA_ID",
    "name": "Appointment booking",
    "categories": ["APPOINTMENT_BOOKING"],
    "flowJson": "{\"version\":\"5.0\",\"screens\":[]}",
    "publish": false,
    "endpointUri": "https://example.com/whatsapp/flow"
  }'

​

Обновление структуры Flow

curl --request PATCH \
  https://api.ycloud.com/v2/whatsapp/flows/FLOW_ID/assets \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --form "flowJson=@./flow.json;type=application/json"

​

Предварительный просмотр и публикация

​

Ответ

{
  "id": "FLOW_ID",
  "success": true
}

{
  "id": "FLOW_ID",
  "name": "Appointment booking",
  "status": "DRAFT",
  "categories": ["APPOINTMENT_BOOKING"],
  "validationErrors": []
}

​

Жизненный цикл Flow

​

Ограничения и устранение неполадок

• Рассматривайте каждый указатель ошибки валидации как место в Flow JSON, требующее исправления.
• URL предварительного просмотра общедоступны; не включайте в них рабочие секреты или конфиденциальные тестовые данные.
• Публикация — это рубеж жизненного цикла. Сначала проверьте контент и поведение эндпоинта.
• Удаляйте Flow только тогда, когда его текущее состояние позволяет удаление.
• Контролируйте версии Flow JSON и логику эндпоинта совместно, если они обмениваются данными.