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

Endereço de Chamada da API

/api/cdrDid/API_TOKEN/API_KEY(/id_cliente) 

 

Este Ponto de Acesso irá fornecer uma listagem do CDR DID (Relatório de Ligações DID - Entrantes).
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 DID 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/cdrDid/API_TOKEN/API_KEY
 ou
https://sip.nextbilling.com.br/api/cdrDid/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

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: Limite de registros a ser retornados pela chamada
  • id_record: Opcional: Id do Assinante ou ID do registro, 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
$ curl -X GET 'https://sip.nextbilling.com.br/api/cdrDid/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629'

Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "total_records":279,
   "total_time":40898,
   "total_time_text":"681 min 38 seg",
   "total_value":"0,00000",
   "total_value_connection":"0,00000",
   "limit":1,
   "offset":0,
   "records":1,
   "data":[
      {
         "calldate":"2018-03-14 11:41:12",
         "clid":"DID: 2199000000 => 3090007 <2199000000>",
         "source":"552199000000",
         "destination":"55212199000000",
         "region":"DID 552130900017: 2199000000 -> URA: Ura Principal",
         "type":"c",
         "duration":"479",
         "duration2":"7 min 59 seg",
         "total_price":"0,00000",
         "connection_price":"0,00000",
         "price_per_minute":"0,00000",
         "prefix":"55219",
         "source_ip":"177.126.XXX.0",
         "useragent":"Plataforma IP NextBilling",
         "disposition":"1"
      }
   ]
}
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
recordsTotal de registrados retornados nessa chamada
data.typeTipo da Ligação: f - fixo, c - móvel, i - ddi
data.durationTempo da Ligação com a Tarifação aplicada
data.total_priceValor total da Ligação
data.connection_priceValor cobrado na Conexão
data.price_per_minuteValor cobrado por Minuto
data.disposition

Status da Chamada:

 

  • 0 - Cancelado
  • 1 - Atendido
  • 2 - Ocupado
  • 3 - Não Atendido
  • 4 - Indisponível
  • 5 - Congestionado
  • X - Desconhecido