Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


...

Tip
titleEndereço de Chamada da API

/api/onlineCalls/API_TOKEN/API_KEY

...


Este Ponto de Acesso irá fornecer uma listagem de todas as Ligações em Andamento do momento. 

Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:

Info
titleEndereço da API exemplo

https://sip.nextbilling.com.br/api/onlineCalls/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:

Panel
titleExemplo de chamada a API utilizando cURL
$ curl -X GET 'https://sip.nextbilling.com.br/api/onlineCalls/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/3?id_record=366'

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

Code Block
languagegroovy
themeMidnight
titleRetorno JSON
{

...


   "error":0,

...


   "reason":"OK",

...


   "ringing":1,

...


   "talking":1,

...


   "records":2,

...


   "data":[

...


      {
         "id":"289",

...


         "starttime":"2018-01-14 17:25:30",

...


         "source":"suporte",

...


         "destination":"5521980987000",

...


         "region":"Brasil M\u00f3vel - RJ 21",

...


         "status":0,

...


         "status_text":"RINGING",

...


         "codec":"SETUP"

...


      },{

...


         "id":"290",

...


         "starttime":"2018-01-14 17:23:30",

...


         "source":"comercial_sup",

...


         "destination":"551140020022",

...


         "region":"Brasil Fixo - RJ 11",

...


         "status":1,

...


         "status_text":"TALKING",

...


         "codec":"g729->g729"

...


      }
   ]
}


Desligando uma Ligação em Andamento

...


Tip

...

titleEndereço de Chamada da API

DELETE /api/onlineCalls/API_TOKEN/API_KEY/id_chamada

Para desligar uma chamada em andamento, basta enviar um HTTP DELETE para o endereço da API de Ligações Online, informando o ID da chamada que você poderá obter em Listar Chamadas em Andamento.

...