Page tree
Skip to end of metadata
Go to start of metadata

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
  • id_device: 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:

Exemplo de chamada a API utilizando cURL
$ 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:

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "total_records":1,
   "total_time":540,
   "total_time_text":"9 min 00 seg",
   "total_value":"2,10000",
   "total_reseller_time":540,
   "total_reseller_time_text":"9 min 00 seg",
   "total_reseller_value":"4,40000",
   "total_cost_time":540,
   "total_cost_time_text":"9 min 00 seg",
   "total_cost_value":"0,00000",
   "total_profit_on_rev":"4,40000",
   "total_profit_on_ass":"2,10000",
   "limit":100,
   "offset":0,
   "records":1,
   "data":[
      {
         "customer_id":4,
         "calldate":"2018-01-31 18:03:52",
         "clid":"teste10next <teste10next>",
         "source":"teste10next",
         "destination":"5521985699899",
         "region":"Brasil M\u00f3vel - RJ 02",
         "type":"c",
         "type2":"movel_ldn",
         "real_duration":"10",
         "duration":"30",
         "duration2":"0 min 30 seg",
         "total_price":"0,30000",
         "price_per_minute":"0,60000",
         "reseller_duration":"30",
         "reseller_duration2":"0 min 30 seg",
         "reseller_total_price":"0,25000",
         "reseller_price_per_minute":"0,50000",
         "cost_duration":"30",
         "cost_duration2":"0 min 30 seg",
         "cost_total_price":"0,00000",
         "cost_price_per_minute":"0,00000",
         "profit_on_customer":"0,30000",
         "profit_on_reseller":"0,25000",
         "codec":"g729->g729",
         "prefix":"55219",
         "source_ip":"179.236.34.165",
         "useragent":"PolycomSoundPointIP-SPIP_550-UA\/4.0.13.1445"
      }
   ]
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
total_recordsTotal de Registros encontrados na pesquisa sem a paginação solicitada
total_timeTempo total das Ligações
total_valueValor total das Ligações
total_reseller_timeTempo tempo das Ligações para a Revenda
total_reseller_valueValor total das Ligações para a Revenda
total_cost_timeTempo total de custo para o Master
total_cost_valueValor total de Custo para o Master
total_profit_on_revValor total de Lucro sobre a Revenda
total_profit_on_assValor total de Lucro sobre o Assinante
recordsTotal de registrados retornados nessa chamada
data.customer_idID do Assinante
data.typeTipo da Ligação: f - fixo, c - móvel, i - ddi
data.type2Tipo de Região da Ligação
data.real_durationTempo real da Ligação sem a Tarifação aplicada
data.durationTempo da Ligação com a Tarifação aplicada
data.total_priceValor total da Ligação para o Assinante
data.price_per_minuteValor por Minuto da Ligação
data.reseller_durationTempo da Ligação para a Revenda
data.reseller_total_priceValor total da Ligação para a Revenda
data.reseller_price_per_minuteValor por Minuto para a Revenda
data.cost_durationTempo Total de Custo para o Master
data.cost_total_priceValor Total de Custo para o Master
data.cost_price_per_minuteValor por Minuto para o Master
data.profit_on_customerValor de Lucro sobre o Assinante
data.profit_on_resellerValor de Lucro sobre a Revenda