Documentação
Documentação da apiwpp
Envie e receba mensagens de WhatsApp por números pareados por QR code ou código de pareamento, com uma API HTTP, webhooks assinados e envios idempotentes. Comece pelo início rápido ou vá direto à referência de cada operação. O início rápido leva cerca de 10 minutos.
Comece por aqui
- 1Crie uma chave de APINo painel, com os escopos de que o seu sistema precisa; a chave aparece uma única vez.2 min
- 2Pareie o númeroCrie a conexão e escaneie o QR code em Aparelhos conectados.3 min
- 3Assine os webhooksDefina o segredo que assina cada entrega com HMAC-SHA256.2 min
- 4Envie uma mensagemUma chamada coloca a mensagem na fila do número; o clientRef evita duplicar.1 min
- 5Receba os eventosConfira a assinatura, responda 2xx em até 10 segundos e processe depois.2 min
Guias
Pareamento, envio, webhooks, idempotência, limites e erros, passo a passo.
- Início rápidoDa conta criada até a primeira mensagem enviada e o primeiro evento recebido no seu servidor, em cinco passos.
- AutenticaçãoComo a chave de API é enviada, o que os escopos permitem, o que cada erro de autenticação quer dizer e como criar, rotacionar e revogar chaves.
- Parear um númeroConecte um número de WhatsApp por QR code ou por código de pareamento, acompanhe o status da conexão e saiba o que fazer quando o WhatsApp pede uma passkey.
- Enviar mensagensTexto, mídia, localização e templates pela fila de cada número, com reações, verificação de contatos e os eventos que contam o que houve com cada envio.
- Webhooks e assinaturaComo receber os eventos, verificar a assinatura X-Sales-Signature, testar o endpoint, e como funcionam as novas tentativas e o reenvio de entregas.
- IdempotênciaRepita um envio com segurança depois de um timeout usando o clientRef e ligue cada webhook da mensagem ao registro certo do seu sistema.
- Limites de envioO limite de requisições da API, a cota do plano e o ritmo de envio que protege cada número do banimento, com os 429 de cada um.
- ErrosO corpo de erro da API, o que cada status HTTP significa, qual limite gerou um 429 e como repetir uma requisição sem duplicar nada.
- LID e contact.resolvedPor que alguns remetentes chegam sem telefone, o que fazer com eles e como reatribuir os eventos quando o telefone aparece.
- Operações de mensagemEdite e apague para todos as mensagens enviadas pela API, marque as recebidas como lidas e mostre digitando ou gravando. Recursos do plano PRO.
- Projetos e conexõesComo organização, projeto e conexão se relacionam, o que você configura no projeto pela API e o ciclo de vida de um número: criar, desconectar, sair e excluir.
- Proxy e IP dedicadoPor onde cada número sai para o WhatsApp: o IP brasileiro compartilhado, um proxy seu por conexão ou um IP dedicado (PRO), e como verificar cada um.
- Uso e registrosQuanto os seus projetos enviaram frente ao plano, o registro de mensagens e de entregas de webhook, o reenvio de webhooks e por quanto tempo tudo fica guardado.
Referência da API
Cada operação HTTP, com parâmetros, respostas e exemplos em cURL, Node.js, PHP e Python.
- Conexões11 operaçõesCriar e parear números, desconectar, sair do WhatsApp, grupos, proxy e IP dedicado.
- Mensagens8 operaçõesEnviar, reagir, editar e apagar; a fila do número, leitura e presença.
- Projetos13 operaçõesA configuração de webhook, o teste do endpoint e as conexões de cada projeto.
- Contatos2 operaçõesVerificar se números estão no WhatsApp e consultar o perfil de um contato.
- Templates5 operaçõesMensagens reutilizáveis com variáveis, guardadas por conexão.
- Chaves de API4 operaçõesListar, criar, rotacionar e revogar as chaves de um projeto.
- Conta1 operaçãoA organização, os escopos e os projetos da credencial que chama.
- Uso2 operaçõesO uso de cada projeto e os totais diários de mensagens.
- Registros4 operaçõesAs mensagens registradas e as entregas de webhook, com reenvio.
- Mídia1 operaçãoO download dos arquivos recebidos, por URL assinada e temporária.
- Webhooks11 eventosO envelope, os cabeçalhos de assinatura e os campos de cada evento.
Consulta rápidaEscoposCódigos de erroCabeçalhosLimites
Especificação OpenAPI
A referência é gerada da especificação OpenAPI 3.1 pública do gateway. Baixe-a para gerar um cliente tipado ou importar num cliente HTTP.
- openapi.pt-BR.json (descrições em português)
- openapi.json (descrições em inglês)