# Documentação da apiwpp

Fonte: https://apiwpp.com/docs
Seção: Começando
Atualizado em: 2026-09-29

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.

## Começando

- [Início rápido](https://apiwpp.com/docs/inicio-rapido): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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](https://apiwpp.com/docs/api/conexoes/criar-conexao): Criar uma conexão de WhatsApp
- [QR code e status](https://apiwpp.com/docs/api/conexoes/qr-code-e-status): Obter o QR code e o status da conexão
- [Código de pareamento](https://apiwpp.com/docs/api/conexoes/codigo-de-pareamento): Obter um código de pareamento para conectar um número sem o QR code
- [Desconectar](https://apiwpp.com/docs/api/conexoes/desconectar): Desconectar uma conexão do WhatsApp
- [Listar conexões](https://apiwpp.com/docs/api/conexoes/listar-conexoes): Listar conexões
- [Sair do WhatsApp](https://apiwpp.com/docs/api/conexoes/sair-do-whatsapp): Sair do WhatsApp (logout)
- [Listar grupos](https://apiwpp.com/docs/api/conexoes/listar-grupos): Listar grupos
- [Consultar proxy](https://apiwpp.com/docs/api/conexoes/consultar-proxy): Obter o proxy de uma conexão
- [Definir proxy](https://apiwpp.com/docs/api/conexoes/definir-proxy): Definir o proxy de uma conexão
- [Remover proxy](https://apiwpp.com/docs/api/conexoes/remover-proxy): Remover o proxy de uma conexão
- [IP dedicado](https://apiwpp.com/docs/api/conexoes/ip-dedicado): Obter o IP dedicado de uma conexão

## Mensagens

- [Enviar mensagem](https://apiwpp.com/docs/api/mensagens/enviar-mensagem): Enfileirar uma mensagem para envio
- [Fila do número](https://apiwpp.com/docs/api/mensagens/fila-do-numero): Consultar a fila de uma conexão
- [Reagir](https://apiwpp.com/docs/api/mensagens/reagir): Reagir a uma mensagem
- [Editar mensagem](https://apiwpp.com/docs/api/mensagens/editar-mensagem): Editar uma mensagem enviada
- [Cancelar da fila](https://apiwpp.com/docs/api/mensagens/cancelar-mensagem-na-fila): Cancelar uma mensagem na fila
- [Apagar mensagem](https://apiwpp.com/docs/api/mensagens/apagar-mensagem): Apagar uma mensagem enviada para todos
- [Marcar como lidas](https://apiwpp.com/docs/api/mensagens/marcar-como-lidas): Marcar mensagens recebidas como lidas
- [Mostrar presença](https://apiwpp.com/docs/api/mensagens/mostrar-presenca): Mostrar uma presença em uma conversa

## Projetos

- [Atualizar projeto](https://apiwpp.com/docs/api/projetos/atualizar-projeto): Atualizar um projeto
- [Listar projetos](https://apiwpp.com/docs/api/projetos/listar-projetos): Listar projetos
- [Consultar projeto](https://apiwpp.com/docs/api/projetos/consultar-projeto): Consultar um projeto
- [Desativar projeto](https://apiwpp.com/docs/api/projetos/desativar-projeto): Desativar um projeto
- [Testar webhook](https://apiwpp.com/docs/api/projetos/testar-webhook): Testar um endpoint de webhook
- [Conexões do projeto](https://apiwpp.com/docs/api/projetos/listar-conexoes-do-projeto): Listar as conexões de um projeto
- [Criar conexão no projeto](https://apiwpp.com/docs/api/projetos/criar-conexao-no-projeto): Criar uma conexão no projeto
- [Consultar conexão](https://apiwpp.com/docs/api/projetos/consultar-conexao): Consultar uma conexão
- [Excluir conexão](https://apiwpp.com/docs/api/projetos/excluir-conexao): Excluir uma conexão
- [Histórico de heartbeats](https://apiwpp.com/docs/api/projetos/historico-de-heartbeats): Histórico de heartbeats da conexão
- [QR code como imagem](https://apiwpp.com/docs/api/projetos/qr-code-como-imagem): Obter o QR code como imagem
- [Desconectar conexão](https://apiwpp.com/docs/api/projetos/desconectar-conexao-do-projeto): Desconectar uma conexão
- [Reconectar conexão](https://apiwpp.com/docs/api/projetos/reconectar-conexao): Conectar de novo uma conexão

## Contatos

- [Verificar números](https://apiwpp.com/docs/api/contatos/verificar-numeros): Verificar se números estão no WhatsApp
- [Perfil do contato](https://apiwpp.com/docs/api/contatos/perfil-do-contato): Consultar o perfil de um contato

## Templates

- [Criar template](https://apiwpp.com/docs/api/templates/criar-template): Criar um template de mensagem
- [Listar templates](https://apiwpp.com/docs/api/templates/listar-templates): Listar os templates
- [Consultar template](https://apiwpp.com/docs/api/templates/consultar-template): Consultar um template pelo nome
- [Atualizar template](https://apiwpp.com/docs/api/templates/atualizar-template): Atualizar um template
- [Excluir template](https://apiwpp.com/docs/api/templates/excluir-template): Excluir um template

## Chaves de API

- [Listar chaves](https://apiwpp.com/docs/api/chaves-de-api/listar-chaves): Listar as chaves de API de um projeto
- [Criar chave](https://apiwpp.com/docs/api/chaves-de-api/criar-chave): Criar uma chave de API
- [Rotacionar chave](https://apiwpp.com/docs/api/chaves-de-api/rotacionar-chave): Rotacionar uma chave de API
- [Revogar chave](https://apiwpp.com/docs/api/chaves-de-api/revogar-chave): Revogar uma chave de API

## Conta

- [Quem está chamando](https://apiwpp.com/docs/api/conta/quem-esta-chamando): Quem está chamando

## Uso

- [Uso do projeto](https://apiwpp.com/docs/api/uso/uso-do-projeto): Consultar o uso de um projeto
- [Uso diário](https://apiwpp.com/docs/api/uso/uso-diario): Totais diários de mensagens dos projetos de quem chama (de todos, para a plataforma)

## Registros

- [Listar mensagens](https://apiwpp.com/docs/api/registros/listar-mensagens): Listar as mensagens registradas
- [Entregas de webhook](https://apiwpp.com/docs/api/registros/listar-entregas-de-webhook): Listar as entregas de webhook
- [Reenviar entregas mortas](https://apiwpp.com/docs/api/registros/reenviar-entregas-mortas): Reenviar todas as entregas de webhook mortas
- [Reenviar entrega](https://apiwpp.com/docs/api/registros/reenviar-entrega): Reenviar uma entrega de webhook

## Mídia

- [Baixar mídia](https://apiwpp.com/docs/api/midia/baixar-midia): Baixar um arquivo de mídia

## Webhooks

- [Webhooks: visão geral](https://apiwpp.com/docs/webhooks): 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): A conexão abriu, fechou ou foi restringida
- [message.incoming](https://apiwpp.com/docs/webhooks/message-incoming): Alguém escreveu para o número
- [message.outgoing](https://apiwpp.com/docs/webhooks/message-outgoing): O número enviou uma mensagem (opcional: emitOutgoing)
- [message.delivery](https://apiwpp.com/docs/webhooks/message-delivery): Uma mensagem enviada pelo número mudou de status
- [message.send_failed](https://apiwpp.com/docs/webhooks/message-send-failed): Um envio na fila com clientRef não vai acontecer
- [message.reaction](https://apiwpp.com/docs/webhooks/message-reaction): Alguém reagiu a uma mensagem
- [contact.resolved](https://apiwpp.com/docs/webhooks/contact-resolved): Um remetente conhecido só pelo LID agora tem telefone
- [group.joined](https://apiwpp.com/docs/webhooks/group-joined): O número entrou num grupo
- [group.left](https://apiwpp.com/docs/webhooks/group-left): O número foi removido de um grupo
- [group.updated](https://apiwpp.com/docs/webhooks/group-updated): Um grupo do número mudou
- [ping](https://apiwpp.com/docs/webhooks/ping): O teste de um endpoint de webhook

## Clientes

- [Cliente TypeScript](https://apiwpp.com/docs/clientes/typescript): 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): 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): As mudanças da API que afetam quem a integra, da mais recente para a mais antiga, e a promessa de compatibilidade.
