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.

O Cawme suporta quatro tipos de chamada, cada um adequado para diferentes casos de uso. Defina o campo type ao criar uma chamada.

​
FIXED_TTS

Converte texto em fala e reproduz durante a chamada. O tipo mais simples — basta fornecer uma mensagem e uma voz. 
{
  "instanceId": "inst_abc123",
  "type": "FIXED_TTS",
  "target": { "phoneNumber": "+14155550123" },
  "tts": {
    "text": "Olá João, sua consulta está confirmada para amanhã às 14h.",
    "voiceId": "pt-BR-001"
  }
}
Casos de uso: Notificações de pedidos, lembretes de consultas, alertas de pagamento, comunicados unidirecionais.

​
FIXED_AUDIO

Reproduz um arquivo de áudio pré-gravado (MP3 ou WAV em Base64). Ideal quando você precisa de uma mensagem de voz polida e com identidade de marca. 
{
  "instanceId": "inst_abc123",
  "type": "FIXED_AUDIO",
  "target": { "phoneNumber": "+14155550123" },
  "audio": {
    "audioBase64": "SUQzBAAAAAAA..."
  }
}
Casos de uso: Campanhas de marketing, comunicados institucionais, gravações de conformidade.

​
DYNAMIC_STREAM

Transmite frames de áudio PCM ou MP3 em tempo real via WebSocket. Use quando precisar de controle total sobre o pipeline de áudio — conecte seu próprio TTS, camada de tradução ou um atendente humano ao vivo. 
{
  "instanceId": "inst_abc123",
  "type": "DYNAMIC_STREAM",
  "target": { "phoneNumber": "+14155550123" }
}
Após criar a chamada, estabeleça uma conexão WebSocket em GET /v1/calls/:callId/stream:
  • Cliente → Servidor: Envie frames de áudio PCM ou MP3
  • Servidor → Cliente: Receba transcrições em tempo real e eventos da chamada
Casos de uso: Chamadas com assistência de agente ao vivo, bots de voz personalizados, tradução em tempo real.
O streaming via WebSocket está atualmente em preview. Consulte o endpoint de Stream para mais detalhes.

​
DYNAMIC_AGENT

Implanta um agente de IA que conduz a chamada de forma autônoma com base em instruções em linguagem natural. O agente gerencia todo o fluxo da conversa sem intervenção manual. 
{
  "instanceId": "inst_abc123",
  "type": "DYNAMIC_AGENT",
  "target": { "phoneNumber": "+14155550123" },
  "agent": {
    "instructions": [
      "Cumprimente a pessoa educadamente",
      "Pergunte se ela tem interesse em uma demonstração do produto",
      "Se sim, colete a data e horário de preferência",
      "Confirme o agendamento antes de encerrar a chamada"
    ]
  }
}
Casos de uso: Prospecção de vendas, agendamento de consultas, pesquisas com clientes, qualificação de leads.

​
Comparativo

FuncionalidadeFIXED_TTSFIXED_AUDIODYNAMIC_STREAMDYNAMIC_AGENT
Mensagem pré-escrita✓✓——
Arquivo de áudio personalizado—✓——
Controle de áudio em tempo real——✓—
Conversa conduzida por IA———✓
Requer WebSocket——✓—

Iniciar uma chamada

POST /v1/calls — referência completa da requisição