¶ Sobre o Webhook USCall UC
Com módulo Webhook é possível enviar eventos gerados pelos módulos do USCall UC, a sistemas de terceiros.
As funções disponíveis seguem os padrões de saída da API SOAP do USCall UC. Consulte a documentação da API aqui.
¶ Cadastrando Webhook
Para gerenciar os Webhooks cadastrados navegue até o módulo:
Aplicações extra / Webservice / Webhooks
Os webhooks cadastrados seguem os padrões de configuração dos tokens SOAP, com a opção de definir um período para expiração do webhook.
Na parte de cadastro, conforme imagem abaixo, é possível informar quais funções serão enviadas ao Webhook cadastrado, juntamente com as informações pertinentes de cada função
No campo de protocolo, que será a forma de conexão com o webhook para envio dos dados, estão disponíveis os protocolos MQTT e REST, cada protocolo possui sua particularidade de configuração.
Rest - É necessário informar apenas a URL do servidor, e todos os eventos serão enviados usando o verbo HTTP POST.
MQTT - Possui particularidades de configuração conforme cada ambiente, onde a configuração deve ser ajustada do acordo com broker MQTT que receberá os dados. Para saber mais sobre o protocolo MQTT consulte a documentação aqui.
Após cadastrados os Webhooks iniciarão automáticamente, e serão geridos pelo serviço Contact center.
¶ Eventos
Abaixo uma descrição dos eventos disponíveis para envio nos Webhooks.
Todos os eventos são enviados no formato JSON, e os mesmo possuem um campo com a data de envio do evento.
As informações de saída dos eventos seguem os padrões de saída da API SOAP do USCall UC. Consulte a documentação da API aqui.
¶ agentStatus
Esta função envia eventos relacionados aos status dos agentes de contact center, toda alteração de status dos agentes serão enviados eventos com as dados atuais de uso dos mesmos.
Abaixo uma lista de status disponíveis:
- Ocioso
- Ocupado
- Ramal inoperante
- Tocando
- Discando
- Ocupado
- Em pausa
- Pausa finalizada
- Login efetuado
- Logout efetuado
¶ extenStatus
Esta função envia eventos relacionados aos status dos ramais do PBX, toda alteração de status dos ramais serão enviados eventos com as dados atuais de uso dos mesmos.
Abaixo uma lista de status disponíveis:
- Indisponivel
- Disponivel
- Tocando
- Discando
- Ocupado
¶ Exemplo de envio
Abaixo algumas imagens de recebimento dos eventos de um webhook cadastrado usando o protocolo MQTT, em um ambiente de testes do serviço mosquito, com o software MQTTX :
agentStatus
extenStatus
