Início Rápido
Envie sua primeira mensagem WhatsApp em menos de 5 minutos.
Pré-requisitos
- Conta ativa no Avizuaí com aplicação cadastrada
- API Key e API Secret (obtidos no painel admin)
- Configuração Twilio ativa (Account SID + Auth Token + número WhatsApp)
- Saldo suficiente na aplicação
As credenciais de API são geradas automaticamente ao cadastrar uma aplicação no painel administrativo.
1 Autenticar
A API v2 utiliza autenticação via headers HTTP. Inclua suas credenciais em toda requisição:
-H "X-Api-Key: sua-api-key"
-H "X-Api-Secret: seu-api-secret"
2 Enviar Mensagem
Faça uma requisição POST para o endpoint de envio:
/api/external/messages/send
# Enviar mensagem WhatsApp
curl -X POST https://api.avizuai.com.br/api/external/messages/send \
-H "X-Api-Key: sua-api-key" \
-H "X-Api-Secret: seu-api-secret" \
-H "Content-Type: application/json" \
-d '{
"telefone": "+5511999999999",
"mensagem": "Olá! Esta é uma mensagem de teste."
}'
Resposta de sucesso:
{
"status": "ENVIADO",
"messageSid": "SM1234567890abcdef",
"mensagemId": 42,
"mensagem": "Mensagem enviada com sucesso"
}
3 Verificar Status
Consulte o status de entrega da mensagem pelo ID retornado:
curl https://api.avizuai.com.br/api/external/messages/42 \
-H "X-Api-Key: sua-api-key" \
-H "X-Api-Secret: seu-api-secret"
O campo status indica o estado atual: QUEUED, SENT, DELIVERED, READ, FAILED ou UNDELIVERED.
4 Consultar Saldo
Verifique o saldo disponível da sua aplicação:
curl https://api.avizuai.com.br/api/external/financeiro/saldo \
-H "X-Api-Key: sua-api-key" \
-H "X-Api-Secret: seu-api-secret"
{
"saldo": "150.50",
"moeda": "BRL"
}