Voice API

Voice API — Chamadas Inteligentes e IVR

Faça chamadas de voz, implemente IVR (Interactive Voice Response), transfira chamadas automaticamente e grave conversas. Suporte a TTS (Text-to-Speech), reconhecimento de voz e webhooks em tempo real.

Introdução

A Voice API da Yup Chat permite que você faça chamadas de voz programáticas, implemente sistemas de IVR (Interactive Voice Response) inteligentes, transfira chamadas automaticamente e grave conversas para análise posterior. Com suporte a TTS (Text-to-Speech) em múltiplos idiomas, reconhecimento de voz e webhooks em tempo real, você pode criar experiências de voz completas e automatizadas.

Chamadas de Voz HD

Faça chamadas de voz com qualidade HD para qualquer número nacional ou internacional.

IVR Inteligente

Crie fluxos de IVR com menus, transferências e lógica customizada para atendimento automatizado.

Text-to-Speech

Converta texto em fala natural com múltiplas vozes e idiomas disponíveis.

Gravação e Análise

Grave chamadas e analise com transcrição automática para insights de qualidade.

Autenticação

HTTP Basic Authentication

A Voice API utiliza autenticação HTTP Basic com seu ID e Token. Você deve enviar suas credenciais codificadas em Base64 no header Authorization.

Authorization: Basic <base64(ID:TOKEN)>

Exemplo: Se seu ID é "user123" e seu Token é "token456", você codifica "user123:token456" em Base64, resultando em "dXNlcjEyMzp0b2tlbjQ1Ng==".

Dica: Obtenha suas credenciais em "Informações da conta" no Dashboard da Yup Chat.

Exemplo de Autenticação

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/voice/calls/call_123

Base URL

Todos os endpoints da Voice API são acessados através da seguinte URL base:

https://api.yup.chat/v1/

Todos os exemplos de endpoints nesta documentação devem ser prefixados com esta URL base. Por exemplo, o endpoint POST /voice/calls completo seria: https://api.yup.chat/v1/voice/calls

Endpoints

POST/voice/calls

Inicia uma chamada de voz para um número específico com suporte a TTS e IVR.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`to`	String	Sim	Número de telefone do destinatário (formato E.164)
`from`	String	Sim	Número de telefone de origem (deve ser verificado)
`message`	String	Não	Mensagem a ser falada via TTS
`record`	Boolean	Não	Habilitar gravação da chamada
`language`	String	Não	Idioma do TTS (ex: pt-BR, en-US, es-ES)

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/voice/calls \
  -u 'SEU_ID:SEU_TOKEN' \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999999999",
    "from": "5511988888888",
    "message": "Olá! Esta é uma chamada de teste.",
    "tts_enabled": true,
    "language": "pt-BR",
    "record": true
  }'

Exemplo de Resposta (200 OK)

{
  "id": "call_1234567890abcdef",
  "status": "initiated",
  "to": "5511999999999",
  "from": "5511988888888",
  "timestamp": "2024-01-19T10:30:00Z",
  "duration": 0,
  "recording_enabled": true,
  "recording_url": null,
  "failed_reason": null
}

GET/voice/calls/:id

Consulta o status e detalhes de uma chamada realizada.

Parâmetros

Parâmetro	Tipo	Descrição
`id`	String	ID único da chamada

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/voice/calls/call_1234567890abcdef

Exemplo de Resposta (200 OK)

{
  "id": "call_1234567890abcdef",
  "status": "completed",
  "to": "5511999999999",
  "from": "5511988888888",
  "timestamp": "2024-01-19T10:30:00Z",
  "duration": 45,
  "recording_enabled": true,
  "recording_url": "https://storage.yup.chat/recordings/call_123.mp3",
  "transcription": "Olá, como posso ajudar?"
}

Status Retornados

Initiated

A chamada foi iniciada e está aguardando conexão com o destinatário.

Ringing

O telefone do destinatário está tocando, aguardando atendimento.

In Progress

A chamada foi atendida e está em andamento.

Completed

A chamada foi encerrada com sucesso após conversa.

No Answer

O destinatário não atendeu a chamada dentro do tempo limite.

Failed

A chamada falhou (número inválido, ocupado ou bloqueado).

Recursos Principais

Chamadas de Voz HD

Faça chamadas de voz para qualquer número com qualidade HD

IVR Inteligente

Crie fluxos de IVR com menus, transferências e lógica customizada

Text-to-Speech

Converta texto em fala natural com múltiplas vozes e idiomas

Reconhecimento de Voz

Capture entrada de voz do usuário com reconhecimento de dígitos

Transferência de Chamadas

Transfira chamadas automaticamente para agentes ou números específicos

Gravação e Análise

Grave chamadas e analise com transcrição automática

Casos de Uso

Confirmação de Pedidos

Ligue automaticamente para confirmar pedidos e entregas

Lembretes de Consultas

Envie lembretes de voz para consultas e compromissos

Pesquisas por Telefone

Realize pesquisas de satisfação via chamadas automatizadas

Atendimento 24/7

IVR inteligente para atendimento fora do horário comercial

Verificação de Identidade

Confirme identidade via chamada com código de verificação

Alertas de Emergência

Notifique equipes rapidamente via chamadas de voz

Pronto para Começar?

Integre a Voice API em minutos e comece a fazer chamadas inteligentes.