Relatorio de Retorno SIPCodes
Endereço de Chamada da API
/api/cdrSipcodes/API_TOKEN/API_KEY(/id_assinante)
Este Ponto de Acesso irá fornecer uma listagem do Relatório de Retorno de SIPCodes. 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/cdrSipcodes/API_TOKEN/API_KEY
ou
https://sip.nextbilling.com.br/api/cdrSipcodes/API_TOKEN/API_KEY
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:
$ curl -X GET 'https://sip.nextbilling.com.br/api/cdrSipcodes/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:
{ "error": 0, "reason": "OK", "total_records": 3, "records": 3, "data": [ { "customer_id": "10", "customer_name": "TESTE", "sip_code": "486", "sip_reason": "Busy Here", "total": "1254" }, { "customer_id": "10", "customer_name": "TESTE", "sip_code": "503", "sip_reason": "Internal Error", "total": "369" }, { "customer_id": "10", "customer_name": "TESTE", "sip_code": "503", "sip_reason": "Low balance", "total": "1954" } ] }
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 |