CodeChat APIv1.0.0
ChangelogPostman
Guias/Documentação da CodeChat API
Documentação

Documentação da CodeChat API

Contrato, guias e referência técnica da API.

Esta pasta descreve o contrato observado no código executável atual. A referência de máquina é o OpenAPI 3.1; os guias abaixo explicam autenticação, validações, respostas e particularidades operacionais.

Comece aqui

  1. Autenticação: token global, token da instância, token de usuário e regras de correspondência.
  2. Instâncias: criação, listagem, consulta, rotação de token e exclusão.
  3. Conexões: QR Code, pairing code, passkey, estado e logout.
  4. Mensagens: mensagens comuns, fila assíncrona e opções compartilhadas.
  5. Envio em lote: recurso Pro com fila persistente, múltiplas instâncias, recovery e progresso.
  6. Chats: conta WhatsApp, leitura, arquivo, edição e exclusão.
  7. Mídia: download de mídia e upload antecipado.
  8. Grupos: criação, participantes, convite, foto e saída.
  9. Webhooks: configuração, eventos, envelopes e entrega.
  10. WebSocket: eventos em tempo real por instancia e por dono de lote.

CodeChat API Go Pro

  • Endpoints Pro: pagamento, PIX, revisão de pedido, formulário, mensagens interativas e Message Batch.

Pro é uma classificação comercial solicitada para a documentação. O código auditado não possui claim, middleware, tabela ou feature flag de plano e não retorna 402 Payment Required. Os recursos Pro por instância usam o JWT da instância; Message Batch usa JWT de usuário com userId em formato UUID. O OpenAPI registra x-codechat-plan: pro e x-codechat-plan-enforced: false para não confundir classificação com bloqueio executável.

Compatibilidade

Convenções

  • A base URL local padrão é http://localhost:8084.
  • Nas rotas atuais, {instance} é o nome público da instância.
  • Nas rotas legadas, {instanceName} tem a mesma finalidade.
  • Parâmetros são mostrados com chaves no OpenAPI e com :param em exemplos de rotas.
  • Campos JSON desconhecidos são rejeitados nos handlers que usam decodificação estrita; as exceções estão destacadas nos guias.
  • Endpoints legados só usam deprecated: true no OpenAPI quando existe substituto atual equivalente.