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

Endereço de Chamada da API

/api/getDeviceBalance/API_TOKEN/API_KEY

 

Este Ponto de Acesso fornece uma API para você obter o Saldo de uma Linha ou Assinante baseado no tipo de tarifação da Linha, e exibir em equipamentos como Softphones e Telefones IP.
Essa API opera utilizando o Login e Senha de uma Linha IP, que irá verificar o tipo de tarifação exibindo o Saldo da seguinte forma:

  • Se a Linha IP for Tarifação por Cliente, irá exibir o Saldo do Assinante
  • Se a Linha IP for Tarifação por Linha, irá exibir o Saldo disponível na própria Linha

No entando, a API Token e API Key utilizado nessa chamada, não é a mesma de outros Pontos da API, e você deverá compor a chamada conforme a descrição a seguir.
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/getDeviceBalance/API_TOKEN/API_KEY

Você deverá utilizar os seguintes dados:

  • API_TOKEN: Login da Linha IP. No nosso exemplo iremos utilizar o login nextbilling.
  • API_KEY: Será formado utilizando o algoritmo MD5 (pesquise no google por: md5 generator) da seguinte forma: MD5(login_da_linha:senha_da_linha)

Digamos por exemplo que a senha da Linha nextbilling seja nextbilling.1, o resultado da API_KEY seria: 59fd60324d28595417cbb8a265f23a67

E a URL final para obter o saldo da linha seria: https://sip.nextbilling.com.br/api/getDeviceBalance/nextbilling/59fd60324d28595417cbb8a265f23a67

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

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "balance": "77,90"
}
  • No labels