Detalhes técnicos

Introdução

A Voice API da Vonage permite que os desenvolvedores gerenciem chamadas de voz programaticamente por meio de dois modelos complementares:

  • Uma delas é iniciado pelo seu pedido, por meio de chamadas à API REST ou SDKs.
  • O outro é solicitado pelo seu aplicativo pela Vonage, utilizando webhooks e NCCO (Objeto de controle de chamadas da Nexmo — a Nexmo agora é a Vonage) instruções.

Essa abordagem dupla permite um gerenciamento flexível de chamadas para implementar diversos fluxos de chamadas e casos de uso de voz programáveis, desde notificações simples até fluxos sofisticados de centrais de atendimento e integração com IA.

Além disso, a Voice API da Vonage permite:

  • Crie aplicativos que se adaptem às tecnologias da web que você já utiliza.
  • Controle o fluxo de chamadas recebidas e realizadas em JSON com o NCCO.
  • Gravar e armazenar chamadas recebidas ou realizadas.
  • Criar teleconferências.
  • Envie mensagens com conversão de texto em fala em 40 idiomas, com diferentes gêneros e sotaques.

Índice

Neste documento, você poderá conhecer:

Introdução

Para conhecer todas as etapas necessárias para começar a utilizar a Voice API da Vonage, consulte o Introdução guia.

Iniciando uma chamada de voz

Para iniciar uma chamada de voz a partir do seu aplicativo de back-end, use o endpoint HTTP:

POST /calls

Este método inicia uma chamada de saída para um número de telefone ou terminal SIP. Você pode utilizá-lo diretamente via HTTP ou por meio de qualquer SDKs do servidor Vonage.

Veja o Fazer uma ligação trecho de código para saber mais sobre como iniciar chamadas de saída.

Quando a chamada é estabelecida, a Vonage solicita instruções (na forma de um NCCO) do seu webhook ou URL estático para determinar como a chamada deve prosseguir.

Instruções para chamadas com os NCCOs

Um NCCO (Objeto de Controle de Chamada da Nexmo) é uma estrutura baseada em JSON que define o que deve acontecer durante uma chamada. Você deve retorná-la em resposta à solicitação de webhook da Vonage quando a chamada for estabelecida.

As ações comuns da NCCO incluem:

  • talk – Converter texto em voz e reproduzi-lo para quem está ligando
  • stream – Reproduzir um arquivo de áudio
  • record – Gravar o áudio da ligação
  • connect – Conectar outro participante à conversa

Você pode encontrar a lista completa de comandos do NCCO no Referência NCCO.

Como controlar uma chamada ativa

Quando uma chamada estiver em andamento, você também poderá controlá-la dinamicamente por meio de endpoints da API REST:

  • PUT /calls/{uuid} – Atualizar o status da chamada (por exemplo, desligar, transferir, silenciar)
  • PUT /talk e DELETE /talk – Iniciar ou interromper a conversão de texto em fala durante a ligação
  • PUT /talk e DELETE /stream – Iniciar ou interromper a reprodução de um arquivo de áudio

Essas ações permitem que você modifique o comportamento da chamada em tempo real, com base nas ações do usuário e na lógica do seu aplicativo.

Veja o Referência da Voice API para obter uma lista completa dos endpoints da API REST.

Leitura complementar