Documentação da API

Tudo o que você precisa para integrar sua aplicação com a plataforma de comunicação WhatsApp Avizuaí via API REST.

Primeiros Passos

⚡

Início Rápido

Envie sua primeira mensagem WhatsApp em menos de 5 minutos com a API.

🔒

Autenticação

OAuth2 client_credentials (recomendado), API Key + Secret (legado) ou JWT Bearer (Admin).

💬

Envio de Mensagens

Envie mensagens de texto, consulte histórico e acompanhe status de entrega.

🔌

Webhooks

Receba notificações em tempo real de mensagens recebidas e status de entrega.

🔐

OAuth2 / n8n

Automatize integrações com n8n, Zapier ou Make usando OAuth2 client_credentials e escopos granulares.

API — OAuth2

🩺

Pacientes

Liste, busque por CPF e faça upsert de pacientes de saúde com escopos pacientes:read|write.

📅

Agendamentos

Crie, consulte e atualize o status de agendamentos com escopos agendamentos:read|write.

👤

Atendimentos

Leia fila, em-andamento e histórico, e escale sessões para humano com atendimentos:read|escalar.

Referência da API

🌐

Endpoints Públicos & mTLS

Planos, contato, status, CRL e o canal mTLS do agente on-premises — sem autenticação.

💰

Financeiro

Consulte saldo, tarifas vigentes e extrato de movimentações da sua aplicação.

⚙

Configuração

Verifique o status da integração WhatsApp (provider) e estatísticas de envio.

⚠

Códigos de Erro

Referência completa dos códigos HTTP e formato de resposta de erro.

Links Rápidos

⚠ Códigos de Erro 🔒 Autenticação 🔌 Webhooks