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.

​
Pré-requisitos

​
Passo 1: Criar uma instância

Uma instância representa um número de WhatsApp. Você precisa criar uma antes de realizar qualquer chamada. 
curl -X POST https://cawme.com/api/v1/instances \
  -H "Authorization: Bearer <seu-token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "minha-primeira-instancia"}'

{
  "id": "inst_abc123",
  "name": "minha-primeira-instancia",
  "status": "CREATED",
  "created_at": "2026-03-01T10:00:00Z"
}

​
Passo 2: Vincular seu número de WhatsApp

Obtenha o QR code e escaneie com o WhatsApp no seu celular para vincular o número: 
curl https://cawme.com/api/v1/instances/inst_abc123/configure \
  -H "Authorization: Bearer <seu-token>"

{
  "instanceId": "inst_abc123",
  "qrCodeBase64": "iVBORw0KGgoAAAANSUhEUgAA..."
}
Decodifique qrCodeBase64 em uma imagem e escaneie. Após escanear, o status da instância avançará para CONFIGURED e depois para ACTIVE.

​
Passo 3: Realizar uma chamada

Faça uma chamada Text-to-Speech (TTS): 
curl -X POST https://cawme.com/api/v1/calls \
  -H "Authorization: Bearer <seu-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceId": "inst_abc123",
    "type": "FIXED_TTS",
    "target": { "phoneNumber": "+14155550123" },
    "tts": {
      "text": "Olá, esta é uma ligação da ACME Corp.",
      "voiceId": "pt-BR-001"
    }
  }'

{
  "id": "call_xyz789",
  "type": "FIXED_TTS",
  "status": "QUEUED"
}

​
Passo 4: Verificar o status da chamada

curl https://cawme.com/api/v1/calls/call_xyz789 \
  -H "Authorization: Bearer <seu-token>"
O campo status avança assim: QUEUED → RINGING → IN_PROGRESS → COMPLETED.

​
Próximos passos

Tipos de Chamada

Conheça FIXED_AUDIO, DYNAMIC_STREAM e DYNAMIC_AGENT.

Referência da API

Referência completa de todos os endpoints.