API Relatórios
Relatório Analítico
A API funciona por link HTTP, com parâmetros em GET ou POST e a resposta em JSON.
Todos os parâmetros são opcionais, a seguir a lista com os valores padrão caso não for especificado na requisição.
| Parâmetro | tipo | Valor | Padrão | Descrição |
|---|---|---|---|---|
| datestart | text (datetime) | YYYY-MM-DD hh:mm:ss (Ex.: 2020-12-01 00:00:00) | Data atual | |
| dateend | text (datetime) | YYYY-MM-DD hh:mm:ss (Ex.: 2020-12-31 23:59:59) | Data atual | |
| start | numeric | 0 | 0 | linha de inicio da requisição atual |
| length | numeric | 30 | Todos os registros | Quantidade de linhas a serem retornadas a partir do ponto de partida |
| number | text | 1721393950 | Número para ser pesquisado | |
| extensions | text (array) | ('5000','5001') | lista de ramais selecionados | |
| queues | text (array) | ('atendimento') | lista de filas selecionadas | |
| trunks | text (array) | ('SIP/1001','SIP/operadoraX') | lista de troncos selecionadas | |
| type | text (array) | ('IN','OUT','INTERNO') | lista de tipo | |
| status | text (array) | ('BUSY','NOANSWER') | lista de status das chamadas |
A lista de status das ligações do asterisk é a seguinte:
| status | descrição |
|---|---|
| ANSWER | Atendido |
| BUSY | Ocupado |
| NOANSWER | Não Atendido |
| CONGESTION | Congestionado |
| CANCEL | Cancelada |
| CHANUNAVAIL | Indisponível |
| INVALIDARGS | Argumentos inválidos |
| FAILED | Falhou |
Exemplo
http://server_IP/api/relatorio_analitico.php?number=1721393950
Resposta da API
A resposta em JSON irá conter todos os registros na variável data:
{"start":"0","lenght":"1","data":[{"calldate":"2020-09-04 11:35:48","linkedid":"1599230146.666","tipo":"IN","ddr":"5000","ura":"","menu":"","queue":"600","origem":"17988884444","destino":"4009","tronco":"SIP\/1000","cidade":"CELULAR DDD 17","audio":"IN-17988884444-4009-20200904-113548-1599230146.666.WAV","status":"ANSWER","holdtime":"2","callduration":"2"}]}
valores:
| Valor | Descrição |
|---|---|
| calldate | Horário da chamada |
| linkedid | Registro único da chamada (protocolo) |
| tipo | Tipo da ligação (Entrada, saída ou interna) |
| ddr | DDR de entrada |
| ura | Nome da URA |
| menu | Menus teclados na URA |
| queue | Nome da Fila |
| origem | Ramal ou Número que efetuou a chamada |
| destino | Ramal ou Número que foi chamado |
| tronco | tronco utilizado para efetuar a chamada |
| cidade | Nome da cidade |
| audio | Nome do arquivo de áudio |
| status | Status de completamento da chamada |
| holdtime | Tempo em espera (em segundos) |
| callduration | Duração da chamada (em segundos) |
Gravações
Faz download do arquivo de áudio, devem ser informados data e nome do arquivo.
| Parâmetro | Descrição |
|---|---|
| date | YYYY-MM-DD (2020-12-31) |
| file | *.ext (campo áudio do relatório) |
Exemplo:
http://server_IP/api/gravacao.php&date=2020-09-04&file=IN-17988884444-4009-20200904-113548-1599230146.666.WAV
