ConectZap · Documentação

Documentação da API do ConectZap

O ConectZap mantém sessões do WhatsApp Web ativas e conecta o seu chatbot, ERP ou CRM por uma API REST. É uma API de passagem: o ConectZap não guarda conversas. O que chega ao número (mensagens, status de entrega, eventos de conexão) é entregue ao seu sistema por webhook ou pelo tempo real, e o seu sistema é o registro das conversas.

O runtime atual usa um cliente não oficial do WhatsApp Web. Recursos podem mudar sem aviso por decisão da Meta.

Comece por aqui

  1. Autenticação: crie uma chave de API com os escopos necessários.
  2. Crie uma instância e pareie o número (QR Code ou código de pareamento). Veja Instances na referência.
  3. Cadastre um webhook e verifique a assinatura de cada entrega.
  4. Envie mensagens. O envio é assíncrono: a API responde 202 com status queued, e o resultado chega como message.sent, message.updated ou message.failed.

Convenções

Referência

A referência da API é gerada do contrato OpenAPI 3.1, que também está disponível para download em openapi.yaml (para gerar clientes ou importar em ferramentas). Enquanto a versão for 1.0.0-draft.*, o contrato pode mudar.