Webhooks
Descrição
Os Webhooks permitem que você crie ou configure integrações que se inscrevam em determinados eventos no PABX.
Quando um desses eventos é disparado, enviamos uma carga HTTP POST para o URL configurada do Webhook. Os Webhooks podem ser utilizados para informar quem esta realizando um atendimento ou atualizar uma informação em um CRM. Você só está limitado pela sua imaginação.
Os webhooks serão acionados cada vez que um ou mais eventos assinados ocorrerem no PABX.
Eventos
Ao configurar um webhook, é possível escolher quais eventos você gostaria de receber, sendo possível até optar por participar de todos os eventos atuais e futuros. Limitar os eventos específicos que você planeja no tratamento é útil para controlar o número de solicitações HTTP ao servidor.
Detalhes da requisição
Cada evento é notificado com uma requisição do tipo POST para a URL configurada no painel.
Cabeçalhos de entrega
As solicitações HTTP feitas na URL configurada do webhook conterão os cabeçalhos:
- x-auth-token: Senha (opcional)
- Content-type: application/json ou application/x-www-form-urlencoded
Tipos de eventos
Cada tipo de evento tem um formato útil específico com as informações relevantes do evento.
Veja abaixo os tipos de eventos e seus atributos.
- AgentConnect: Quando um agente atende uma ligação de uma fila
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
destcalleridnum: Numero do tronco
queue: Número da fila
calleridnum: Número de origem conectado
membername: Nome do ramal
destchannel: Numero do ramal conectado
holdtime: O tempo que o canal estava na fila, expresso em segundos
interface: Canal do membro da fila
- AgentComplete: Quando um agente Finaliza a ligação proveniente de uma fila
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
destcalleridnum: Numero do tronco
queue: Número da fila
calleridnum: Número de origem conectado
membername: Nome do ramal
destchannel: Número do ramal conectado
holdtime: O tempo que o canal estava na fila, expresso em segundos
talktime: O tempo que o canal falou na fila, expresso em segundos
interface: Canal do membro da fila
- QueueCallerJoin: Quando um ligação entra na fila…
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
queue: Número da fila
calleridnum: Número de origem conectado
- QueueCallerAbandon: Quando um ligação abandona.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
queue: Número da fila
calleridnum: Número de origem conectado
- AttendedTransfer: Criado quando uma transferência é concluída.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
transfer: Número a ser transferido
from: Número Origem conectado
to: Número de destino conectado
- Pickup: Criado quando ocorre uma captura de chamadas.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
calleridnum: Número de origem conectado
origin: Número de destino capturado
ringing: Número de origem tocando
- DialBegin: Gerado quando uma ação de discagem for iniciada.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
calleridnum: Número de origem conectado
origin: Número de destino capturado
- DialEnd: Gerado quando uma ação de discagem foi concluída.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
calleridnum: Número de origem conectado
origin: Número de destino capturado
- Hangup: Criado quando um canal é desligado.
event: Evento disparado pelo PABX
linkedid: Identificador unico da ligação (ID)
calleridnum: Número de origem conectado
origin: Número de destino capturado
Como testar o Webhook?
Testar a integração com o webhook pode ser trabalhoso. Por isso, separamos algumas informações para auxiliá-lo com os seus tipos de retorno.
Podem ser utilizados sites como webhook.site ou beeceptor.com, onde clica-se em Nova URL para criar a URL que será cadastrada no Gestor VTCall.
Recebendo as requisições do webhook
Para receber as requisições do webhook nessa URL, primeiro acesse o seu Gestor VTCALL, clique em >Ajustes >Integrações >Webhook >Add Webook. Insira o endereço no campo Endereço de URL, selecione como JSON, salve e clique e realizar teste. Lembrando que este teste apenas funciona se utilizar JSON