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, 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

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": 44,
    "total_time": 395,
    "total_time_text": "6 min 35 seg",
    "total_value": "0,43016",
    "total_value_connection": "0,00000",
    "limit": 2,
    "offset": 0,
    "records": 2,
    "data": [
        {
            "calldate": "2022-04-12 19:16:17",
            "clid": "5521985699899 <5521985699899>",
            "source": "5521985699899",
            "destination": "5521985699899",
            "region": "DID 08005809200: 5521985699899 -> linhateste",
            "type": "c",
            "duration": "0",
            "duration2": "0 min 00 seg",
            "total_price": "0,00000",
            "connection_price": "0,00000",
            "price_per_minute": "0,88888",
            "prefix": "5699899",
            "source_ip": "179.127.19.117",
            "useragent": "Plataforma IP NextBilling v3.11",
            "disposition": "0"
        },
        {
            "calldate": "2022-04-12 19:11:08",
            "clid": "5521985699899 <5521985699899>",
            "source": "5521985699899",
            "destination": "5521985699899",
            "region": "DID 08005809200: 5521985699899 -> linhateste",
            "type": "c",
            "duration": "0",
            "duration2": "0 min 00 seg",
            "total_price": "0,00000",
            "connection_price": "0,00000",
            "price_per_minute": "0,88888",
            "prefix": "5699899",
            "source_ip": "179.127.19.117",
            "useragent": "Plataforma IP NextBilling v3.11",
            "disposition": "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
records	Total de registrados retornados nessa chamada
data.type	Tipo da Ligação: f - fixo, c - móvel, i - ddi
data.duration	Tempo da Ligação com a Tarifação aplicada
data.total_price	Valor total da Ligação
data.connection_price	Valor cobrado na Conexão
data.price_per_minute	Valor 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

Browser not supported