Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Disponível a partir da versão 6.16.0

Requisição de relatórios.

Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.


Gerar relatório de histórico de chamadas

Enpoint/api/v1/report/calls_history
MétodoGET

Query String

Obs1: Todos os parâmetros são opcionais.

Obs2: Uma query string vazia gera um relatório de todas as chamadas de todas filas no dia atual.

NomeValor PadrãoValor MáximoObservações
limit5050-
page1--
start_dateDia atual-

Formato AAAA-MM-DD

end_dateDia atual-Formato AAAA-MM-DD
entityqueues-

Valores possíveis:

queues, active_queues, queue_groups

queue_idsall-

Aceita mutiplos, ex:

queue_ids=1&queue_ids=2&queue_ids=3...

queue_group_idsall-Usado somente se entity=queue_groups
agent_idall--
state'' (empty)--
city'' (empty)--
call_typeboth-

Valores possíveis:

in, out, both

start_hour023-
end_hour2323

A hora final considera todo o intervalo da hora, ex:

end_hour=14 considera chamadas até 14:59

phone_number'' (empty)--
csat'' (empty)-

Valores possíveis:

1, 2

protocol_number'' (empty)--
end_by_idall-

Valores possíveis:

all, 1,2,...,9


Exemplo de requisicão

Code Block
curl -X GET \
  --url https://example.evolux.net.br/api/v1/report/calls_history \
  -H 'Content-Type: application/json' \
  -H 'token: <EVOLUX_TOKEN>'

...