Skip to main content
A API da Zapfy é REST sobre HTTPS. Você envia mensagens e gerencia instâncias e webhooks por uma superfície única — a conexão com o WhatsApp fica abstraída. Base URL

​
Autenticação

Tudo via Authorization: Bearer <token>. Há dois tokens, cada um com seu escopo:

Token de conta

Prefixo zpfy_acct_. Gerencia instâncias e webhooks (criar, listar, editar, remover).

Token de instância

Prefixo zpfy_inst_. Envia mensagens por um número específico.

​
Obtendo o token de conta

No painel, abra API & Tokens → Token da conta e clique em gerar novo.
O token aparece uma única vez, no momento em que é gerado — copie e guarde num gerenciador de segredos ou numa variável de ambiente. Gerar um novo token revoga o anterior na hora: toda integração que ainda usa o token antigo passa a receber 401 até ser atualizada.
Cada endpoint indica qual token usar no seletor Authorization do playground à direita. Mensagens usam o token de instância; instâncias e webhooks, o de conta.

​
Identificadores

A Zapfy usa dois identificadores:
  • phone é só o número. Use para escrever para alguém pela primeira vez e para casar pessoas com os números do seu sistema.
  • id é o valor exato que a Zapfy te devolve: chat.id e sender.id nos webhooks, e o id de GET /groups, GET /communities e GET /newsletters. Ele é opaco — pode parecer ...@s.whatsapp.net ou ...@lid (pessoa), ...@g.us (grupo/comunidade) ou ...@newsletter (canal). Use como veio; não reconstrua nem derive de um telefone.
No envio, o destinatário vai no campo to, que aceita um phone ou um id. Para responder a um evento, envie para o chat.id dele. O envio responde 202 com { messageId } e acontece em seguida; o resultado chega por webhook. Guarde o messageId pra reusar nas ações sobre a mensagem (status, reação, delete, edit).

​
Webhooks

Eventos inbound (mensagem recebida, status, conexão) chegam nos webhooks que você cadastrar — uma URL, vários eventos. Veja Configuração, Eventos e Tratando eventos.