Integração Simples

Conecte nossa API ao seu sistema em poucos minutos. Não perca tempo desenvolvendo integração, deixe por nossa conta e foque no seu negócio. Deixe sua equiope livre para se concentrar no atendimento ao cliente e na experiência do usuário.

Linguagens Suportadas

Nossa API REST funciona com qualquer linguagem que suporte requisições HTTP. Pode utilizar com:

PHP
JavaScript
Python
Java
C#
Go
Ruby
cURL

Guia Rápido

Comece a usar nossa API em 3 passos simples:

1

Obtenha sua API Key

Acesse o painel e gere sua chave de autenticação

2

Faça sua primeira requisição

Use nossos exemplos para testar a conexão

3

Configure os webhooks

Receba notificações em tempo real

Exemplos de Integração

Integração CRM

Sincronize contatos e conversas com seu CRM automaticamente.

// Sincronizar contato no CRM const syncContact = async (phone, name) => { const contact = await crm.createContact({ phone: phone, name: name, source: 'whatsapp' }); // Criar conversa no WhatsApp await whatsapp.sendMessage(phone, `Olá ${name}! Bem-vindo ao nosso atendimento.` ); };

E-commerce

Envie notificações de pedidos, cobranças, pagamentos e entregas.

// Notificar status do pedido const notifyOrder = (order) => { const message = `🛍️ Seu pedido #${order.id} foi ${order.status}! 📦 Itens: ${order.items.join(', ')} 💰 Total: R$ ${order.total} 🚚 Previsão: ${order.delivery_date}`; whatsapp.sendMessage(order, message); };

Sistema de Tickets

Crie e gerencie tickets de atendimento e suporte via WhatsApp.

// Criar ticket automático const createTicket = async (message) => { const ticket = await createTicket({ title: message.substring(0, 50), description: message.text, customer: message.from, priority: 'medium' }); await whatsapp.sendMessage(message.from, `✅ Ticket #${ticket} criado!`); };

Endpoints da API

Explore todos os endpoints disponíveis para enviar mensagens, gerenciar contatos, consultar status e muito mais.

POST /api/v1/enviar-mensagem

Enviar Mensagem

Envia mensagem de texto simples para um número específico do WhatsApp. Suporte para texto formatado, emojis e caracteres especiais.

POST /api/v1/enviar-midia

Enviar Mídia

Envia arquivos de mídia como imagens, vídeos, documentos e áudios via WhatsApp. Formatos suportados: JPG, PNG, MP4, PDF, DOCX e muito mais.

POST /api/v1/criar-bot

Criar Bot

Cria um novo bot WhatsApp Web JS ou WhatsApp Cloud para seu número. Configuração automática com QR Code ou webhook para ativação rápida.

GET /api/v1/status-bot

Status do Bot

Verifica o status atual da conexão do bot com o WhatsApp. Retorna informações de conectividade, QR Code e dados da sessão.

POST /api/v1/criar-cobranca

Criar Cobrança

Gera cobrança PIX ou boleto automaticamente integrado ao WhatsApp. Envio automático da cobrança com QR Code ou link de pagamento.

GET /api/v1/status-cobranca

Status Cobrança

Consulta o status atual de uma cobrança específica em tempo real. Retorna se foi paga, está pendente, vencida ou cancelada.

POST /api/v1/configurar-webhook

Configurar Webhook

Define a URL do webhook para receber notificações em tempo real. Configuração de eventos específicos e filtros de mensagens.

POST /api/v1/testar-webhook

Testar Webhook

Envia um evento de teste para validar se o webhook está funcionando. Útil para verificar conectividade e configuração da URL destino.

GET /api/v1/historico-mensagens

Histórico de Mensagens

Recupera o histórico completo de mensagens enviadas e recebidas. Filtros por data, número, status de entrega e tipo de mensagem.

GET /api/v1/relatorio-uso

Relatório de Uso

Estatísticas detalhadas de uso da API com métricas de performance. Consumo por período, taxa de entrega e análise de webhooks.

Webhooks em Tempo Real

Receba notificações instantâneas sobre mensagens, status de entrega, conexão e eventos do WhatsApp diretamente no seu sistema, ganhando tempo e focando no seu atendimento e crescimento do negócio.

O que são Webhooks?

Webhooks são notificações HTTP em tempo real enviadas para seu servidor sempre que um evento acontece. Isso permite que sua aplicação reaja instantaneamente a novas mensagens, mudanças de status e outros eventos.

Notificações em tempo real
Sem necessidade de polling
Reduz latência e consumo
Automatização completa

Como Configurar

Configure seu webhook em 3 passos simples:

1

Criar endpoint

Crie uma URL em seu servidor para receber as notificações

2

Configurar no painel

Adicione a URL no painel de controle da API

3

Testar conexão

Envie um webhook de teste para validar

Tipos de Eventos

Mensagens Recebidas

Notificação quando uma nova mensagem é recebida de qualquer contato.

Payload de exemplo:
{ "event": "message.received", "timestamp": "2024-01-15T10:30:00Z", "data": { "id": "msg_123456", "from": "5511999999999", "message": "Oi, preciso de ajuda!", "type": "text" } }

Status de Entrega

Atualizações sobre entrega, leitura e falha de mensagens enviadas.

Payload de exemplo:
{ "event": "message.status", "timestamp": "2024-01-15T10:31:00Z", "data": { "message_id": "msg_123456", "status": "read", "to": "5511999999999", "timestamp": "2024-01-15T10:31:00Z" } }

Status de Conexão

Notificações sobre mudanças na conexão com WhatsApp.

Payload de exemplo:
{ "event": "connection.status", "timestamp": "2024-01-15T10:32:00Z", "data": { "status": "connected", "phone": "5511888888888", "to": "5511999999999", "qr_code": sdfasdfasd34v3456v345c2345 } }