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:
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" } ] }