Child pages
  • Estrutura de APIs do Q-Manager
Skip to end of metadata
Go to start of metadata

Introdução

Esse documento visa fornecer o padrão de uso das APIs do Q-Manager disponibilizadas a partir da versão 1.0.7. A APIs fornecidas são:

  • Listagem de Operadores
  • Listagem de Filas
  • Relatórios do Operador
  • Relatório da fila

Access Token

Para utilizar as APIs é necessário fornecer o access_token do usuário do Q-Manager para validação e permissionamento dos dados. Para visualizar o access_token basta acessar Usuários -> Editar

Importante 

Para evitar o alto consumo do servidor, as APIs de dados dos relatórios do Q-manager tem controle de consultas por tempo. Ao receber a primeira requisição o Q-Manager estipula um prazo de 1(um) minuto de controle, sendo que se ocorrer uma nova consulta em menos de 1(um) minuto a mesma terá um delay de 3 segundos acumulativos. Estas APIs fornecerão dados em no máximo 5(cinco) requisições dentro do prazo de 1(um) minuto, caso ocorra a sexta consulta a API fornecerá um status code 403(não permitido). 

Listagem de Operadores (GET)

API para listagem dos operadores.

URL: ip_server:8080/operators/api/v1/getOperators?access_token=VALOR_DO_ACCESS_TOKEN

 

Response:

_id: Identificação do operador.

agent: Código do operador.

secret: Senha de login do operador.

endpoint: Ramal do operador.

peer_fixed: É true quando o operador possui o mesmo número do ramal. Exemplo: Operador 2000 e Ramal SIP/2000.

name: Nome do operador.

queues: Nome da fila padrão do operador. Os parâmetros pausa, state e penalty é referente ao status do operador na fila informada.

created: Data de criação do pausa.

updated: Data de atualização da pausa.

email: Email do operador.

 

Listagem de Filas (GET)

API para listagem das filas.

URL: ip_server:8080/queues/api/v1/getQueues?access_token=VALOR_DO_ACCESS_TOKEN

 

Response:

queue: Nome da fila.

loggedin: Quantidade de membros na fila.

available: Quantidade de membros disponíveis.

callers: Quantidade de chamadas aguardando na fila no momento.

holdtime: Tempo de espera na fila(média).

talktime: Tempo de chamada na fila(média).

longestholdtime: Tempo de espera da chamada na fila(média).

 

Relatório do operador (GET)

API para gerar dados dos operadores.

URL: ip_server:8080/report-operators/api/v1/generate?access_token=VALOR_DO_ACCESS_TOKEN&type=TIPO_DE_RELATORIO&from=DATA_INICIAL&to=DATA_FINAL&operator=OPERADORES

Valores Permitidos:

access_token: Token de acesso. *Dado obrigatório.

type: Tipo do relatório. Poderá ser analytic ou synthetic. *Dado obrigatório.

from: Data inicial da consulta no formato yyyy-mm-dd. Exemplo: 2017-04-18.  *Dado obrigatório.

to: Data final da consulta no formato yyyy-mm-dd. Exemplo: 2017-04-19.  *Dado obrigatório.

operator: Código dos operadores. Quando for mais de um operador separar por vírgula. Exemplo: 1018,1025. *Dado obrigatório.

 discard: Valor em segundos de descarte de chamada "menor que". Valor deve ser inteiro.


Exemplo Tipo Sintético

URL: ip_server:8080/report-operators/api/v1/generate?access_token=frmCREB8vXrA9jZI&type=synthetic&from=2017-04-18&to=2017-04-19&operator=1018,1025&discard=10

 

Response:

Nomenclatura dos dados do resultado.

partials: Dados parciais do operador por dia a dia dentro do período escolhido.

total: Soma total dos dados do período.

incoming: Chamadas de entrada.

outgoing: Chamadas de saída.

total: Quantidade total de chamadas.

answer: Quantidade de chamadas atendidas.

noanswer: Quantidade de chamadas não atendida.

talktime: Tempo médio de atendimento(TMA).

ringtime: Tempo médio de espera(TME).

duration: Tempo médio de chamada(TMC).

perc_answer: Porcentagem de chamadas atendidas.

perc_noanswer: Porcentagem de chamadas não atendidas.

availability: Disponibilidade do operador total no período(Soma dos dias)

cont_pauses: Quantidade de pausas.

time_pauses: Tempo total em pausas.

online: Tempo online. Desde último login.

in_call: Tempo em ligação.

data_pauses: Pausas geradas no período com quantidade, tempo e se extrapolou o tempo limite diário configurado da pausa. 

message: Apresentado quando não há dados do operador.

 

Exemplo Tipo Analítico

URL: ip_server:8080/report-operators/api/v1/generate?access_token=frmCREB8vXrA9jZI&type=analytic&from=2017-05-02&to=2017-05-02&operator=1025

 

Response:

Nomenclatura dos dados do resultado.

analytic: Dados das chamadas de entrada e saída do operador.

eventdate: Data e horário da chamada.

status: Status da chamada. Poderá ser answer(atendida) e noanswer(não atendida)

type: Incoming - ligação de entrada. Outgoing - ligação de saída.

queue: Nome da fila caso a ligação esteja sendo recebida na fila.

talktime: Tempo de atendimento.

duration: Tempo de chamada.

to: Destino da chamada.

from: Origem da chamada.

feature: Dados de disponibilidade do operador.

date: Data do evento.

hour: Hora do evento.

event: Tipo de evento. Poderá ser login, pause, unpause e logoff.

queue: Fila que foi efetuado o evento.

event_name: Nome do evento. Caso o evento seja pause o nome da pausa é fornecido nesse campo.

 

Relatório de Fila (GET)

API para gerar dados das filas.

URL: ip_server:8080/report-queues/api/v1/generate?access_token=VALOR_DO_ACCESS_TOKEN&type=TIPO_DE_RELATORIO&from=DATA_INICIAL&to=DATA_FINAL&queues=FILAS&status=STATUS

Valores Permitidos:

access_token: Token de acesso. *Dado obrigatório.

type: Tipo do relatório. Poderá ser analytic ou synthetic. *Dado obrigatório.

from: Data inicial da consulta no formato yyyy-mm-dd. Exemplo: 2017-04-18.  *Dado obrigatório.

to: Data final da consulta no formato yyyy-mm-dd. Exemplo: 2017-04-19.  *Dado obrigatório.

queues: Nome das Filas. Quando for mais de uma fila separar por vírgula. Exemplo: Suporte,Comercial. *Dado obrigatório.

status: Status da chamada. Valor poderá ser all(todas), queueabandon(somente abandonadas), queuetimeout(somente tempo limite), queuehangup(somente atendidas), caller(somente desligada pelo cliente), agent(somente desligada pelo operador) ou transfer(somente transferidas).  *Dado obrigatório.

Exemplo Tipo Sintético

URL: ip_server:8080/report-queues/api/v1/generate?access_token=frmCREB8vXrA9jZI&type=synthetic&from=2017-05-02&to=2017-05-05&queues=Suporte&status=all

 

Response:

Nomenclatura dos dados do resultado.

partials: Dados parciais da fila por dia a dia e hora em hora dentro do período escolhido.

total: Soma total dos dados do período.

total: Quantidade total de chamadas.

abandon: Quantidade de chamadas abandonadas.

answer: Quantidade de chamadas atendidas.

timeout: Quantidade de chamadas tempo limite.

transfer: Quantidade de chamadas transferidas.

agent: Quantidade de chamadas desligadas pelo operador.

caller: Quantidade de chamadas desligadas pelo cliente.

talktime: Tempo de atendimento(em segundos).

holdtime: Tempo de espera(em segundos).

duration: Tempo de chamada(em segundos).

perc_answer: Porcentagem de chamadas atendidas.

perc_abandon: Porcentagem de chamadas abandonadas.

perc_timeout: Porcentagem de chamadas tempo limite.

perc_transfer: Porcentagem de chamadas transferidas.

perc_agent: Porcentagem de chamadas desligadas pelo operador.

perc_caller: Porcentagem de chamadas desligadas pelo cliente.

tme: Tempo médio de espera(TME).

tma: Tempo médio de atendimento(TMA).

tmc: Tempo médio de chamada(TMC).

max: Quantidade máxima de chamadas em um hora no dia.

message: Apresentado quando não há dados da fila.

 

Exemplo Tipo Analítico

URL: ip_server:8080/report-queues/api/v1/generate?access_token=frmCREB8vXrA9jZI&type=analytic&from=2017-05-02&to=2017-05-05&queues=Suporte&status=all

 

Response:

Nomenclatura dos dados do resultado.

header: primeiro evento da chamada na fila.

calldate: Data e horário da chamada.

queue: Nome da fila.

from: Origem da chamada.

holdtime: Tempo do evento.

firstevent: Nome do primeiro evento. Sempre será Enterqueue(Entrou na Fila).

footer: Dados da chamada após o término da mesma.

callid: Código identificador da chamada.

lastevent: Último evento da chamada. Poderá ser queuehangup(ligação atendida), queueabandon(ligação abandonada) ou queuetimeout(ligação com tempo limite da fila).

hangupdate: Data e hora do fim da chamada.

duration: Tempo de chamada.

talktime: Tempo de atendimento.

timewaiting: Tempo de espera.

record: Localização da gravação da chamada, caso tenha.

callf: Fluxo da chamada dentro da fila.

event: Nome do evento. Poderá ser answered(atendida), transfer(transferida), Off by the client(desligada pelo cliente) ou Off by the operator(desligada pelo operador).

holdtime: Tempo de evento.

ringtime: Tempo de ring no operador.

endpoint: Ramal do operador.

name: Nome do operador.

feature: Dados de disponibilidade do operador.

date: Data do evento.

hour: Hora do evento.

event: Tipo de evento. Poderá ser login, pause, unpause e logoff.

queue: Fila que foi efetuado o evento.

event_name: Nome do evento. Caso o evento seja pause o nome da pausa é fornecido nesse campo.

 

 

  • No labels