Skip to main content
Este guia vai te ajudar a enviar sua primeira mensagem via WhatsApp usando a Oxenty API.

​
Pré-requisitos

Conta criada na Oxenty
API Key gerada no Dashboard
Número de telefone para testar

​
Passo 1: Obter sua API Key

1

Acesse o Dashboard

Faça login em oxenty.api.br/login
2

Navegue até API Keys

Menu lateral → API Keys
3

Crie uma nova key

Clique em “Criar Nova Key”, defina um nome e copie o valor gerado
Guarde sua API Key em local seguro. Ela não será exibida novamente.

​
Passo 2: Criar uma sessão

Uma sessão representa uma conexão com o WhatsApp. Você precisa criar e conectar uma sessão antes de enviar mensagens. 
curl -X POST "https://api.oxenty.api.br/api/sessions" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "minha-primeira-sessao"
  }'
Resposta: 
{
  "id": "sess_abc123",
  "name": "minha-primeira-sessao",
  "status": "disconnected",
  "createdAt": "2024-01-15T10:00:00.000Z"
}

​
Passo 3: Conectar a sessão

Para conectar a sessão no WhatsApp, obtenha o QR Code e escaneie com o celular: 
curl -X GET "https://api.oxenty.api.br/api/sessions/sess_abc123/qrcode" \
  -H "X-API-Key: YOUR_API_KEY"
Resposta: 
{
  "sessionId": "sess_abc123",
  "qrCode": "2@ABC123...",
  "status": "QRCODE",
  "message": "Escaneie o QR Code para conectar."
}
O campo qrCode deve ser renderizado como QR Code (imagem) no seu frontend.

​
Passo 4: Verificar conexão

Após escanear o QR Code, verifique se a sessão conectou: 
curl -X GET "https://api.oxenty.api.br/api/sessions/sess_abc123" \
  -H "X-API-Key: YOUR_API_KEY"
Resposta quando conectado: 
{
  "id": "sess_abc123",
  "name": "minha-primeira-sessao",
  "status": "connected",
  "phone": "5511999999999",
  "connectedAt": "2024-01-15T10:05:00.000Z"
}

​
Passo 5: Enviar sua primeira mensagem

Agora você pode enviar mensagens: 
curl -X POST "https://api.oxenty.api.br/api/messages/text" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "sess_abc123",
    "to": "5511888888888",
    "text": "Olá! Esta é minha primeira mensagem via Oxenty API!"
  }'
Resposta: 
{
  "messageId": "msg_xyz789",
  "status": "sent",
  "to": "5511888888888@s.whatsapp.net",
  "timestamp": "2024-01-15T10:10:00.000Z"
}
Pronto. Você acabou de enviar sua primeira mensagem via Oxenty API.