Referencia da API
Documentacao completa dos endpoints do MAZAM WABA Connector (Meta Cloud API v25.0)
Referencia da API
Documentacao de referencia dos endpoints disponiveis no MAZAM WABA Connector. Todos os endpoints protegidos requerem o header Authorization: Bearer <API_KEY>.
O connector se comunica com a Meta Graph API v25.0 para envio/recebimento de mensagens WhatsApp.
Secoes da API
Mensagens
Envio de texto, imagem, video, audio, documento, sticker, localizacao, contatos, reacoes
Mensagens Interativas
Botoes, listas, CTA URL, mark as read
Templates
Criar, listar, deletar, sincronizar e testar templates
Instancias
Gerenciar numeros WhatsApp Business (CRUD, ativar, webhook)
Webhooks
Receber eventos da Meta e processar mensagens
OAuth
Embedded Signup e troca de tokens
Health
Health check, liveness e readiness probes
Visao Geral dos Endpoints
Envio de Mensagens (12 endpoints)
| Metodo | Endpoint | Descricao |
|---|---|---|
| POST | /send/text | Enviar mensagem de texto |
| POST | /send/image | Enviar imagem com caption |
| POST | /send/document | Enviar documento |
| POST | /send/audio | Enviar audio |
| POST | /send/video | Enviar video |
| POST | /send/sticker | Enviar sticker |
| POST | /send/location | Enviar localizacao GPS |
| POST | /send/contacts | Enviar cartao de contato |
| POST | /send/reaction | Reagir com emoji a mensagem |
| POST | /send/template | Enviar template aprovado |
| POST | /send/interactive | Enviar mensagem interativa (botoes/lista/CTA) |
| POST | /message/markread | Marcar mensagem como lida |
Media (2 endpoints)
| Metodo | Endpoint | Descricao |
|---|---|---|
| POST | /media/upload | Upload de midia para Meta |
| POST | /message/download | Download de midia da Meta |
Templates (5 endpoints)
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /templates | Listar templates da instancia |
| POST | /templates | Criar novo template |
| DELETE | /templates/\{name\} | Deletar template |
| POST | /templates/test | Testar envio de template |
| POST | /templates/sync | Sincronizar templates com Meta |
Instancias — Admin (10 endpoints)
| Metodo | Endpoint | Descricao | Auth |
|---|---|---|---|
| POST | /admin/auth/login | Login admin | Publico |
| GET | /admin/instances | Listar instancias | JWT |
| POST | /admin/instances | Criar instancia | JWT |
| GET | /admin/instances/\{id\} | Detalhar instancia | JWT |
| PATCH | /admin/instances/\{id\} | Atualizar instancia | JWT |
| DELETE | /admin/instances/\{id\} | Deletar instancia | JWT |
| POST | /admin/instances/\{id\}/activate | Ativar instancia | JWT |
| POST | /admin/instances/\{id\}/deactivate | Desativar instancia | JWT |
| POST | /admin/instances/\{id\}/refresh | Recarregar client | JWT |
| GET | /admin/instances/status/all | Status de todas | JWT |
Phone Numbers (4 endpoints)
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /instance/phone_numbers | Listar numeros da WABA |
| POST | /instance/register | Registrar numero na Meta |
| POST | /instance/request_code | Solicitar codigo verificacao |
| POST | /instance/verify_code | Verificar codigo |
OAuth / Embedded Signup (4 endpoints)
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /oauth/config | Obter config OAuth |
| POST | /oauth/exchange | Trocar auth code por token |
| POST | /oauth/register-phone | Registrar telefone pos-signup |
| POST | /oauth/override-webhook | Configurar URL do webhook |
Webhooks (2 endpoints)
| Metodo | Endpoint | Descricao | Auth |
|---|---|---|---|
| GET | /webhooks/whatsapp | Verificacao do webhook Meta | Publico |
| POST | /webhooks/whatsapp | Receber eventos da Meta | Publico |
Health (3 endpoints)
| Metodo | Endpoint | Descricao | Auth |
|---|---|---|---|
| GET | /health | Health check completo | Publico |
| GET | /health/live | Liveness probe | Publico |
| GET | /health/ready | Readiness probe | Publico |
Codigos de Resposta HTTP
| Codigo | Descricao |
|---|---|
| 200 | Sucesso |
| 201 | Criado com sucesso |
| 400 | Requisicao invalida |
| 401 | Nao autorizado — API key ou JWT invalido |
| 404 | Nao encontrado |
| 422 | Erro de validacao |
| 429 | Rate limit excedido |
| 500 | Erro interno do servidor |
Autenticacao
API Endpoints: Header Authorization: Bearer <API_KEY>
Admin Endpoints: Header Authorization: Bearer <JWT_TOKEN> (obtido via /admin/auth/login)
Webhooks e Health: Publicos, sem autenticacao.