Comunicações empresariais mais simples
Aplicações móveis e para computadorProgramadoresEstado da IllyVoIPCentro de ajuda

Voice API

A sua lógica.
A sua chamada.
O seu controlo.

Integre voz na sua aplicação. Crie e atenda chamadas, reproduza áudio, recolha respostas e controle o passo seguinte através da API da IllyVoIP.

Conhecer a APIVer um pedido

Os elementos essenciais
de uma experiência de voz.

Utilize ações individuais para controlar a chamada em direto ou execute uma sequência ordenada de ações num único pedido.

Criar e atender

Inicie chamadas ou atenda chamadas recebidas encaminhadas para Voice API Control.

Consultar documentação

Conduzir a conversa

Transfira, coloque em espera, retome, envie DTMF ou termine a chamada conforme a sua aplicação precisar.

Consultar documentação

Uma sequência de ações na prática

Fale.
Ouça.
Decida o passo seguinte.

Este pedido reproduz uma saudação e recolhe uma resposta falada numa chamada existente. A sua aplicação decide como utilizar o resultado.

Autenticação
X-Api-Key
Formato do pedido
application/json
Obrigatório neste endpoint
Idempotency-Key

Substitua os valores de exemplo pelas credenciais do lado do servidor e por uma sessão válida de controlo de chamadas. Reutilize uma chave de idempotência apenas para um pedido idêntico.

Consultar a referência de sequências de ações
Corpo do pedido · JSON
POST/api/v1/voice/call-control/execute
{
  "call_control_id": "YOUR_CALL_CONTROL_ID",
  "actions": [
    {
      "type": "speak",
      "text": "Welcome to our support line."
    },
    {
      "type": "gather",
      "input": "speech",
      "prompt_text": "How can we help?",
      "speech_language": "en-US",
      "timeout_ms": 8000,
      "save_as": "request"
    }
  ]
}

Chamadas recebidas

O seu número.
A resposta da sua aplicação.

Encaminhe um número IllyVoIP para Voice API Control. Subscreva o evento de chamada a tocar, atenda a chamada elegível e utilize o identificador de controlo devolvido nas ações seguintes.

Consultar o guia de chamadas recebidas
Número de telefoneEncaminhamento Voice API Control
Evento de chamada a tocarcall_ringing
A sua aplicaçãoAtender → controlar a chamada

Webhooks

Deixe os eventos de chamadas
dar seguimento ao seu processo.

Receba eventos do ciclo de vida da chamada no endpoint da sua aplicação. Utilize-os para atualizar registos, acompanhar o progresso da chamada ou desencadear a próxima etapa no seu sistema.

Conhecer os webhooks
call_initiatedcall_ringingcall_answeredcall_completed

Verifique as assinaturas, confirme rapidamente a receção e elimine duplicados pelo ID do evento. As novas tentativas de entrega podem repetir um evento.

Escolha como
quer desenvolver.

Utilize o controlo de chamadas para aplicar a lógica da sua aplicação e ligue as restantes ferramentas de que a sua experiência de voz precisa.

Antes da sua
primeira integração.

Pergunte à nossa equipa
A Voice API é o mesmo que um trunk SIP?+

Não. A ligação SIP conecta um sistema telefónico ou uma plataforma. A Voice API disponibiliza operações de controlo que a sua aplicação pode solicitar, como converter texto em fala, recolher respostas e transferir uma chamada.

Permite gerir chamadas recebidas e efetuadas?+

Sim. A documentação inclui a criação de chamadas efetuadas e o atendimento de chamadas recebidas. Para chamadas recebidas, encaminhe um número para Voice API Control e siga o fluxo documentado de evento de chamada a tocar e atendimento.

Posso recolher respostas por voz e teclado?+

Sim. O endpoint gather suporta entrada por fala e DTMF. Consulte a documentação para escolher as opções de entrada, o idioma e o tempo de espera disponíveis para o seu fluxo.

Posso utilizar os serviços de fala fora de uma chamada em curso?+

Sim. A referência da API inclui endpoints autónomos de conversão de fala em texto e de texto em fala. Utilize-os para processos de áudio para texto ou de texto para áudio; dentro de uma chamada, utilize as operações gather e speak da Voice API.

Como são cobradas as funcionalidades de fala?+

O portal publica as tarifas atuais de conversão de fala em texto e de texto em fala. A Voice API utiliza essas tarifas nas operações gather e speak. Consulte as tarifas atuais e os custos de voz aplicáveis à sua configuração.

Onde devo guardar a chave de API?+

Mantenha as chaves de API da conta na aplicação do lado do servidor. As chamadas no navegador utilizam o fluxo documentado de tokens de curta duração do Webphone SDK, sem expor uma chave de API da conta.

Posso explorar antes de ligar a minha aplicação?+

O portal inclui referências de endpoints, exemplos de pedidos e respostas, uma especificação OpenAPI e um API Playground. Os pedidos do Playground podem executar operações reais; reveja o pedido selecionado antes de o executar.

Crie o fluxo de chamadas
de que a sua aplicação precisa.

Comece pela referência dos endpoints e pelos exemplos atuais de pedidos.

Abrir documentação da Voice APIFale com a nossa equipa