Visão geral da 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.
O endereço base da API é https://api.apiwpp.com. As requisições e as respostas são JSON: envie Content-Type: application/json nas requisições com corpo.
Autenticação. Toda operação recebe uma chave de API (wag_live_…), como Authorization: Bearer <chave> ou X-Api-Key: <chave>. A chave pertence a um projeto e só alcança os recursos dele. Cada operação indica o escopo de que a chave precisa (veja Escopos); só o download de mídia dispensa a chave, porque a URL assinada é a credencial. Detalhes em Autenticação.
Erros respondem { "error": "…" } com o status HTTP; alguns acrescentam code (como number_limit_reached) e message, e a validação do corpo responde 400 com code: "FST_ERR_VALIDATION". Decida pelo status e pelo code, nunca pelo texto. 401 é chave ausente, desconhecida, revogada ou expirada; 403 é permissão que falta (um escopo, citado na mensagem, ou um recurso do plano); um recurso de outra pessoa responde 404, exatamente como um que não existe. Veja Erros e Códigos de erro.
Limites. Por padrão, cada IP de origem faz até 600 requisições por minuto, e, depois de 20 chaves erradas em 5 minutos, as próximas chaves erradas desse IP também recebem 429 (a chave certa continua aceita); os dois limites respondem com Retry-After. Os envios entram numa fila com ritmo controlado por número: POST /connections/{id}/send responde 202 com o job. Todos os números estão em Limites.
Listas. Os registros (GET /messages e GET /webhooks/deliveries) devolvem os itens mais recentes primeiro, sem paginação por cursor: limit vale 60 por padrão e no máximo 200.
Conexões
- POSTCriar conexão
/connectionsCriar uma conexão de WhatsApp - GETQR code e status
/connections/{id}/qrObter o QR code e o status da conexão - POSTCódigo de pareamento
/connections/{id}/pairing-codeObter um código de pareamento para conectar um número sem o QR code - POSTDesconectar
/connections/{id}/disconnectDesconectar uma conexão do WhatsApp - GETListar conexões
/connectionsListar conexões - POSTSair do WhatsApp
/connections/{id}/logoutSair do WhatsApp (logout) - GETListar grupos
/connections/{id}/groupsListar grupos - GETConsultar proxy
/connections/{id}/proxyObter o proxy de uma conexão - PUTDefinir proxy
/connections/{id}/proxyDefinir o proxy de uma conexão - DELETERemover proxy
/connections/{id}/proxyRemover o proxy de uma conexão - GETIP dedicado
/connections/{id}/dedicated-ipObter o IP dedicado de uma conexão
Mensagens
- POSTEnviar mensagem
/connections/{id}/sendEnfileirar uma mensagem para envio - GETFila do número
/connections/{id}/queueConsultar a fila de uma conexão - POSTReagir
/connections/{id}/reactReagir a uma mensagem - POSTEditar mensagemPRO
/connections/{id}/messages/{messageId}/editEditar uma mensagem enviada - DELETECancelar da fila
/connections/{id}/queue/{jobId}Cancelar uma mensagem na fila - DELETEApagar mensagemPRO
/connections/{id}/messages/{messageId}Apagar uma mensagem enviada para todos - POSTMarcar como lidasPRO
/connections/{id}/readMarcar mensagens recebidas como lidas - POSTMostrar presençaPRO
/connections/{id}/presenceMostrar uma presença em uma conversa
Projetos
- PATCHAtualizar projeto
/tenants/{id}Atualizar um projeto - GETListar projetos
/tenantsListar projetos - GETConsultar projeto
/tenants/{id}Consultar um projeto - DELETEDesativar projeto
/tenants/{id}Desativar um projeto - POSTTestar webhook
/tenants/webhook-testTestar um endpoint de webhook - GETConexões do projeto
/tenants/{id}/connectionsListar as conexões de um projeto - POSTCriar conexão no projeto
/tenants/{id}/connectionsCriar uma conexão no projeto - GETConsultar conexão
/tenants/{id}/connections/{connId}Consultar uma conexão - DELETEExcluir conexão
/tenants/{id}/connections/{connId}Excluir uma conexão - GETHistórico de heartbeats
/tenants/{id}/connections/{connId}/heartbeatsHistórico de heartbeats da conexão - GETQR code como imagem
/tenants/{id}/connections/{connId}/qrObter o QR code como imagem - POSTDesconectar conexão
/tenants/{id}/connections/{connId}/disconnectDesconectar uma conexão - POSTReconectar conexão
/tenants/{id}/connections/{connId}/connectConectar de novo uma conexão
Contatos
Templates
- POSTCriar template
/connections/{id}/templatesCriar um template de mensagem - GETListar templates
/connections/{id}/templatesListar os templates - GETConsultar template
/connections/{id}/templates/{name}Consultar um template pelo nome - PUTAtualizar template
/connections/{id}/templates/{name}Atualizar um template - DELETEExcluir template
/connections/{id}/templates/{name}Excluir um template
Chaves de API
Conta
Uso
Registros
- GETListar mensagens
/messagesListar as mensagens registradas - GETEntregas de webhook
/webhooks/deliveriesListar as entregas de webhook - POSTReenviar entregas mortas
/webhooks/deliveries/resend-deadReenviar todas as entregas de webhook mortas - POSTReenviar entrega
/webhooks/deliveries/{id}/resendReenviar uma entrega de webhook
Mídia
Webhooks
Os eventos chegam por POST ao webhookBaseUrl do projeto.
connection.statusA conexão abriu, fechou ou foi restringidamessage.incomingAlguém escreveu para o númeromessage.outgoingO número enviou uma mensagem (opcional: emitOutgoing)message.deliveryUma mensagem enviada pelo número mudou de statusmessage.send_failedUm envio na fila com clientRef não vai acontecermessage.reactionAlguém reagiu a uma mensagemcontact.resolvedUm remetente conhecido só pelo LID agora tem telefonegroup.joinedO número entrou num grupogroup.leftO número foi removido de um grupogroup.updatedUm grupo do número mudoupingO teste de um endpoint de webhook