Endereço de Chamada da API

/api/cdrDisconnection/API_TOKEN/API_KEY(/id_assinante)

Este Ponto de Acesso irá fornecer uma listagem do CDR de Desconexão (Relatório de Desconexão). 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 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/cdrDisconnection/API_TOKEN/API_KEY
ou
https://sip.nextbilling.com.br/api/cdrDisconnection/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: Limitar 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/cdrDisconnection/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": 17096080,
    "limit": 2,
    "offset": 0,
    "records": 2,
    "data": [
        {
            "calldate": "2022-04-12 17:17:36",
            "clid": "linhateste",
            "source": "linhateste",
            "destination": "5521980989000",
            "region": "Brasil Movel - RJ 21",
            "type": "c",
            "pdd": "0",
            "disposition": "CONGESTION",
            "hangup_cause": "SIP 603 - Declined",
            "is_404": "0",
            "sip_code": "603",
            "source_ip": "177.130.95.179",
            "useragent": "Bria 5 release 5.8.3 stamp 102649",
            "customer_id": 3,
            "trunk_id": 44
        },
        {
            "calldate": "2022-04-12 17:17:36",
            "clid": "linhateste",
            "source": "linhateste",
            "destination": "5521980989000",
            "region": "Brasil Movel - RJ 21",
            "type": "c",
            "pdd": "0",
            "disposition": "CONGESTION",
            "hangup_cause": "SIP 408 - Request Timeout",
            "is_404": "0",
            "sip_code": "408",
            "source_ip": "177.130.95.179",
            "useragent": "Bria 5 release 5.8.3 stamp 102649",
            "customer_id": 3,
            "trunk_id": 44
        }
    ]
}

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
records	Total de registrados retornados nessa chamada
data.customer_id	ID do Assinante
data.trunk_id	ID do Fornecedor que a chamada foi enviada

Browser not supported