Page Comparison

...

Tip

title	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:

Info

title	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:

Panel

title	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:

Code Block

language	groovy
theme	Midnight
title	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

id id_hie

_cliente	ID do Cliente
nome_fantasia	Nome do Cliente

tipo

2 - Revenda

4 - Assinante

records	Quantidade de Linhas para esse Cliente
data	Array contendo as Linhas solicitadas
id	ID da

Revenda

id_
Linha

origem

plano	ID do

Tipo

Plano de

Origem

id_
Prefixos Customizado

vinculo

audio	ID do

Vinculo de Cliente

id_
Audio a ser reproduzido antes de cada Ligação

vendedor

perfil_horario	ID do

Vendendor

tem_ramal

Acesso a Ramais: 0 - Inativo

1 - Ativo

tem_did

Acesso a DID: 0 - Inativo

1 - Ativo

tem_sms

Acesso a SMS: 0 - Inativo

1 - Ativo

tem_escuta

Tem Escuta de Chamadas: 0 - Inativo

1 - Ativo

tem_gravacao

Pode Gravar Chamadas: 0 - Inativo

1 - Ativo

tem_sigame

Acesso a Siga-ME: 0 - Inativo

1 - Ativo

tem_fila

Acesso a Filas de Atendimento: 0 - Inativo

1 - Ativo

tem_ura

Acesso a URA: 0 - Inativo

1 - Ativo

tem_portal

Acesso a Portal de Voz: 0 - Inativo

1 - Ativo

tem_callingcard

Acesso a CallingCards: 0 - Inativo

1 - Ativo

tem_grupo_captura

Acesso a Grupos de Captura: 0 - Inativo

1 - Ativo

tem_grupo_chamada

Acesso a Grupos de Chamada: 0 - Inativo

1 - Ativo

tem_campanha_sms

Acesso a Campanhas de SMS: 0 - Inativo

1 - Ativo

tem_campanha_voz

Acesso a Campanhas de Voz: 0 - Inativo

1 - Ativo

tem_conferencia

Acesso a Salas de Conferência: 0 - Inativo

1 - Ativo

tem_provisionamento

Acesso a Provisionamento: 0 - Inativo

1 - Ativo

tem_report

Flag utilizada internamente pelo Sistema

status

Status do Cliente: 0 - Inativo

1 - Ativo

finance.tipo_tar

Tipo Financeiro: 0 - PRE-PAGO

1 - PÓS-PAGO

2 - FRANQUIA

finance.id_plano

ID do Plano de Prefixos

finance.id_plano_sms

ID do Plano de SMS

finance.habilita_npn

Permite Consulta a Portabilidade Móvel

finance.habilita_npn_fixo

Permite Consulta a Portabilidade Fixo

finance.ini_f

Tarifação Fixo Inicial

finance.inc_f

Incremento Fixo

finance.tmp_f

Tolerância Fixo

finance.ini_c

Tarifação Móvel Inicial

finance.inc_c

Incremento Móvel

finance.tmp_c

Tolerância Móvel

finance.ini_f_ddi

Tarifação Fixo DDI Inicial

finance.inc_f_ddi

Incremento Fixo DDI

finance.tmp_f_ddi

Tolerância Fixo DDI

finance.ini_c_ddi

Tarifação Móvel DDI Inicial

finance.inc_c_ddi

Incremento Móvel DDI

finance.tmp_c_ddi

Tolerância Móvel DDI

finance.allow_loss_call

Permitir Preço de Venda menor do que o Custo

0 - Não

1 - Sim

finance.id_perfil

ID do Perfil Financeiro

finance.sipcode_no_prefix

SIP Code em caso de prefixo não existe

finance.franquia_fixo_local

ID da Franquia Fixo Local

finance.franquia_fixo_ldn

ID da Franquia Fixo Longa Distância

finance.franquia_movel_local

ID da Franquia Móvel Local

finance.franquia_movel_ldn

ID da Franquia Móvel Longa Distância

finance.franquia_fixo_ddi

ID da Franquia Fixo DDI

finance.franquia_movel_ddi

ID da Franquia Móvel DDI

finance.franquia_fixo_local_used

Minutos Utilizados na Franquia Fixo Local

finance.franquia_fixo_ldn_used

Minutos Utilizados na Franquia Fixo Longa Distância

finance.franquia_movel_local_used

Minutos Utilizados na Franquia Móvel Local

finance.franquia_movel_ldn_used

Minutos Utilizados na Franquia Móvel Longa Distância

finance.franquia_fixo_ddi_used

Minutos Utilizados na Franquia Fixo DDI

finance.franquia_movel_ddi_used

Minutos Utilizados na Franquia Móvel DDI

finance.franquia_last_reset

Inicio do Ciclo da Franquia

finance.disk_space

Espaço em disco contratado (em MB)

0 - Ilimitado

finance.available_disk_space

Espaço em disco disponível para o Cliente

finance.call_only_local

Permitir IPxIP apenas para Linhas do Cliente

1 - Sim

0 - Global

finance.max_devices

Máximo de Linhas que o Cliente pode criar

0 - Ilimitado

users.id

ID do Usuário

users.id_perfil

ID do Perfil de Acesso

users.username

Usuário de Acesso

users.nome_completo

Nome Completo do Usuário

users.root

1 - Usuário Principal

0 - Usuário Adicional

users.logins

Quantidade de Acessos ao Painel

users.last_login

Último acesso ao Painel (unix timestamp)

users.last_attempt

Último acesso com senha inválida (unix timestamp)

users.failed_attempts

Quantidade de Tentativas de Acesso com senha inválida

users.api_access

Tem acesso a API? 0 - Não

1 - Sim

users.can_spy

Pode realizar escuta de ligações? 0 - Não

1 - Sim

users.api_token

API TOKEN para acesso a API

users.api_key

API KEY para acesso a API

users.status

Status atual do usuário

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

Versions Compared

Old Version 1

New Version 2

Key