Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Info

Disponível a partir da versão 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 um token de API.


Gerar relatório de histórico de chamadas

Enpoint

/api/v1/report/calls_history

Método

GET

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.

Nome

Valor Padrão

Valor Máximo

Observações

limit

50

50

-

page

1

-

-

start_date

Dia atual

-

Formato AAAA-MM-DD

end_date

Dia atual

-

Formato AAAA-MM-DD

entity

queues

-

Valores possíveis:

queues, active_queues, queue_groups

queue_ids

all

-

Aceita mutiplos, ex:

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

queue_group_ids

all

-

Usado somente se entity=queue_groups

agent_id

all

-

-

state

'' (empty)

-

-

city

'' (empty)

-

-

call_type

both

-

Valores possíveis:

in, out, both

start_hour

0

23

-

end_hour

23

23

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_id

all

-

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>'

...