Page Comparison

...

Tip

title	Endereço de Chamada da API

/api/listDevices/API_TOKEN/API_KEY(/id_assinante)

...

Este Ponto de Acesso irá fornecer uma listagem das Linhas cadastradas 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

title	Endereço da API exemplo

https://sip.nextbilling.com.br/api/listDevices/API_TOKEN/API_KEY/id_cliente
ou
https://sip.nextbilling.com.br/api/listDevices/API_TOKEN/API_KEY/id_cliente?id_record=1

Parâmetros HTTP:

id_record: Opcional: ID específico da Linha IP desejada

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

title	Exemplo de chamada a API utilizando cURL

$ curl -X GET 'https://sip.nextbilling.com.br/api/listDevices/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

language	groovy
theme	Midnight
title	Retorno JSON

...


   "error":0,

...


   "reason":"OK",

...


   "records":1,

...


   "data":[

...


      {
         "id_cliente":3,

...


         "nome_fantasia":"NEXTBILLING",

...


         "records":1,

...


         "data":[

...


            {
               "id":"1",

...


               "id_cliente":"3",

...


               "id_plano":"0",

...


               "id_audio":"0",

...


               "id_perfil_horario":"0",

...


               "tipo_tar":"1",

...


               "ddd_local":"5521",

...


               "tech":"SIP",

...


               "username":"fernando9000",

...


               "domain":"dynamic",

...


               "port":"0",

...


               "rtp_symmetric":"0",

...


               "nat":"auto_force_rport",

...


               "techprefix":"",

...


               "saldo":"0.00000",

...


               "voip":"1",

...


               "fixo_local":"1",

...


               "fixo_ldn":"1",

...


               "movel_local":"1",

...


               "movel_ldn":"1",

...


               "fixo_ddi":"0",

...


               "movel_ddi":"0",

...


               "simultaneas":"0",

...


               "allow_transfer":"1",

...


               "allow_video":"1",

...


               "allow_record_fixo":"0",

...


               "allow_record_movel":"0",

...


               "allow_spy":"0",

...


               "reproduzir_erros":"1",

...


               "voicemail_status":"0",

...


               "voicemail_password":"",

...


               "cadeado_status":"0",

...


               "cadeado_password":"",

...


               "portal_password":"56279540",

...


               "ring_falso":"0",

...


               "max_calltime":"7200",

...


               "max_ringtime":"45",

...


               "max_ringtime_voip":"30",

...


               "codecs":"g729;ulaw;alaw",

...


               "is_webrtc":"0",

...


               "sigame_always_st":"0",

...


               "sigame_always_dst":"",

...


               "sigame_busy_st":"0",

...


               "sigame_busy_dst":"",

...


               "sigame_noanswer_st":"0",

...


               "sigame_noanswer_dst":"",

...


               "sigame_offline_st":"0",

...


               "sigame_offline_dst":"",

...


               "callerid_name":"",

...


               "callerid_num":"",

...


               "linha_ip":"9000",

...


               "dtmf_mode":"rfc4733",

...


               "volume_tx":"-21",

...


               "volume_rx":"-21",

...


               "funcionalidade":"0",

...


               "funcionalidade_id":"0",

...


               "status":"1"

...

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.id	ID da Linha
data.data.id_plano	ID do Plano de Prefixos Customizado
data.data.id_audio	ID do Audio a ser reproduzido antes de cada Ligação
data.data.id_perfil_horario	ID do Perfil de Horário da Linha
data.data.tipo_tar	Tipo de Tarifação: 0 - SALDO DA LINHA

\| 1 - SALDO DO CLIENTE
data.data.ddd_local	DDD Local da Linha
data.data.username	Nome de Usuário da Linha
data.data.domain	Endereço IP da Linha
data.data.port	Porta de Conexão da Linha
data.data.nat	Tipo de NAT utilizado pela Linha
data.data.techprefix	Techprefix da Linha caso a mesma seja por IP + TECHPREFIX
data.data.voip	Permitir chamadas IP x IP: 0 - desativado

\| 1 - ativado
data.data.fixo_local	Permitir chamadas Fixo Local
data.data.fixo_ldn	Permitir chamadas Fixo Longa Distância
data.data.movel_local	Permitir chamadas Móvel Local
data.data.movel_ldn	Permitir chamadas Móvel Longa Distância
data.data.fixo_ddi	Permitir chamadas Fixo DDI
data.data.movel_ddi	Permitir chamadas Móvel DDI
data.data.simultaneas	Chamadas simultâneas permitidas pela Linha
data.data.allow_transfer	Permitir Transferência
data.data.allow_record_fixo	Gravar chamadas para Fixo
data.data.allow_record_movel	Gravar chamadas para Móvel
data.data.allow_spy	Permitir que essa Linha realize escuta
data.data.reproduzir_erros	Reproduzir erros na Linha
data.data.voicemail_status	Status do Correio de Voz: 0 - inativo

\| 1 - ativo
data.data.voicemail_password	Senha do Correio de Voz
data.data.cadeado_status	Status do Cadeado
data.data.cadeado_password	Senha do Cadeado
data.data.portal_password	Senha do Portal de Voz
data.data.ring_falso	Reproduzir Ring Falso
data.data.max_calltime	Tempo máximo em uma ligação
data.data.max_ringtime	Tempo máximo chamando antes de considerar NÃO ATENDIDO
data.data.max_ringtime_voip	Tempo máximo que essa linha irá ser chamada
data.data.codecs	Codecs habilitados para a Linha
data.data.sigame_always_st	Estado do Siga-ME Sempre
data.data.sigame_always_dst	Destino do Siga-ME Sempre
data.data.sigame_busy_st	Estado do Siga-ME Ocupado
data.data.sigame_busy_dst	Destino do Siga-ME

Ocupado

Ocupado
data.data.sigame_noanswer_st	Estado do Siga-ME Não

Atende

Atende
data.data.sigame_noasnwer_dst	Destino do Siga-ME Não

Atende

Atende
data.data.sigame_offline_st	Estado do Siga-ME

OFFLINE

OFFLINE
data.data.sigame_offline_dst	Destino do Siga-ME

OFFLINE

OFFLINE
data.data.callerid_name	Nome a ser exibido em Ligações Internas
data.data.callerid_num	Número a ser exibido em Ligações Externas
data.data.linha_ip	Número da Linha IP / RAMAL
data.data.dtmf_mode	Modo de DTMF
data.data.volume_tx	Volume de Transmissão de áudio
data.data.volume_rx	Volume de Recepção de áudio
data.data.funcionalidade	Tipo de Funcionalidade da Linha: 0 - LINHA IP / RAMAL 1 - PORTAL DE VOZ 2 - CENTRAL CALLINGCARD 3 - MENU DE URA - IVR 4 - FILA DE ATENDIMENTO 5 - CABINE TELEFÔNICA
data.data.funcionalidade_id	ID de Registro de Funcionalidade da Linha, quando aplicável
data.data.status	Status atual da Linha IP

Versions Compared

Old Version 1

New Version Current

Key