Relatorio de Chamadas - CDR
Endereço de Chamada da API
/api/cdr/API_TOKEN/API_KEY(/id_assinante)
Este Ponto de Acesso irá fornecer uma listagem do CDR (Relatório de Ligações). Se estiver utilizando Tokens de Acesso do Nível Master ou Nível Revenda, poderá especificar o ID DO CLIENTE como último parâmetro da URL para obter o CDR de um Cliente de ID especifico.
Caso essa API seja chamada utilizando os Tokens de Acesso do Nível Assinante, não é necessário informar o ID e será retornado o CDR do Assinante em questão.
Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:
Endereço da API exemplo
https://sip.nextbilling.com.br/api/cdr/API_TOKEN/API_KEY
ou
https://sip.nextbilling.com.br/api/cdr/API_TOKEN/API_KEY?date_ini=2015-03-01&date_end=2015-03-30&start=0&limit=100&time_ini=08:00:00&time_end=23:50:00&id_record=3
Parâmetros:
- date_ini: Data Inicial
- time_ini: Hora Inicial
- date_end: Data Final
- time_end: Hora Final
- start: Exibir registros a partir dessa contagem
- limit: Limitar de registros a ser retornados pela chamada
- device_id: Opcional: Filtrar CDR pelo ID específico de uma linha
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
$ curl -X GET 'https://sip.nextbilling.com.br/api/cdr/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629?date_ini=2018-01-01&date_end=2018-02-01&time_ini=&time_end='
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
{ "error": 0, "reason": "OK", "total_records": 647879, "total_time": 590522711, "total_time_text": "9.842.045 min 11 seg", "total_value": "3.148.895,40924", "total_cost_time": 590522711, "total_cost_time_text": "9.842.045 min 11 seg", "total_cost_value": "1.132.214,31718", "total_profit_on_ass": "2.016.681,09206", "limit": 2, "offset": 0, "records": 2, "data": [ { "customer_id": 10, "calldate": "2021-12-02 06:52:35", "clid": "8125821426", "source": "8125821426", "destination": "5514929141411", "region": "BRASIL MÓVEL 14 - VILA MANUELA DO LESTE", "type": "c", "real_duration": "1484", "duration": "1484", "duration2": "24 min 44 seg", "total_price": "8,33958", "price_per_minute": "0,33718", "cost_duration": "1484", "cost_duration2": "24 min 44 seg", "cost_total_price": "3,70382", "cost_price_per_minute": "0,14975", "profit_on_customer": "4,63576", "codec": "pcmu", "prefix": "55149", "source_ip": "160.234.200.196", "useragent": "Opera/9.94 (X11; Linux x86_64; sl-SI) Presto/2.11.210 Version/10.00" }, { "customer_id": 10, "calldate": "2021-12-01 15:40:44", "clid": "11974916015", "source": "11974916015", "destination": "557446502096", "region": "BRASIL FIXO 74 - VILA ALMA", "type": "f", "real_duration": "1602", "duration": "1602", "duration2": "26 min 42 seg", "total_price": "10,01517", "price_per_minute": "0,37510", "cost_duration": "1602", "cost_duration2": "26 min 42 seg", "cost_total_price": "2,12879", "cost_price_per_minute": "0,07973", "profit_on_customer": "7,88638", "codec": "gsm", "prefix": "55744", "source_ip": "244.37.156.223", "useragent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_5_7 rv:6.0) Gecko/20181212 Firefox/37.0" } ] }
Campo | Descrição |
---|---|
error | 1 em caso de erro |
reason | Descrição caso tenha ocorrido algum erro |
total_records | Total de Registros encontrados na pesquisa sem a paginação solicitada |
total_time | Tempo total das Ligações |
total_value | Valor total das Ligações |
total_cost_time | Tempo total de custo para o Master |
total_cost_value | Valor total de Custo para o Master |
total_profit_on_ass | Valor total de Lucro sobre o Assinante |
records | Total de registrados retornados nessa chamada |
data.customer_id | ID do Assinante |
data.type | Tipo da Ligação: f - fixo, c - móvel, i - ddi |
data.real_duration | Tempo real da Ligação sem a Tarifação aplicada |
data.duration | Tempo da Ligação com a Tarifação aplicada |
data.total_price | Valor total da Ligação para o Assinante |
data.price_per_minute | Valor por Minuto da Ligação |
data.cost_duration | Tempo Total de Custo para o Master |
data.cost_total_price | Valor Total de Custo para o Master |
data.cost_price_per_minute | Valor por Minuto para o Master |
data.profit_on_customer | Valor de Lucro sobre o Assinante |