Mensagens
Enviar formulário
Card interativo com os campos. O Native Flow (tela de formulário) exige WhatsApp Cloud API.
Quando usar
formJson com `{ fields: [{ name, label }] }` lista os campos no card.
Se formJson tiver `url` (https), o botão abre o link. Sem url, o botão é Responder.
formName=flow faz o destinatário ver “atualize o WhatsApp”. Companion não renderiza Flow.
POST
/api/message/form/{instance}Enviar formulário
Texto com os campos; botão só se houver url no JSON.
Auth: TokenInstance
Body
| Campo | Tipo | Descrição | |
|---|---|---|---|
number | string | obrigatório | destino |
body | string | texto do card | |
footer | string | rodapé | |
formName | string | nome do flow | |
formJson | string | JSON, ex.: {"fields":[{"name":"nome","label":"Nome"}]} |
cURL
curl -X POST https://api.wagzap.com.br/api/message/form/vendas \
-H "token: $TOKEN_INSTANCE" \
-H "Content-Type: application/json" \
-d '{
"number": "5511999999999",
"body": "Cadastre-se",
"formName": "lead",
"formJson": "{\"fields\":[{\"name\":\"nome\",\"label\":\"Nome\"}]}"
}'Resposta
{
"success": true,
"messageId": "3EB08FCF27E532F1F5F5",
"data": { "messageId": "3EB08FCF27E532F1F5F5" }
}Erros
| HTTP | Mensagem |
|---|---|
| 400 | number and message required / payload inválido |
| 401 | missing token / invalid token |
| 403 | token does not match instance |
| 404 | instance not found |
| 429 | rate limit exceeded (padrão 100/min) |
| 502 | Falha no WhatsApp / instância desconectada |