[ API ] Relatório 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
id_record: Opcional: Id do Assinante quando aplicável
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:
Exemplo de chamada a API utilizando cURL
|
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
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_reseller_time | Tempo tempo das Ligações para a Revenda |
total_reseller_value | Valor total das Ligações para a Revenda |
total_cost_time | Tempo total de custo para o Master |
total_cost_value | Valor total de Custo para o Master |
total_profit_on_rev | Valor total de Lucro sobre a Revenda |
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.type2 | Tipo de Região da Ligação |
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.reseller_duration | Tempo da Ligação para a Revenda |
data.reseller_total_price | Valor total da Ligação para a Revenda |
data.reseller_price_per_minute | Valor por Minuto para a Revenda |
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 |
data.profit_on_reseller | Valor de Lucro sobre a Revenda |