Gestionar WhatsApp Flows

​

Qué es

​

Antes de comenzar

• Conecta la WABA que será propietaria del Flow.
• Diseña las pantallas y el modelo de datos en un documento Flow JSON válido.
• Decide si el Flow necesita un endpoint de datos.
• Elige categorías que describan el caso de uso del Flow.
• Mantén el nuevo trabajo en DRAFT hasta que la validación y la vista previa estén completas.

​

Cómo funciona

1. Crea un Flow con metadatos y, opcionalmente, su estructura JSON.
2. Recupera el Flow y corrige todos los errores de validación.
3. Actualiza los metadatos o sube un archivo Flow JSON modificado.
4. Genera una URL de vista previa pública para que las partes interesadas lo prueben.
5. Publica el Flow cuando esté listo para enviar mensajes.
6. Descontinúa un Flow publicado cuando ya no deba utilizarse.

​

Solicitud

​

Crear un 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"
  }'

​

Actualizar la estructura del 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"

​

Previsualizar y publicar

​

Respuesta

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

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

​

Ciclo de vida del Flow

​

Límites y resolución de problemas

• Trata cada puntero de error de validación como una ubicación en el Flow JSON que debes corregir.
• Las URL de vista previa son públicas; no incluyas secretos de producción ni datos de prueba confidenciales.
• La publicación es un límite en el ciclo de vida. Confirma el contenido y el comportamiento del endpoint primero.
• Elimina un Flow únicamente cuando su estado actual lo permita.
• Gestiona las versiones del Flow JSON y del comportamiento del endpoint de manera conjunta cuando intercambien datos.