Gerando eventos via API
Gerando eventos via API
Dentro do Situator existe a página de monitoramento onde os operadores interagem atendendo as ocorrências de eventos e executam as ações configuradas para esses eventos.
A API permite gerar eventos remotamente que aparecerão como ocorrências para os atendentes no Situator, através do endpoint:
[POST] - /api/remote-events
Lembrando que antes é necessário estar autenticado como descrito em Login/Logoff.
Para gerar eventos basta enviar um simples JSON conforme abaixo:
1 2 3 4 { "accountCode": "1000", "eventCode": "CONNECTION_LOSS" }
onde são informados os códigos de identificação cadastrados no Situator para a Conta e para o Evento.
Então é possível cadastrar uma lista de eventos que sua empresa integradora prefira definir com códigos próprios, ou utilizar os eventos e códigos pré-cadastrados quando da instalação do Situator, conforme os exemplos que seguem:
Segue a descrição completa dos campos do JSON que podem ser enviados na API de geração de eventos:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "accountCode": "string", "zoneCode": "string", "eventCode": "string", "priority": 0, "join": true, "latitude": 0, "longitude": 0, "description": "string", "message": "string", "person": { "id": 0, "integrationId": 0 }, "callId": "string", "payload": "string", "visitorId": 0 }
Sendo:
-
accountCode: Código da conta no Situator. (Obrigatório para usuários não vinculados a uma conta)
-
zoneCode: Código da Zona no Situator. (Não Obrigatório obtém a zona geral da conta)
-
eventCode: Código do Evento no Situator. (Obrigatório)
-
priority: Prioridade do evento no Situator, sendo 0 para prioridade Baixa , 1 para
prioridade Média , 2 para prioridade Alta , 3 para prioridade Critica. (Não Obrigatório) -
join: Parâmetro para agrupar quando tiver outra ocorrência similar na tela, true é o padrão.
(Não Obrigatório)
-
latitude: Latitude de onde esta sendo disparado o evento. Aparece no mapa dentro do Situator.
(Não Obrigatório)
-
longitude: Longitude onde esta sendo disparado o evento. Aparece no mapa dentro do Situator.
(Não Obrigatório)
-
description: Descrição do evento no Situator. (Não Obrigatório)
-
message: Texto que aparecerá no log de histórico da ocorrência. (Não Obrigatório)
-
person: Pessoa que está enviando o evento, podendo informar o “id” da pessoa, ou “integrationId” para softwares parceiros integrados diretamente ao Situator, como o SCond. (Não Obrigatório)
-
callId: Identificação da chamada utilizado para integrações dos software de telefonia ao Situator.
(Não Obrigatório)
-
payload: Dados complementares de uso exclusivo na ação para requisição HTTP GET. (Não Obrigatório)
-
visitorId: Pré-visitante de uso exclusivo para previsões de visitas. (Não Obrigatório)