¶ Webhooks
¶ Descrição
Os Webhooks permitem criar ou configurar integrações que se inscrevem em determinados eventos do PABX.
Quando um desses eventos é disparado, o sistema envia uma requisição HTTP POST para a URL configurada no webhook.
Os Webhooks podem ser utilizados, por exemplo, para:
- Informar qual agente está realizando um atendimento
- Atualizar informações em um CRM
- Integrar o PABX com sistemas externos
Os Webhooks serão acionados sempre que um ou mais eventos configurados ocorrerem no PABX.
¶ Eventos
Ao configurar um webhook, é possível escolher quais eventos deseja receber.
Também é possível optar por receber todos os eventos atuais e futuros.
Limitar os eventos apenas aos necessários é recomendado para reduzir o número de requisições HTTP enviadas ao servidor.
¶ Detalhes da requisição
Cada evento é notificado através de uma requisição HTTP do tipo POST enviada para a URL configurada no webhook.
¶ Cabeçalhos de entrega
As requisições HTTP enviadas para a URL configurada conterão os seguintes cabeçalhos:
- x-auth-token: Senha de autenticação (opcional)
- Content-Type:
application/jsonapplication/x-www-form-urlencoded
¶ Tipos de eventos
Cada tipo de evento possui um formato específico com informações relevantes sobre a ação ocorrida no PABX.
A seguir estão os eventos disponíveis e seus respectivos atributos.
¶ AgentConnect
Evento gerado quando um agente atende uma ligação proveniente de uma fila.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- destcalleridnum: Número do tronco
- queue: Número da fila
- calleridnum: Número de origem da chamada
- membername: Nome do ramal
- destchannel: Número do ramal conectado
- holdtime: Tempo que a chamada permaneceu na fila (em segundos)
- interface: Canal do membro da fila
¶ AgentComplete
Evento gerado quando um agente finaliza uma ligação proveniente de uma fila.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- destcalleridnum: Número do tronco
- queue: Número da fila
- calleridnum: Número de origem da chamada
- membername: Nome do ramal
- destchannel: Número do ramal conectado
- holdtime: Tempo que a chamada permaneceu na fila (em segundos)
- talktime: Tempo de conversação na chamada (em segundos)
- interface: Canal do membro da fila
¶ QueueCallerJoin
Evento gerado quando uma ligação entra em uma fila de atendimento.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- queue: Número da fila
- calleridnum: Número de origem da chamada
¶ QueueCallerAbandon
Evento gerado quando uma ligação abandona a fila antes de ser atendida.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- queue: Número da fila
- calleridnum: Número de origem da chamada
¶ AttendedTransfer
Evento gerado quando uma transferência assistida é concluída.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- transfer: Número transferido
- from: Número de origem conectado
- to: Número de destino conectado
¶ Pickup
Evento gerado quando ocorre uma captura de chamada.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- calleridnum: Número de origem da chamada
- origin: Número do destino capturado
- ringing: Número que estava tocando
¶ DialBegin
Evento gerado quando uma ação de discagem é iniciada.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- calleridnum: Número de origem da chamada
- origin: Número de destino da chamada
¶ DialEnd
Evento gerado quando uma ação de discagem é finalizada.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- calleridnum: Número de origem da chamada
- origin: Número de destino da chamada
¶ Hangup
Evento gerado quando um canal é desligado.
Atributos:
- event: Evento disparado pelo PABX
- linkedid: Identificador único da ligação (ID)
- calleridnum: Número de origem da chamada
- origin: Número de destino da chamada
¶ Como testar o Webhook
Testar integrações de webhook pode ser mais simples utilizando ferramentas online que permitem capturar requisições HTTP.
Alguns serviços recomendados são:
- webhook.site
- beeceptor.com
Nesses serviços é possível criar uma URL temporária, que será utilizada para receber os eventos enviados pelo PABX.
¶ Recebendo as requisições do Webhook
Para configurar o webhook no sistema:
- Acesse o Gestor VTCall.
- Vá até Ajustes > Integrações > Webhook.
- Clique em Add Webhook.
- Insira o endereço da URL no campo Endereço de URL.
- Selecione o formato JSON.
- Salve a configuração.
- Clique em Realizar teste para validar o envio do webhook.
Observação:
O teste de webhook funcionará apenas quando o formato JSON estiver selecionado.