...
| Tip | ||
|---|---|---|
| ||
/api/listDevicesRegistered/API_TOKEN/API_KEY(/id_assinante) |
...
Este Ponto de Acesso irá fornecer uma listagem das Linhas que estão Online e Offline no Sistema.
Para consumir esses dados, informar o ID do Cliente é obrigatório. Você poderá informar na query http o parâmetro id_record para filtrar por uma Linha IP em especifico.
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 | ||
|---|---|---|
| ||
Parâmetros HTTP:
|
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 | ||
|---|---|---|
| ||
$ curl -X GET 'https://sip.nextbilling.com.br/api/listDevicesRegistered/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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ |
...
"error":0, |
...
"reason":"OK", |
...
"records":1, |
...
"data":[ |
...
{ "id_cliente":3, |
...
"nome_fantasia":"NEXTBILLING", |
...
"records":1, |
...
"data":[ |
...
{ "device_id": "19", |
...
"device_username": "linha9008", |
...
"latency_ms": "-1", |
...
"last_registration": "2020-04-22 06:27:04", |
...
"sip_contact": "201.49.213.217:5060", |
...
"device_registered": |
...
true }, { "device_id": "21", |
...
"device_username": "9009", |
...
"latency_ms": "-1", |
...
"last_registration": null, |
...
"sip_contact": "", |
...
"device_registered": |
...
false } ] } ] } |
| Campo | Descrição |
|---|---|
| error | 1 em caso de erro |
| reason | Descrição caso tenha ocorrido algum erro |
| records | Total de registrados retornados nessa chamada |
| data.id_cliente | ID do Cliente |
| data.nome_fantasia | Nome do Cliente |
| data.records | Quantidade de Linhas para esse Cliente |
| data.data | Array contendo as Linhas solicitadas |
| data.data.device_id | ID da Linha |
| data.data.device_username | Nome de Usuário da Linha |
| data.data.latency_ms | Tempo de Resposta da Linha (-1 se não responde) |
| data.data.last_registration | Último REGISTER recebido (null se indisponível) |
| data.data.sip_contact | Endereço SIP que a linha pode ser encontrada |
| data.data.device_registered | TRUE se registrada, FALSE se não registrada |