Gerenciar WhatsApp Flows

​

O que é

​

Antes de começar

• Conecte a WABA que será a proprietária do Flow.
• Projete as telas e o modelo de dados em um documento Flow JSON válido.
• Decida se o Flow precisa de um endpoint de dados.
• Escolha categorias que descrevam o caso de uso do Flow.
• Mantenha o novo trabalho em DRAFT até que a validação e a visualização prévia estejam concluídas.

​

Como funciona

1. Crie um Flow com metadados e, opcionalmente, sua estrutura JSON.
2. Recupere o Flow e corrija todos os erros de validação.
3. Atualize os metadados ou envie um arquivo Flow JSON revisado.
4. Gere uma URL pública de pré-visualização para testes com partes interessadas.
5. Publique o Flow quando ele estiver pronto para mensagens.
6. Desative um Flow publicado quando ele não dever mais ser utilizado.

​

Requisição

​

Criar um 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"
  }'

​

Atualizar a estrutura do 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"

​

Visualizar e publicar

​

Resposta

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

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

​

Ciclo de vida do Flow

​

Limites e solução de problemas

• Trate cada apontador de erro de validação como um local a ser corrigido no Flow JSON.
• As URLs de pré-visualização são públicas; não inclua segredos de produção ou dados de teste confidenciais.
• A publicação é um limite de ciclo de vida. Confirme o conteúdo e o comportamento do endpoint primeiro.
• Exclua um Flow apenas quando o estado atual dele permitir a exclusão.
• Crie versões do Flow JSON e do comportamento do endpoint juntos quando eles trocarem dados.