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 irá fornecer o Saldo de uma Linha IP. Alguns equipamentos e softphones tem a opção de utilizar uma API para consultar e exibir o Saldo de uma ou mais Linhas no visor do Equipamento.
Para utilizar essa API, você deverá informar o em API_TOKEN o Login/Usuário da Linha, e o parâmetro API_KEY deverá ser formado pela função MD5(USUÁRIO_DA_LINHA:SENHA_DA_LINHA).

Um exemplo seria:

  • Usuário: linhaip1
  • Senha: Senha#Da#Linha.IP1

Baseado nos dados acima, teríamos a seguinte URL de chamada para a API:

  • API_TOKEN: linhaip1
  • Função MD5(linhaip1:Senha#Da#Linha.IP1) = f9f0115a96fcdc8146188f96fc96f96b
  • API_KEY: f9f0115a96fcdc8146188f96fc96f96b
  • URL Final: /api/getDeviceBalance/linhaip1/f9f0115a96fcdc8146188f96fc96f96b

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/linhaip1/f9f0115a96fcdc8146188f96fc96f96b

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/getDeviceBalance/linhaip1/f9f0115a96fcdc8146188f96fc96f96b'

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

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

IMPORTANTE

Essa funcionalidade só irá funcionar para equipamentos que possuem suporte a esse tipo de função. Nem todos os equipamentos podem fazer uso dessa tecnologia.