Pular para o conteúdo
apiwpp
Recursos

Tudo que a API faz, num só lugar

Conexões, envio, webhooks, fila anti-bloqueio e o painel para acompanhar tudo. Com especificação OpenAPI, referência em português e clientes gerados.

Screenshot do painel
01

Conexões

Cada conexão é um número de WhatsApp dentro de um projeto.

02

Envio

Uma chamada HTTP coloca a mensagem na fila do número.

03

Recursos PRO

Operações avançadas disponíveis no plano PRO.

  • Editar e apagarAltere em até 15 minutos ou apague para todos as mensagens enviadas pela API.
  • Leitura e presençaMarque mensagens como lidas e mostre “digitando” ou “gravando” quando quiser.
  • EnquetesEm breveCriar enquetes e receber os votos no webhook.
  • GruposEm breveCriar grupos e gerenciar participantes e administradores. Hoje: listar grupos e eventos de participação.
  • Mensagens interativasEm breveBotões e listas para respostas rápidas, em avaliação.
04

Para desenvolvedores

Ferramentas para integrar e operar com segurança.

  • OpenAPI 3.1Especificação pública e referência interativa em português.
  • Clientes TypeScript e PHPGerados a partir da especificação, com tipos de cada resposta.
  • Chaves com escopoChaves por projeto, com permissões e rotação sem downtime.
  • Página de statusPública, com um canário que envia mensagens reais entre dois números a cada 10 minutos.
Guias por recurso

Explore cada recurso

Como cada parte da API funciona, com exemplos, limites e respostas às dúvidas mais comuns.

Cada número entra na apiwpp como um aparelho conectado, igual ao WhatsApp Web: escaneie o QR code ou digite um código de 8 caracteres no celular e acompanhe o status pela API e pelo webhook connection.status.

Depois do pareamento, a sessão do número fica salva e criptografada nos servidores da apiwpp. Reinícios, atualizações e quedas de rede não pedem um novo QR code, e o celular não precisa ficar ligado.

POST /connections/{id}/send coloca a mensagem na fila do número e responde 202 com jobId, scheduledAt e position. A API resolve o endereço do destinatário, mostra o "digitando…" e avisa o resultado pelo webhook message.delivery.

Imagem, vídeo, áudio, documento e figurinha saem pela mesma rota de envio, a partir de uma URL https pública. Áudio pode ir como mensagem de voz, documento leva nome e legenda, e a mídia recebida chega no webhook.

Salve uma vez o texto de uma mensagem com variáveis como {{nome}} e {{pedido}} e envie pelo nome, preenchendo os valores em cada envio. Sem aprovação da Meta: o template vale assim que é criado.

Consulte até 100 números por chamada e saiba quais estão no WhatsApp, com o endereço (JID) em que cada um está registrado. Útil no cadastro, na limpeza da base e antes de uma sequência de envios.

Cada evento do número chega no seu servidor com um POST assinado com HMAC-SHA256. A entrega é feita pelo menos uma vez, com novas tentativas, registro de cada entrega e reenvio.

Cada número conectado tem uma fila que envia no ritmo de uma pessoa: limites por minuto, hora e dia, intervalo aleatório entre envios e um teto de destinatários novos por dia. Mensagens ilimitadas dentro desses limites.

Nos 14 dias depois de conectado, cada número segue limites menores de envio e de destinatários novos, que sobem em cinco etapas. A fila aplica tudo sozinha, e o estado do aquecimento aparece em GET /connections/{id}/queue.

Cada número sai para o WhatsApp por um IP brasileiro de provedor de internet, compartilhado só com números do mesmo cliente. Você pode trocar pelo seu próprio proxy ou, no plano PRO, contratar um IP só para um número.

O clientRef é o seu identificador de um envio. Repetir a requisição com o mesmo valor devolve o job original com duplicate: true, sem enfileirar outra mensagem, e o clientRef volta nos eventos de entrega e de falha.

Reaja a mensagens com emoji e receba as reações dos clientes pelo evento message.reaction em qualquer plano. Todo texto enviado mostra "digitando…" antes. No PRO, marque mensagens como lidas e controle a presença do número.

Errou o valor, o horário ou o link? Com o plano PRO, o seu sistema altera o texto de uma mensagem enviada pela API em até 15 minutos ou apaga a mensagem para todos, sempre pelo messageId.

Enquetes

Em breve

Enviar enquetes pela API e receber cada voto no seu webhook é um recurso em desenvolvimento, previsto para o plano PRO. Enquanto isso, respostas em texto e reações já confirmam agendamentos e coletam opiniões.

Grupos

Em breve

Hoje a API lista os grupos de que o número participa, entrega as mensagens de grupo no webhook e avisa quando o número entra, sai ou quando um grupo muda. Criar grupos e gerenciar participantes está em desenvolvimento para o PRO.

Botões e listas pelo protocolo do WhatsApp Web não têm suporte estável, e a apiwpp ainda avalia se vai oferecê-los. Enquanto isso, menus numerados, templates e reações resolvem confirmações e atendimento nos planos LITE e PRO.

Cada projeto é um sistema ou cliente seu, com os próprios números, webhook e chaves de API. As chaves têm escopo, validade e rotação com janela de sobreposição, e todos os projetos da conta entram numa fatura só.

A API inteira está descrita numa especificação OpenAPI 3.1 pública, com referência interativa em português. Dela saem clientes TypeScript e PHP tipados, e você pode gerar os tipos no seu próprio projeto.

Webhooks

Eventos que chegam no seu servidor

Entrega pelo menos uma vez, assinada com HMAC, com novas tentativas e registro de cada entrega no painel. Como os webhooks funcionam →

connection.status
A conexão abriu ou fechou, com status, motivo e número
message.incoming
Alguém escreveu para o número: texto, mídia ou localização
message.outgoing
O número enviou uma mensagem, pela API ou pelo celular (opcional)
message.delivery
Status de entrega: enviada, entregue, lida ou falhou
message.send_failed
Um envio com clientRef não pôde acontecer, com o motivo
message.reaction
Reação adicionada ou removida
contact.resolved
Um contato que chegou só com LID agora tem telefone
group.joined · left · updated
Mudanças de participação do número em grupos

Referência completa da API

Guias de início rápido, pareamento, envio, idempotência, erros e limites, mais a referência interativa de cada endpoint.

Abrir documentação →

Conecte seu primeiro número hoje.

7 dias grátis, sem cartão de crédito.