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.
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, abstraindo os JIDs internos do WhatsApp:
  • phone é só o número da pessoa — nunca ...@s.whatsapp.net.
  • id é o valor exato que a API te devolve (em GET /groups, GET /communities, GET /newsletters). Ele é opaco: pode parecer ...@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 (pessoa) ou o id de um grupo. A resposta traz { messageId } — guarde-o 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 e Eventos.