# apiwpp — Documentação da API > Documentação da API de WhatsApp da apiwpp, em português: guias, a referência de cada operação HTTP e os eventos de webhook, gerados da especificação OpenAPI pública. Atualizado em: 2026-09-29 Documentação: https://apiwpp.com/docs · Site: https://apiwpp.com · Especificação OpenAPI: https://apiwpp.com/docs/openapi.json (pt-BR: https://apiwpp.com/docs/openapi.pt-BR.json) Texto completo para IA: https://apiwpp.com/docs/llms-full.txt Cada link abaixo é a versão em Markdown da página; a URL da página está na linha "Fonte:" de cada uma. ## Começando - [Documentação da apiwpp](https://apiwpp.com/docs/index.md): Guias e referência da API de WhatsApp da apiwpp: pareamento, envio de mensagens, webhooks assinados e cada operação HTTP, em português. - [Início rápido](https://apiwpp.com/docs/inicio-rapido.md): Da conta criada até a primeira mensagem enviada e o primeiro evento recebido no seu servidor, em cinco passos. - [Autenticação](https://apiwpp.com/docs/autenticacao.md): Como 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. ## Guias - [Parear um número](https://apiwpp.com/docs/guias/parear-um-numero.md): Conecte 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 mensagens](https://apiwpp.com/docs/guias/enviar-mensagens.md): Texto, 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 assinatura](https://apiwpp.com/docs/guias/webhooks-e-assinatura.md): Como receber os eventos, verificar a assinatura X-Sales-Signature, testar o endpoint, e como funcionam as novas tentativas e o reenvio de entregas. - [Idempotência](https://apiwpp.com/docs/guias/idempotencia.md): Repita 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 envio](https://apiwpp.com/docs/guias/limites-de-envio.md): O 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. - [Erros](https://apiwpp.com/docs/guias/erros.md): O 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.resolved](https://apiwpp.com/docs/guias/lid-e-contact-resolved.md): Por que alguns remetentes chegam sem telefone, o que fazer com eles e como reatribuir os eventos quando o telefone aparece. - [Operações de mensagem](https://apiwpp.com/docs/guias/operacoes-de-mensagem.md): Edite 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ões](https://apiwpp.com/docs/guias/projetos-e-conexoes.md): Como 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 dedicado](https://apiwpp.com/docs/guias/proxy-e-ip-dedicado.md): Por 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 registros](https://apiwpp.com/docs/guias/uso-e-registros.md): Quanto 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 - [Visão geral da API](https://apiwpp.com/docs/api.md): A API HTTP da apiwpp: endereço base, autenticação por chave, formato dos erros e a lista de todas as operações e eventos de webhook. - [Escopos](https://apiwpp.com/docs/referencia/escopos.md): Os nove escopos que uma chave de API pode ter, o que cada um libera e todas as operações que exigem cada um deles. - [Códigos de erro](https://apiwpp.com/docs/referencia/codigos-de-erro.md): Cada identificador de erro da API, por status HTTP: onde aparece, o corpo que chega e o que fazer. Mais os motivos de falha que chegam pelos webhooks. - [Cabeçalhos](https://apiwpp.com/docs/referencia/cabecalhos.md): Os cabeçalhos HTTP da API: os que você envia (a chave e o Content-Type), os que as respostas trazem e os que chegam em cada entrega de webhook. - [Limites](https://apiwpp.com/docs/referencia/limites.md): Todos os números da apiwpp numa página: requisições, cota, ritmo de envio por número, pareamento, chaves, webhooks, mídia e registros. ## Conexões - [Criar conexão (POST /connections)](https://apiwpp.com/docs/api/conexoes/criar-conexao.md): Criar uma conexão de WhatsApp - [QR code e status (GET /connections/{id}/qr)](https://apiwpp.com/docs/api/conexoes/qr-code-e-status.md): Obter o QR code e o status da conexão - [Código de pareamento (POST /connections/{id}/pairing-code)](https://apiwpp.com/docs/api/conexoes/codigo-de-pareamento.md): Obter um código de pareamento para conectar um número sem o QR code - [Desconectar (POST /connections/{id}/disconnect)](https://apiwpp.com/docs/api/conexoes/desconectar.md): Desconectar uma conexão do WhatsApp - [Listar conexões (GET /connections)](https://apiwpp.com/docs/api/conexoes/listar-conexoes.md): Listar conexões - [Sair do WhatsApp (POST /connections/{id}/logout)](https://apiwpp.com/docs/api/conexoes/sair-do-whatsapp.md): Sair do WhatsApp (logout) - [Listar grupos (GET /connections/{id}/groups)](https://apiwpp.com/docs/api/conexoes/listar-grupos.md): Listar grupos - [Consultar proxy (GET /connections/{id}/proxy)](https://apiwpp.com/docs/api/conexoes/consultar-proxy.md): Obter o proxy de uma conexão - [Definir proxy (PUT /connections/{id}/proxy)](https://apiwpp.com/docs/api/conexoes/definir-proxy.md): Definir o proxy de uma conexão - [Remover proxy (DELETE /connections/{id}/proxy)](https://apiwpp.com/docs/api/conexoes/remover-proxy.md): Remover o proxy de uma conexão - [IP dedicado (GET /connections/{id}/dedicated-ip)](https://apiwpp.com/docs/api/conexoes/ip-dedicado.md): Obter o IP dedicado de uma conexão ## Mensagens - [Enviar mensagem (POST /connections/{id}/send)](https://apiwpp.com/docs/api/mensagens/enviar-mensagem.md): Enfileirar uma mensagem para envio - [Fila do número (GET /connections/{id}/queue)](https://apiwpp.com/docs/api/mensagens/fila-do-numero.md): Consultar a fila de uma conexão - [Reagir (POST /connections/{id}/react)](https://apiwpp.com/docs/api/mensagens/reagir.md): Reagir a uma mensagem - [Editar mensagem (POST /connections/{id}/messages/{messageId}/edit)](https://apiwpp.com/docs/api/mensagens/editar-mensagem.md): Editar uma mensagem enviada - [Cancelar da fila (DELETE /connections/{id}/queue/{jobId})](https://apiwpp.com/docs/api/mensagens/cancelar-mensagem-na-fila.md): Cancelar uma mensagem na fila - [Apagar mensagem (DELETE /connections/{id}/messages/{messageId})](https://apiwpp.com/docs/api/mensagens/apagar-mensagem.md): Apagar uma mensagem enviada para todos - [Marcar como lidas (POST /connections/{id}/read)](https://apiwpp.com/docs/api/mensagens/marcar-como-lidas.md): Marcar mensagens recebidas como lidas - [Mostrar presença (POST /connections/{id}/presence)](https://apiwpp.com/docs/api/mensagens/mostrar-presenca.md): Mostrar uma presença em uma conversa ## Projetos - [Atualizar projeto (PATCH /tenants/{id})](https://apiwpp.com/docs/api/projetos/atualizar-projeto.md): Atualizar um projeto - [Listar projetos (GET /tenants)](https://apiwpp.com/docs/api/projetos/listar-projetos.md): Listar projetos - [Consultar projeto (GET /tenants/{id})](https://apiwpp.com/docs/api/projetos/consultar-projeto.md): Consultar um projeto - [Desativar projeto (DELETE /tenants/{id})](https://apiwpp.com/docs/api/projetos/desativar-projeto.md): Desativar um projeto - [Testar webhook (POST /tenants/webhook-test)](https://apiwpp.com/docs/api/projetos/testar-webhook.md): Testar um endpoint de webhook - [Conexões do projeto (GET /tenants/{id}/connections)](https://apiwpp.com/docs/api/projetos/listar-conexoes-do-projeto.md): Listar as conexões de um projeto - [Criar conexão no projeto (POST /tenants/{id}/connections)](https://apiwpp.com/docs/api/projetos/criar-conexao-no-projeto.md): Criar uma conexão no projeto - [Consultar conexão (GET /tenants/{id}/connections/{connId})](https://apiwpp.com/docs/api/projetos/consultar-conexao.md): Consultar uma conexão - [Excluir conexão (DELETE /tenants/{id}/connections/{connId})](https://apiwpp.com/docs/api/projetos/excluir-conexao.md): Excluir uma conexão - [Histórico de heartbeats (GET /tenants/{id}/connections/{connId}/heartbeats)](https://apiwpp.com/docs/api/projetos/historico-de-heartbeats.md): Histórico de heartbeats da conexão - [QR code como imagem (GET /tenants/{id}/connections/{connId}/qr)](https://apiwpp.com/docs/api/projetos/qr-code-como-imagem.md): Obter o QR code como imagem - [Desconectar conexão (POST /tenants/{id}/connections/{connId}/disconnect)](https://apiwpp.com/docs/api/projetos/desconectar-conexao-do-projeto.md): Desconectar uma conexão - [Reconectar conexão (POST /tenants/{id}/connections/{connId}/connect)](https://apiwpp.com/docs/api/projetos/reconectar-conexao.md): Conectar de novo uma conexão ## Contatos - [Verificar números (POST /connections/{id}/contacts/check)](https://apiwpp.com/docs/api/contatos/verificar-numeros.md): Verificar se números estão no WhatsApp - [Perfil do contato (GET /connections/{id}/profile/{phone})](https://apiwpp.com/docs/api/contatos/perfil-do-contato.md): Consultar o perfil de um contato ## Templates - [Criar template (POST /connections/{id}/templates)](https://apiwpp.com/docs/api/templates/criar-template.md): Criar um template de mensagem - [Listar templates (GET /connections/{id}/templates)](https://apiwpp.com/docs/api/templates/listar-templates.md): Listar os templates - [Consultar template (GET /connections/{id}/templates/{name})](https://apiwpp.com/docs/api/templates/consultar-template.md): Consultar um template pelo nome - [Atualizar template (PUT /connections/{id}/templates/{name})](https://apiwpp.com/docs/api/templates/atualizar-template.md): Atualizar um template - [Excluir template (DELETE /connections/{id}/templates/{name})](https://apiwpp.com/docs/api/templates/excluir-template.md): Excluir um template ## Chaves de API - [Listar chaves (GET /tenants/{id}/api-keys)](https://apiwpp.com/docs/api/chaves-de-api/listar-chaves.md): Listar as chaves de API de um projeto - [Criar chave (POST /tenants/{id}/api-keys)](https://apiwpp.com/docs/api/chaves-de-api/criar-chave.md): Criar uma chave de API - [Rotacionar chave (POST /tenants/{id}/api-keys/{keyId}/rotate)](https://apiwpp.com/docs/api/chaves-de-api/rotacionar-chave.md): Rotacionar uma chave de API - [Revogar chave (DELETE /tenants/{id}/api-keys/{keyId})](https://apiwpp.com/docs/api/chaves-de-api/revogar-chave.md): Revogar uma chave de API ## Conta - [Quem está chamando (GET /me)](https://apiwpp.com/docs/api/conta/quem-esta-chamando.md): Quem está chamando ## Uso - [Uso do projeto (GET /tenants/{id}/usage)](https://apiwpp.com/docs/api/uso/uso-do-projeto.md): Consultar o uso de um projeto - [Uso diário (GET /usage/daily)](https://apiwpp.com/docs/api/uso/uso-diario.md): Totais diários de mensagens dos projetos de quem chama (de todos, para a plataforma) ## Registros - [Listar mensagens (GET /messages)](https://apiwpp.com/docs/api/registros/listar-mensagens.md): Listar as mensagens registradas - [Entregas de webhook (GET /webhooks/deliveries)](https://apiwpp.com/docs/api/registros/listar-entregas-de-webhook.md): Listar as entregas de webhook - [Reenviar entregas mortas (POST /webhooks/deliveries/resend-dead)](https://apiwpp.com/docs/api/registros/reenviar-entregas-mortas.md): Reenviar todas as entregas de webhook mortas - [Reenviar entrega (POST /webhooks/deliveries/{id}/resend)](https://apiwpp.com/docs/api/registros/reenviar-entrega.md): Reenviar uma entrega de webhook ## Mídia - [Baixar mídia (GET /media/{connectionId}/{fileName})](https://apiwpp.com/docs/api/midia/baixar-midia.md): Baixar um arquivo de mídia ## Webhooks - [Webhooks: visão geral](https://apiwpp.com/docs/webhooks.md): O envelope comum a todos os eventos, os cabeçalhos de cada entrega, as regras de entrega e o catálogo dos 11 eventos que a apiwpp envia. - [connection.status](https://apiwpp.com/docs/webhooks/connection-status.md): A conexão abriu, fechou ou foi restringida - [message.incoming](https://apiwpp.com/docs/webhooks/message-incoming.md): Alguém escreveu para o número - [message.outgoing](https://apiwpp.com/docs/webhooks/message-outgoing.md): O número enviou uma mensagem (opcional: emitOutgoing) - [message.delivery](https://apiwpp.com/docs/webhooks/message-delivery.md): Uma mensagem enviada pelo número mudou de status - [message.send_failed](https://apiwpp.com/docs/webhooks/message-send-failed.md): Um envio na fila com clientRef não vai acontecer - [message.reaction](https://apiwpp.com/docs/webhooks/message-reaction.md): Alguém reagiu a uma mensagem - [contact.resolved](https://apiwpp.com/docs/webhooks/contact-resolved.md): Um remetente conhecido só pelo LID agora tem telefone - [group.joined](https://apiwpp.com/docs/webhooks/group-joined.md): O número entrou num grupo - [group.left](https://apiwpp.com/docs/webhooks/group-left.md): O número foi removido de um grupo - [group.updated](https://apiwpp.com/docs/webhooks/group-updated.md): Um grupo do número mudou - [ping](https://apiwpp.com/docs/webhooks/ping.md): O teste de um endpoint de webhook ## Clientes - [Cliente TypeScript](https://apiwpp.com/docs/clientes/typescript.md): Um cliente tipado da API, gerado da especificação OpenAPI com openapi-typescript e openapi-fetch: instalação, envio, erros e webhooks. - [Cliente PHP](https://apiwpp.com/docs/clientes/php.md): Um cliente PHP da API, gerado da especificação OpenAPI com o OpenAPI Generator sobre Guzzle: instalação, envio, erros e webhooks. ## Atualizações - [Novidades](https://apiwpp.com/docs/novidades.md): As mudanças da API que afetam quem a integra, da mais recente para a mais antiga, e a promessa de compatibilidade.