Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cawme.com.br/llms.txt

Use this file to discover all available pages before exploring further.

URL base

https://cawme.com/api/v1
Um ambiente sandbox está disponível para testes:
https://sandbox.cawme.com/api/v1

Autenticação

Todos os endpoints exigem um Bearer token:
Authorization: Bearer <seu-clerk-token>
Consulte o guia de Autenticação para mais detalhes.

Formato das requisições

  • Todos os corpos de requisição usam Content-Type: application/json
  • Todos os timestamps são ISO 8601 em UTC (ex.: 2026-03-01T10:00:00Z)
  • Os IDs são strings com prefixo: inst_<hex> para instâncias, call_<hex> para chamadas

Códigos de resposta

CódigoSignificado
200OK
201Recurso criado
204Sem conteúdo (delete ou terminate bem-sucedido)
400Requisição inválida — campos ausentes ou incorretos
401Não autorizado — token ausente ou inválido
403Proibido — token válido, mas sem permissão de acesso
404Recurso não encontrado
501Ainda não implementado

Idempotência

Se você criar uma chamada para uma instância que já possui uma chamada ativa (QUEUED, RINGING ou IN_PROGRESS), a API retorna a chamada existente com status 200 em vez de criar uma duplicata. Isso protege contra envios duplicados causados por retentativas de rede ou pelo React Strict Mode.

Limites de taxa (Rate Limiting)

Requisições com token demo são limitadas por IP. Requisições autenticadas seguem limites padrão de uso justo.

Recursos

Instâncias

Crie e gerencie instâncias do WhatsApp.

Chamadas

Inicie e gerencie chamadas de saída.