Enviar flow

Envia uma mensagem interativa com WhatsApp Flows (formulários e fluxos personalizados).

Endpoint

POST /chat/send/flow

Parâmetros

Nome	Tipo	Obrigatório	Descrição
to	string	Sim	JID do destinatário
body	string	Sim	Texto principal da mensagem
header	string	Não	Texto do cabeçalho
footer	string	Não	Texto do rodapé
buttons	object[]	Sim	Configuração dos botões de flow
buttons[].name	string	Sim	Nome do botão (identificador)
buttons[].buttonParamsJSON	string	Sim	JSON com parâmetros do botão (flow_id, flow_action, etc.)
buttons[].paramsJSON	string	Não	JSON com dados iniciais do flow
buttons[].messageVersion	number	Não	Versão da mensagem

Request

cURL

curl -X POST https://endpoint.wi.api.br/chat/send/flow \
  -H "x-api-key: $WIAPI_KEY" \
  -H "x-instance: session_01" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511998765432@s.whatsapp.net",
    "body": "Preencha o formulário para agendar sua consulta.",
    "header": "Agendamento",
    "footer": "Horários sujeitos a disponibilidade",
    "buttons": [
      {
        "name": "flow_reply",
        "buttonParamsJSON": "{\"flow_id\":\"1234567890\",\"flow_action\":\"navigate\",\"flow_token\":\"abc123\"}",
        "paramsJSON": "{\"screen\":\"APPOINTMENT\"}",
        "messageVersion": 3
      }
    ]
  }'

JavaScript

const response = await fetch("https://endpoint.wi.api.br/chat/send/flow", {
  method: "POST",
  headers: {
    "x-api-key": process.env.WIAPI_KEY,
    "x-instance": "session_01",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "5511998765432@s.whatsapp.net",
    body: "Preencha o formulário para agendar sua consulta.",
    header: "Agendamento",
    footer: "Horários sujeitos a disponibilidade",
    buttons: [
      {
        name: "flow_reply",
        buttonParamsJSON: JSON.stringify({
          flow_id: "1234567890",
          flow_action: "navigate",
          flow_token: "abc123",
        }),
        paramsJSON: JSON.stringify({ screen: "APPOINTMENT" }),
        messageVersion: 3,
      },
    ],
  }),
});

const data = await response.json();

Python

import json
import requests

response = requests.post(
    "https://endpoint.wi.api.br/chat/send/flow",
    headers={
        "x-api-key": WIAPI_KEY,
        "x-instance": "session_01",
    },
    json={
        "to": "5511998765432@s.whatsapp.net",
        "body": "Preencha o formulário para agendar sua consulta.",
        "header": "Agendamento",
        "footer": "Horários sujeitos a disponibilidade",
        "buttons": [
            {
                "name": "flow_reply",
                "buttonParamsJSON": json.dumps({
                    "flow_id": "1234567890",
                    "flow_action": "navigate",
                    "flow_token": "abc123",
                }),
                "paramsJSON": json.dumps({"screen": "APPOINTMENT"}),
                "messageVersion": 3,
            }
        ],
    },
)

data = response.json()

Response

{
  "messageId": "3EB0E5F6A7B8C9D01FB033",
  "messageid": "3EB0E5F6A7B8C9D01FB033"
}