API - Relatório - Histórico de Chamadas PABX

Disponível a partir da versão 6.70.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/pabx_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 PABX do dia atual.

Nome	Valor Padrão	Valor Máximo	Observações

Nome	Valor Padrão	Valor Máximo	Observações
limit	número 30	100	-
page	número 1	-	-
start_time	Início do dia atual (timezone do evolux)	não pode ser maior que end_time.	Formatos: ISO 8601, WTC Date, Java SimpleDateFormat Class e outros. Quando não é passado a hora, é utilizado o início do dia no timezone fornecido. Quando não é passado o dia, é utilizado o dia atual no timezone fornecido. Quando não é passado o timezone, é utilizado o timezone do evolux. A precisão de segundos é a máxima utilizada, sendo usado o truncamento (ou seja, são ignorados os microsegundos). Exemplos de valores possíveis: 2021-11-23 04:42Z 2021-11-23 00:00-03:00 2017-01-01 18:00 UTC 2017-01-01 18:00 BRT Wed, Jul 4, '01 Mar, 8 March, 8 March, 8 2000 Mar, 8 2000 18:00 Mar, 8 2000 18:00 BRT Mar, 8 2000 18:00 GMT Mar, 8 2000 18:00 GMT-3 Mar, 8 2000 18:00 -3 20010203180000 20010203 18:00 2001 02 03 18:00 2001-07-04T12:08:56.235-0700
end_time	Fim do dia atual (timezone do evolux)	-	veja start_time.
number	-	-	Número a ser pesquisado. Exemplos de valores possíveis: 190 8440080000
call_type	-	-	Tipo de chamada. Quando não fornecido, todos os tipos são retornados. Valores possíveis: external_in external_out internal no_route
end_reason	-	-	Tipo de fim de chamada Quando não fornecido, todos os tipos são retornados Valores possíveis: hangup_by_callee hangup_by_caller timeout busy unknown cancel reject no_route

Exemplo de requisicão

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

Exemplo de resposta

{
    "data": {
        "calls": [
            {
                "answer_time": "2021-11-23T15:50:46+00:00",
                "call_duration": 3,
                "call_type": "internal",
                "callee_group": "Padrão",
                "callee_number": "801",
                "callee_type": "extension",
                "caller_group": "Bola",
                "caller_number": "802",
                "caller_type": "extension",
                "calling_duration": 1,
                "did_number": null,
                "download_audio": "https://example.evolux.net.br/api/v1/recording/1ec4d86c-4c75-11ec-9ed9-696ef8ce316c",
                "end_reason": "hangup_by_callee",
                "end_time": "2021-11-23T15:50:49+00:00",
                "id": 2,
                "start_time": "2021-11-23T15:50:45+00:00",
                "uuid": "1ec4d86c-4c75-11ec-9ed9-696ef8ce316c"
            },
            {
                "answer_time": null,
                "call_duration": 0,
                "call_type": "internal",
                "callee_group": "Padrão",
                "callee_number": "801",
                "callee_type": "extension",
                "caller_group": "WebPhone",
                "caller_number": "201",
                "caller_type": "extension(position)",
                "calling_duration": 1,
                "did_number": null,
                "download_audio": null,
                "end_reason": "busy",
                "end_time": "2021-11-23T12:57:19+00:00",
                "id": 1,
                "start_time": "2021-11-23T12:57:18+00:00",
                "uuid": "40d87106-5e0b-ba2c-0a3a-a21fba21d682"
            }
        ]
    },
    "meta": {
        "message": "OK",
        "status": 200
    },
    "pagination": {
        "current_url": "https://example.evolux.net.br/api/v1/report/pabx_calls_history?page=1",
        "first_url": "https://example.evolux.net.br/api/v1/report/pabx_calls_history?page=1",
        "items": 2,
        "last_url": "https://example.evolux.net.br/api/v1/report/pabx_calls_history?page=1",
        "limit": 30,
        "max_limit": 100,
        "next_url": null,
        "prev_url": null,
        "total": 2
    }
}