Quick Start

​

Em poucas palavras

• Contrate um número ACTIVE, é a linha de origem (from).
• Origine com from, to e o que falar ao atender (speak, áudio ou gather).
• Acompanhe e controle pela API ou webhooks (voice.call.*).

​

Antes de começar

• Número ACTIVE no workspace
• Chave com voice:call (e voice:read / voice:control conforme o fluxo)
• Saldo ou créditos disponíveis
• Autenticação: Authorization: Bearer sk_live_... ou x-api-key
• Base URL: https://api.notifique.dev
• Destinos em E.164 com + (ex.: +5511999887766)

​

1. Originar uma chamada

​

1A, Pelo painel

1. Voz → Nova chamada
2. Selecione o número de origem e o destino
3. Defina o prompt (TTS ou áudio) e dispare

​

1B, Pela API

POST /v1/voice/calls
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "from": "+5511987654321",
  "to": ["+5511999887766"],
  "type": "speak",
  "payload": {
    "text": "Olá! Esta é uma ligação de teste do Notifique.",
    "voice": "female-natural"
  },
  "clientState": "campanha-verificacao-42"
}

{
  "success": true,
  "data": {
    "id": "clvoice1...",
    "direction": "OUTBOUND",
    "fromE164": "+5511987654321",
    "toE164": "+5511999887766",
    "status": "QUEUED",
    "clientState": "campanha-verificacao-42",
    "createdAt": "2025-02-15T10:00:00.000Z"
  }
}

• type: "play", tocar áudio por URL: payload.audioUrl
• type: "gather", coletar DTMF: payload.gather com prompt, maxDigits, timeoutSecs
• type: "template", template do workspace: payload.templateId + variables opcionais
• record: true, gravar a ligação
• machineDetection: "detect", detectar caixa postal

​

2. Listar e consultar

GET /v1/voice/calls?page=1&limit=20&direction=OUTBOUND
Authorization: Bearer sk_live_xxxxx

GET /v1/voice/calls/:id?includeEvents=true
Authorization: Bearer sk_live_xxxxx

​

3. Controlar chamada ativa

POST /v1/voice/calls/clvoice1.../actions/speak
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "text": "Pressione 1 para vendas ou 2 para suporte.",
  "voice": "female-natural"
}

​

4. Baixar gravação

GET /v1/voice/calls/:id/recordings/:recordingId/download
Authorization: Bearer sk_live_xxxxx

​

5. Chamadas recebidas (inbound)

1. Configure inboundVoiceAction no número, Números de Telefone
2. Com WEBHOOK_CONTROL, receba voice.call.received e controle pela API
3. Com FORWARD, encaminhe para forwardToE164
4. Com TTS_HANGUP, fale o texto configurado e encerre

​

6. Webhooks (opcional)

​

Vozes TTS

​

Todos os tipos de envio

​

Próximos passos

• Introdução: quando usar e ciclo da chamada
• Escopos: permissões da chave
• Eventos dos webhooks: status em tempo real
• Cobrança: custo por minuto