Voice API
Crie e controle chamadas com fala, reprodução de áudio, entrada pelo teclado e transferências.
Conhecer a voz programávelIllyVoIP para programadores
Integre voz, mensagens e gestão de números no seu software. Utilize APIs do lado do servidor nos seus processos e o Webphone SDK para chamadas na interface do navegador.
# Exemplo de pedido do lado do servidor
curl -X GET \
"https://api.illyvoip.com/api/v1/sip/identities" \
-H "X-Api-Key: YOUR_API_KEY"Comece por um serviço e consulte a respetiva referência para compreender a autenticação, os parâmetros, as respostas e as ações disponíveis.
Crie e controle chamadas com fala, reprodução de áudio, entrada pelo teclado e transferências.
Conhecer a voz programávelPesquise o catálogo, peça estimativas, faça encomendas e configure o encaminhamento através da API.
Conhecer os números de telefoneEnvie mensagens, consulte os resultados por destinatário e acompanhe o estado de entrega na sua aplicação.
Conhecer os SMSNormalize números de telefone ou solicite informações de rede e portabilidade disponíveis em tempo real.
Conhecer a consulta de númerosConverta áudio em texto ou gere áudio falado a partir de texto com APIs autónomas de fala. Escolha entre os idiomas e as vozes documentados.
Conhecer as APIs de falaUtilize os endpoints documentados para trabalhar com contactos, histórico de chamadas e acesso a gravações.
Consultar a referência da APIWebphone SDK
Adicione chamadas no navegador a um CRM, interface de agente ou espaço de trabalho próprio. O SDK JavaScript disponibiliza registo, controlo de chamadas e gestão de dispositivos através de SIP sobre WSS.
Ligue, registe, chame, atenda, silencie, coloque em espera, retome, envie DTMF e transfira através de JavaScript.
Selecione dispositivos de áudio, faça verificações prévias e consulte estatísticas de chamadas em direto. A seleção da saída de áudio depende do suporte do navegador.
Escolha uma região, configure alternativas geridas de sinalização e renove as credenciais do navegador para sessões mais longas.
Webhooks
Receba notificações de eventos de chamadas, SMS, contactos e correio de voz. Atualize os seus registos ou desencadeie a próxima etapa do processo.
Verifique as assinaturas, confirme rapidamente a receção e trate com segurança IDs de evento repetidos.
Consultar a referência de webhookscall_ringing
call_answered
call_completedsms_sent
sms_delivered
sms_failedcontact_added
voicemail_receivedO portal reúne documentação da API, exemplos e ferramentas de desenvolvimento na sua conta.
Verifique o método de autenticação, os parâmetros obrigatórios e os campos da resposta do endpoint.
Primeiros passosUtilize a especificação OpenAPI publicada em conjunto com a documentação dos endpoints.
Especificação OpenAPIGere exemplos de pedidos no API Playground. Os pedidos enviados utilizam a sua conta e podem executar ações com custos.
Abrir o API PlaygroundOs pedidos normais da API de cliente utilizam o cabeçalho X-Api-Key. Mantenha a chave no backend. O guia atual de primeiros passos documenta o âmbito da conta e os requisitos específicos dos endpoints.
O portal protege a apresentação, cópia e regeneração da chave com verificação de identidade. Siga os pedidos de palavra-passe e verificação em dois passos apresentados. O API Playground utiliza um desbloqueio temporário; reveja o pedido antes de o executar. Ao regenerar a chave, coordene a atualização das aplicações que a utilizam.
No fluxo gerido recomendado do SDK, o backend emite um token de curta duração para o navegador. Determine a identidade SIP a partir do utilizador autenticado no servidor; não permita que o navegador escolha uma identidade arbitrária. A chave de API permanece no servidor.
É um SDK JavaScript exclusivo para chamadas no navegador. É independente das aplicações IllyVoIP publicadas para Windows, iOS e Android.
A referência do Webphone SDK disponibiliza ligações para o recurso alojado para navegador e para um pacote descarregável para alojamento próprio, com definições TypeScript. Utilize o pacote atual e consulte as notas de versão e orientações de segurança.
Sim. A API documenta a pesquisa de catálogo, estimativas, encomendas, encaminhamento e envio de documentos obrigatórios. A disponibilidade e a ativação dependem do destino e dos requisitos de registo aplicáveis.
A entrega pode ser repetida. Verifique a assinatura e utilize o ID estável do evento para evitar processá-lo duas vezes. A referência apresenta os eventos disponíveis e o comportamento das novas tentativas.
Comece pela referência atual da API e escolha os serviços de que precisa.