Mudanças entre as edições de "API Relatórios"
Ir para navegação
Ir para pesquisar
| (2 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 6: | Linha 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | ! Parâmetro !! tipo !! Valor !! Padrão !! Descrição | + | ! Parâmetro !! tipo !! Valor !! Padrão !! Descrição !! Obrigatório |
|- | |- | ||
| − | | datestart || text (datetime) || YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-01 00:00:00) || Data atual || | + | | datestart || text (datetime) || YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-01 00:00:00) || Data atual || || Sim |
|- | |- | ||
| − | | dateend || text (datetime) || YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-31 23:59:59) || Data atual || | + | | dateend || text (datetime) || YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-31 23:59:59) || Data atual || || Sim |
|- | |- | ||
| − | | start || numeric || 0 || 0 || linha de inicio da requisição 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 | + | | 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 | + | | number || text || 1721393950 || || Número para ser pesquisado || |
|- | |- | ||
| − | | extensions || text (array) || ('5000','5001') || || lista de ramais selecionados | + | | extensions || text (array) || ('5000','5001') || || lista de ramais selecionados || |
|- | |- | ||
| − | | queues || text (array) || ('atendimento') || || lista de filas selecionadas | + | | queues || text (array) || ('atendimento') || || lista de filas selecionadas || |
|- | |- | ||
| − | | trunks || text (array) || ('SIP/1001','SIP/operadoraX') || || lista de troncos selecionadas | + | | trunks || text (array) || ('SIP/1001','SIP/operadoraX') || || lista de troncos selecionadas || |
|- | |- | ||
| − | | type || text (array) || ('IN','OUT','INTERNO') || || lista de tipo | + | | type || text (array) || ('IN','OUT','INTERNO') || || lista de tipo || |
|- | |- | ||
| − | | status || text (array) || ('BUSY','NOANSWER') || || lista de status das chamadas | + | | status || text (array) || ('BUSY','NOANSWER') || || lista de status das chamadas || |
|} | |} | ||
| Linha 53: | Linha 53: | ||
===== Exemplo ===== | ===== Exemplo ===== | ||
| − | http://'''server_IP'''/api/relatorio_analitico.php?number=1721393950 | + | http://'''server_IP'''/api/relatorio_analitico.php?number=1721393950&datestart=2024-01-01%2000:00:00&dateend=2024-01-31%2023:59:59 |
=== Resposta da API === | === Resposta da API === | ||
| Linha 116: | Linha 116: | ||
|} | |} | ||
<br> | <br> | ||
| + | |||
== Gravações == | == Gravações == | ||
Edição atual tal como às 11h41min de 30 de maio de 2024
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 | Obrigatório |
|---|---|---|---|---|---|
| datestart | text (datetime) | YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-01 00:00:00) | Data atual | Sim | |
| dateend | text (datetime) | YYYY-MM-DD HH:mm:ss (Ex.: 2020-12-31 23:59:59) | Data atual | Sim | |
| 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&datestart=2024-01-01%2000:00:00&dateend=2024-01-31%2023:59:59
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"
- "calldate":"2020-09-04 11:35:48",
- }]
}
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
