Obter o Cadastro de uma Linha IP

Endereço de Chamada da API

/api/manageDevices/API_TOKEN/API_KEY/id_linha

Este Ponto de Acesso irá fornecer o Cadastro Completo de uma Linha IP.
Você deverá especificar o ID DA LINHA IP como último parâmetro da URL.

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/manageDevices/API_TOKEN/API_KEY/id_linha

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/manageDevices/3'

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

Retorno JSON

{
   "error":0,
   "reason":"OK",
   "records":1,
   "data":[
      {
         "id":"3",
         "id_cliente":"3",
         "id_plano":"0",
         "id_audio":"0",
         "id_perfil_horario":"0",
         "tipo_tar":"1",
         "ddd_local":"5521",
         "tech":"SIP",
         "username":"rafael9002",
         "password":"mPoxEsgV1d",
         "domain":"dynamic",
         "port":"0",
         "rtp_symmetric":"1",
         "nat":"auto_force_rport,auto_comedia",
         "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":"1",
         "allow_record_movel":"1",
         "allow_spy":"0",
         "reproduzir_erros":"1",
         "voicemail_status":"0",
         "voicemail_password":"",
         "cadeado_status":"0",
         "cadeado_password":"",
         "portal_password":"99966123",
         "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":"021985699899",
         "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":"9002",
         "dtmf_mode":"rfc4733",
         "volume_tx":"-21",
         "volume_rx":"-21",
         "funcionalidade":"0",
         "funcionalidade_id":"0",
         "habilita_npn_fixo":"0",
         "habilita_npn_movel":"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
id_cliente	ID do Cliente
nome_fantasia	Nome do Cliente
records	Quantidade de Linhas para esse Cliente
data	Array contendo as Linhas solicitadas
id	ID da Linha
id_plano	ID do Plano de Prefixos Customizado
id_audio	ID do Audio a ser reproduzido antes de cada Ligação
id_perfil_horario	ID do Perfil de Horário da Linha
tipo_tar	Tipo de Tarifação: 0 - SALDO DA LINHA \| 1 - SALDO DO CLIENTE
ddd_local	DDD Local da Linha
tech	Tecnologia utilizada pela Linha (Ex: DAHDI, SIP, DGV)
username	Nome de Usuário da Linha
password	Senha da Linha
domain	Endereço IP da Linha
port	Porta de Conexão da Linha
rtp_symmetric	Ativar RTP Simétrico: 0 - desativado \| 1 - ativado
nat	Tipo de NAT utilizado pela Linha
techprefix	Techprefix da Linha caso a mesma seja por IP + TECHPREFIX
saldo	Saldo atual da Linha, se tipo_tar = 0
voip	Permitir chamadas IP x IP: 0 - desativado \| 1 - ativado
fixo_local	Permitir chamadas Fixo Local
fixo_ldn	Permitir chamadas Fixo Longa Distância
movel_local	Permitir chamadas Móvel Local
movel_ldn	Permitir chamadas Móvel Longa Distância
fixo_ddi	Permitir chamadas Fixo DDI
movel_ddi	Permitir chamadas Móvel DDI
simultaneas	Chamadas simultâneas permitidas pela Linha
allow_transfer	Permitir Transferência
allow_record_fixo	Gravar chamadas para Fixo
allow_record_movel	Gravar chamadas para Móvel
allow_spy	Permitir que essa Linha realize escuta
reproduzir_erros	Reproduzir erros na Linha
voicemail_status	Status do Correio de Voz: 0 - inativo \| 1 - ativo
voicemail_password	Senha do Correio de Voz
cadeado_status	Status do Cadeado
cadeado_password	Senha do Cadeado
portal_password	Senha do Portal de Voz
ring_falso	Reproduzir Ring Falso
max_calltime	Tempo máximo em uma ligação
max_ringtime	Tempo máximo chamando antes de considerar NÃO ATENDIDO
max_ringtime_voip	Tempo máximo que essa linha irá ser chamada
codecs	Codecs habilitados para a Linha
sigame_always_st	Estado do Siga-ME Sempre
sigame_always_dst	Destino do Siga-ME Sempre
sigame_busy_st	Estado do Siga-ME Ocupado
sigame_busy_dst	Destino do Siga-ME Ocupado
sigame_noanswer_st	Estado do Siga-ME Não Atende
sigame_noasnwer_dst	Destino do Siga-ME Não Atende
sigame_offline_st	Estado do Siga-ME OFFLINE
sigame_offline_dst	Destino do Siga-ME OFFLINE
callerid_name	Nome a ser exibido em Ligações Internas
callerid_num	Número a ser exibido em Ligações Externas
linha_ip	Número da Linha IP / RAMAL
dtmf_mode	Modo de DTMF
volume_tx	Volume de Transmissão de áudio
volume_rx	Volume de Recepção de áudio
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
funcionalidade_id	ID de Registro de Funcionalidade da Linha, quando aplicável
status	Status atual da Linha IP