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
- Autenticação: crie uma chave de API com os escopos necessários.
-
Crie uma instância e pareie o número (QR Code ou código de pareamento). Veja
Instancesna referência. - Cadastre um webhook e verifique a assinatura de cada entrega.
-
Envie mensagens. O envio é assíncrono: a API responde
202com statusqueued, e o resultado chega comomessage.sent,message.updatedoumessage.failed.
Convenções
- Base:
https://api.conectzap.app/v1. Datas em RFC 3339, UTC. -
Ids públicos opacos e com prefixo:
inst_,msg_,whk_,med_,key_,evt_,dlv_,iev_. -
Telefones em E.164, só dígitos, sem
+(ex.:5511999998888). -
Paginação por cursor (
limitde 1 a 100 ecursor), nunca por offset. -
Operações que criam efeitos aceitam
Idempotency-Key(obrigatória nas de mensagem); a resposta fica guardada por 24 h. -
Erros em
application/problem+json(RFC 9457) comcodeestável. Veja Erros. -
Accept-Languageescolhept-BR(padrão),enouespara os textos de erro. Caminhos, campos,codee enums não mudam com o idioma.
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.