Skip to main content
A Oxenty API é uma API REST que permite enviar e receber mensagens do WhatsApp, gerenciar sessões, contatos e grupos de forma programática.

Base URL

Todas as requisições devem ser feitas para:

Formato de Requisições

A API aceita requisições em formato JSON. Sempre inclua o header:

Autenticação

Todas as requisições precisam de autenticação via API Key.

API Key

Para integrações server-to-server. Crie no dashboard e use no header X-API-Key.

Exemplo com API Key

Formato de Respostas

Todas as respostas são em JSON. Uma resposta de sucesso típica:
Uma resposta de erro:

Códigos de Status HTTP

Paginação

Endpoints que retornam listas suportam paginação:
A resposta inclui metadados de paginação:

Rate Limits

A API possui limites de requisições por minuto baseados no seu plano: Quando exceder o limite, você receberá status 429 com o header:

SDKs Disponíveis

Node.js/TypeScript

SDK oficial: oxenty-sdk

Repositório

Código-fonte e issues

Instalação do SDK

Uso Básico

Próximos Passos

Autenticação

Configure sua API Key

Criar Sessão

Conecte seu WhatsApp

Enviar Mensagens

Envie sua primeira mensagem

Webhooks

Receba eventos em tempo real