Endereço de Chamada da API

/api/profitGateways/API_TOKEN/API_KEY(/id_assinante)

Este Ponto de Acesso irá fornecer uma listagem do Relatório de Rentabilidade por Rota.

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/profitGateways/API_TOKEN/API_KEY
ou
https://sip.nextbilling.com.br/api/profitGateways/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
src: Filtrar por número de Origem
dst: Filtrar por número de Destino
call_type: Tipo de Ligação. (f - FIXO | c - MOVEL | i - DDI | if - DDI FIXO | ic - DDI MOVEL)
gateways: Array de IDs de Fornecedores. Ex [1,69,44,369]
customers: Array de IDs de Assinantes. Ex [10,19,144,1369]

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/profitGateways/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629?gateways[]=1&gateways[]=19'

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

Retorno JSON

{
    "error": 0,
    "reason": "OK",
    "total_records": 5,
    "records": 5,
    "data": [
        {
            "gateway_id": "41",
            "gateway_name": null,
            "calls_count": "238547",
            "duration": "217578981",
            "payed_duration": 217578981,
            "avg_payed_duration": 912,
            "total_cost": "417185.72123"
        },
        {
            "gateway_id": "5",
            "gateway_name": "Balistreri-Schuster Inc - 220.115.171.252",
            "calls_count": "238094",
            "duration": "216748518",
            "payed_duration": 216748518,
            "avg_payed_duration": 910,
            "total_cost": "415391.17954"
        },
        {
            "gateway_id": "22",
            "gateway_name": "Bergstrom and Sons and Sons - 58.205.85.64",
            "calls_count": "238784",
            "duration": "217907337",
            "payed_duration": 217907337,
            "avg_payed_duration": 912,
            "total_cost": "416856.89975"
        },
        {
            "gateway_id": "11",
            "gateway_name": "Bergstrom, Fisher and Steuber Group - 158.163.85.191",
            "calls_count": "239136",
            "duration": "218049819",
            "payed_duration": 218049819,
            "avg_payed_duration": 911,
            "total_cost": "418669.61230"
        },
        {
            "gateway_id": "9",
            "gateway_name": "Borer-Jerde Ltd - 112.189.98.177",
            "calls_count": "240117",
            "duration": "219455029",
            "payed_duration": 219455029,
            "avg_payed_duration": 913,
            "total_cost": "420554.90270"
        }
    ]
}

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

Browser not supported