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

Webhooks

Eventos do serviço. A sua próxima ação.

Ligue eventos de chamadas, SMS, contactos e correio de voz à sua aplicação, com dados documentados, pedidos assinados e histórico de entregas.

Ler documentação de webhooksConhecer o funcionamento

Os eventos que
fazem avançar o seu trabalho.

Escolha uma categoria para consultar os eventos atualmente documentados. Esta é uma referência, não um feed de eventos em direto.

call_initiated

Uma chamada é iniciada.

call_ringing

Uma chamada entra na fase de toque.

call_answered

Uma chamada é atendida.

call_completed

Uma chamada termina; inclui a duração final.

Como funciona

Ocorre um evento.
A aplicação reage.

A IllyVoIP envia pedidos POST com JSON para o endpoint que configurar.

Escolha as subscrições

Crie um endpoint nas definições de Webhooks da conta. Subscreva os eventos de chamadas, SMS, contactos ou correio de voz de que a aplicação precisa.

Verifique antes de processar

Valide o cabeçalho Illyvoip-Signature com o segredo do webhook, o timestamp e o corpo original do pedido, conforme a documentação.

Confirme a receção e coloque em fila

Devolva rapidamente uma resposta 2xx de sucesso. Coloque o trabalho mais demorado em fila para não atrasar a confirmação da entrega.

Trate as entregas repetidas

Guarde o ID do evento presente no corpo e ignore eventos já processados. Uma nova tentativa pode entregar o mesmo evento outra vez.

Prepare-se para condições
reais de entrega.

O portal inclui o histórico de entregas; a documentação da API explica os dados, as assinaturas e o comportamento das novas tentativas.

Investigue as falhas
Consulte o estado da entrega, a resposta HTTP e os erros para distinguir um problema do recetor de um problema na lógica da aplicação.
Separe os ambientes de SMS
Um endpoint pode receber todos os Sender IDs ou apenas os selecionados. Cada endpoint correspondente recebe o evento; os filtros não reenviam eventos antigos.
Guarde os segredos no servidor
A gestão de webhooks abrange endpoints, segredos e registos de entrega de toda a conta. Atribua essa permissão de forma consciente. Ler a especificação atual de webhooks

Alguns detalhes
úteis.

Fale com a nossa equipa
Existe um webhook para cada ação do portal?+

Não. Use o catálogo de eventos documentado na API. Subscreva apenas os eventos disponíveis para o processo pretendido.

O mesmo evento pode chegar mais de uma vez?+

Sim. As novas tentativas mantêm o mesmo ID de evento. Elimine duplicados usando o campo id do corpo, não o ID do trabalho de entrega.

Que falhas originam novas tentativas?+

A documentação atual inclui falhas de rede e respostas HTTP 408, 429 e 5xx. Os redirecionamentos e as restantes respostas 4xx interrompem a entrega. Consulte a especificação mais recente antes de implementar o recetor.

Deixe os eventos fazer avançar o seu processo.

Comece pela documentação atual dos eventos e configure depois o endpoint recetor.

Ler documentação de webhooksContacte a nossa equipa