Versions Compared

Key

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

...

Tip
titleEndereço de Chamada da API

/api/manageDevicesmanageCustomers/API_TOKEN/API_KEY/id_linhacliente


Este Ponto de Acesso irá fornecer o Cadastro Completo de uma Linha IP.
Você um Cliente. Se estiver utilizando Tokens de Acesso do Nível Master ou Nível Revenda, você deverá especificar o ID DA LINHA IPDO CLIENTE como último parâmetro da URL.
Caso essa API seja chamada utilizando os Tokens de Acesso do Nível Assinante, não é necessário informar o ID e será retornado o Cadastro do Assinante em questão.

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/manageDevicesmanageCustomers/API_TOKEN/API_KEY/id_linhacliente

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

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",
   "records":1,
   "data":[
      {
         "id":"3",
         "tipo":"4",
         "id_hie":"2",
         "id_clienteorigem":"31",
         "id_planovinculo":"01",
         "id_audio":"0"_vendedor":"1",
         "data_criacao":"2017-12-19",
         "data_alteracao":"2018-02-06 15:41:27",
         "nome_fantasia":"NEXTBILLING",
         "razao_social":"NEXTBILLING IP SOLUTIONS",
         "cpf":"21780980000162",
         "rg":"isento",
         "dominio":"127.0.0.1",
         "website":"www.nextbilling.com.br",
         "cep":"28990000",
         "endereco":"rod. amaral peixoto",
         "id_perfil_horario"complemento":"51",
         "bairro":"Centro",
         "cidade":"Saquarema",
         "uf":"RJ",
         "pais":"Brasil",
         "telefone":"2130900017",
         "ramal":"",
         "telefone2":"",
         "celular":"",
         "fax":"",
         "celular_sms":"",
         "notificar_sms":"0",
         "contato":"Rafel",
         "email":"rafarodriguesrj@yahoo.com.br",
         "email_st":"0",
         "tipo_taremail2":"",
         "email2_st":"10",
         "dddemail_localfinanceiro":"5521",
         "techemail_financeiro_st":"SIP0",
         "usernametem_ramal":"rafael90021",
         "passwordtem_did":"mPoxEsgV1d1",
         "domaintem_sms":"dynamic1",
         "porttem_escuta":"0",
         "rtptem_symmetricgravacao":"1",
         "nattem_sigame":"auto_force_rport,auto_comedia"1",
         "tem_fila":"1",
         "tem_ura":"1",
         "tem_portal":"1",
         "techprefixtem_callingcard":"1",
         "saldotem_grupo_captura":"0.000001",
         "voiptem_grupo_chamada":"1",
         "fixotem_campanha_localsms":"1",
         "fixotem_campanha_ldnvoz":"1",
         "moveltem_localconferencia":"1",
         "movel_ldntem_provisionamento":"1",
         "moeda":"1",
         "fixo_ddi"country_code":"55",
         "tipo_loja":"0",
         "moveltem_ddireport":"0",
         "status":"1",
         "simultaneas"finance":{
            "tipo_tar":"0",
         "allow_transfer   "id_plano":"2",
            "id_plano_sms":"10",
            "allowhabilita_videonpn":"10",
            "allowhabilita_recordnpn_fixo":"0",
            "saldo":"127.30000",
            "allow_record_movellimite_credito":"0.00",
            "dia_vencimento":"1",
            "allow_spydias_bloqueio":"10",
            "status_bloqueio":"0",
            "reproduziralerta_errosstatus":"10",
            "voicemailalerta_statusvalor":"0.00",
            "simultaneas":"5",
            "voicemail_password"ini_f":"30",
            "inc_f":"6",
            "cadeadotmp_statusf":"0",
            "cadeadoini_passwordc":"30",
            "portalinc_passwordc":"999661236",
            "ringtmp_falsoc":"0",
          "max_calltime  "ini_f_ddi":"30",
            "inc_f_ddi":"72006",
            "maxtmp_f_ringtimeddi":"450",
            "maxini_ringtimec_voipddi":"30",
            "codecsinc_c_ddi":"g729;ulaw;alaw6",
         "is_webrtc   "tmp_c_ddi":"0",
            "sigameallow_alwaysloss_stcall":"0",
            "id_perfil":"1",
            "sipcode_no_prefix":"503",
            "sigamefranquia_alwaysfixo_dstlocal":"0219856998990",
            "sigamefranquia_busyfixo_stldn":"0",
            "sigamefranquia_busymovel_dstlocal":"0",
            "sigamefranquia_noanswermovel_stldn":"0",
            "sigamefranquia_noanswerfixo_dstddi":"0",
            "sigamefranquia_offlinemovel_stddi":"0",
            "sigamefranquia_fixo_offlinelocal_dstused":"30",
         "callerid_name   "franquia_fixo_ldn_used":"84",
            "callerid_numfranquia_movel_local_used":"30",
            "franquia_movel_ldn_used":"30",
         "linha_ip   "franquia_fixo_ddi_used":"90020",
            "dtmf_modefranquia_movel_ddi_used":"rfc47330",
            "volumefranquia_last_txreset":"-21",0000-00-00 00:00:00",
            "disk_space":"30048",
            "available_disk_space":"25704",
            "volumecall_only_rxlocal":"-211",
            "funcionalidademax_devices":"0"
         },
         "users":[
            {
               "id":"5",
               "id_perfil":"3",
               "username":"assinantenext",
               "nome_completo":"Rafel",
               "email":"rafarodriguesrj@yahoo.com.br",
               "celular":"",
               "root":"1",
               "logins":"18",
               "funcionalidadelast_idlogin":"0",
         "habilita_npn_fixo      "last_attempt":"0",
               "failed_attempts":"0",
               "habilita_npn_movelapi_access":"0",
               "can_spy":"0",
               "api_token":"awe4w0q-6qw5e4-qw65e40-as65e04",
               "api_key":"asdeqwe-asdqwe-a2w140e-aw5se40",
               "status":"1"
            }
         ]
      }
   ]
}


ID Status atual da Linha IP 
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
recordsTotal de registrados retornados nessa chamada
id_clienteidid do Cliente
nome_fantasiaNome do Cliente
recordsQuantidade de Linhas para esse Cliente
dataArray contendo as Linhas solicitadas
idID da Linha
id_planoID do Plano de Prefixos Customizado
id_audioID do Audio a ser reproduzido antes de cada Ligação
id_perfil_horarioID do Perfil de Horário da Linha
tipo_tarTipo de Tarifação: 0 - SALDO DA LINHA | 1 - SALDO DO CLIENTE
ddd_localDDD Local da Linha
techTecnologia utilizada pela Linha (Ex: DAHDI, SIP, DGV)
usernameNome de Usuário da Linha
passwordSenha da Linha
domainEndereço IP da Linha
portPorta de Conexão da Linha
rtp_symmetricAtivar RTP Simétrico: 0 - desativado | 1 - ativado
natTipo de NAT utilizado pela Linha
techprefixTechprefix da Linha caso a mesma seja por IP + TECHPREFIX
saldoSaldo atual da Linha, se tipo_tar = 0
voipPermitir chamadas IP x IP: 0 - desativado | 1 - ativado
fixo_localPermitir chamadas Fixo Local
fixo_ldnPermitir chamadas Fixo Longa Distância
movel_localPermitir chamadas Móvel Local
movel_ldnPermitir chamadas Móvel Longa Distância
fixo_ddiPermitir chamadas Fixo DDI
movel_ddiPermitir chamadas Móvel DDI
simultaneasChamadas simultâneas permitidas pela Linha
allow_transferPermitir Transferência
allow_record_fixoGravar chamadas para Fixo
allow_record_movelGravar chamadas para Móvel
allow_spyPermitir que essa Linha realize escuta
reproduzir_errosReproduzir erros na Linha
voicemail_statusStatus do Correio de Voz: 0 - inativo | 1 - ativo
voicemail_passwordSenha do Correio de Voz
cadeado_statusStatus do Cadeado
cadeado_passwordSenha do Cadeado
portal_passwordSenha do Portal de Voz
ring_falsoReproduzir Ring Falso
max_calltimeTempo máximo em uma ligação
max_ringtimeTempo máximo chamando antes de considerar NÃO ATENDIDO
max_ringtime_voipTempo máximo que essa linha irá ser chamada
codecsCodecs habilitados para a Linha
sigame_always_stEstado do Siga-ME Sempre
sigame_always_dstDestino do Siga-ME Sempre
sigame_busy_stEstado do Siga-ME Ocupado
sigame_busy_dstDestino do Siga-ME Ocupado 
sigame_noanswer_stEstado do Siga-ME Não Atende 
sigame_noasnwer_dstDestino do Siga-ME Não Atende 
sigame_offline_stEstado do Siga-ME OFFLINE 
sigame_offline_dstDestino do Siga-ME OFFLINE 
callerid_name Nome a ser exibido em Ligações Internas
callerid_numNúmero a ser exibido em Ligações Externas 
linha_ipNúmero da Linha IP / RAMAL 
dtmf_modeModo de DTMF 
volume_txVolume de Transmissão de áudio 
volume_rxVolume 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_idID de Registro de Funcionalidade da Linha, quando aplicável 
statustipo2 - Revenda | 4 - Assinante
id_hieID da Revenda
id_origemID do Tipo de Origem
id_vinculoID do Vinculo de Cliente
id_vendedorID do Vendendor
tem_ramalAcesso a Ramais: 0 - Inativo | 1 - Ativo
tem_didAcesso a DID: 0 - Inativo | 1 - Ativo
tem_smsAcesso a SMS: 0 - Inativo | 1 - Ativo
tem_escutaTem Escuta de Chamadas: 0 - Inativo | 1 - Ativo
tem_gravacaoPode Gravar Chamadas: 0 - Inativo | 1 - Ativo
tem_sigameAcesso a Siga-ME: 0 - Inativo | 1 - Ativo
tem_filaAcesso a Filas de Atendimento: 0 - Inativo | 1 - Ativo
tem_uraAcesso a URA: 0 - Inativo | 1 - Ativo
tem_portalAcesso a Portal de Voz: 0 - Inativo | 1 - Ativo
tem_callingcardAcesso a CallingCards: 0 - Inativo | 1 - Ativo
tem_grupo_capturaAcesso a Grupos de Captura: 0 - Inativo | 1 - Ativo
tem_grupo_chamadaAcesso a Grupos de Chamada: 0 - Inativo | 1 - Ativo
tem_campanha_smsAcesso a Campanhas de SMS: 0 - Inativo | 1 - Ativo
tem_campanha_vozAcesso a Campanhas de Voz: 0 - Inativo | 1 - Ativo
tem_conferenciaAcesso a Salas de Conferência: 0 - Inativo | 1 - Ativo
tem_provisionamentoAcesso a Provisionamento: 0 - Inativo | 1 - Ativo
tem_reportFlag utilizada internamente pelo Sistema
statusStatus do Cliente: 0 - Inativo | 1 - Ativo
finance.tipo_tarTipo Financeiro: 0 - PRE-PAGO | 1 - PÓS-PAGO | 2 - FRANQUIA
finance.id_planoID do Plano de Prefixos
finance.id_plano_smsID do Plano de SMS
finance.habilita_npnPermite Consulta a Portabilidade Móvel
finance.habilita_npn_fixoPermite Consulta a Portabilidade Fixo
finance.ini_fTarifação Fixo Inicial
finance.inc_fIncremento Fixo
finance.tmp_fTolerância Fixo
finance.ini_cTarifação Móvel Inicial
finance.inc_cIncremento Móvel
finance.tmp_cTolerância Móvel
finance.ini_f_ddiTarifação Fixo DDI Inicial
finance.inc_f_ddiIncremento Fixo DDI
finance.tmp_f_ddiTolerância Fixo DDI
finance.ini_c_ddiTarifação Móvel DDI Inicial
finance.inc_c_ddiIncremento Móvel DDI
finance.tmp_c_ddiTolerância Móvel DDI
finance.allow_loss_callPermitir Preço de Venda menor do que o Custo | 0 - Não | 1 - Sim
finance.id_perfilID do Perfil Financeiro
finance.sipcode_no_prefixSIP Code em caso de prefixo não existe
finance.franquia_fixo_localID da Franquia Fixo Local
finance.franquia_fixo_ldnID da Franquia Fixo Longa Distância
finance.franquia_movel_localID da Franquia Móvel Local
finance.franquia_movel_ldnID da Franquia Móvel Longa Distância
finance.franquia_fixo_ddiID da Franquia Fixo DDI
finance.franquia_movel_ddiID da Franquia Móvel DDI
finance.franquia_fixo_local_usedMinutos Utilizados na Franquia Fixo Local
finance.franquia_fixo_ldn_usedMinutos Utilizados na Franquia Fixo Longa Distância
finance.franquia_movel_local_usedMinutos Utilizados na Franquia Móvel Local
finance.franquia_movel_ldn_usedMinutos Utilizados na Franquia Móvel Longa Distância
finance.franquia_fixo_ddi_usedMinutos Utilizados na Franquia Fixo DDI
finance.franquia_movel_ddi_usedMinutos Utilizados na Franquia Móvel DDI
finance.franquia_last_resetInicio do Ciclo da Franquia
finance.disk_spaceEspaço em disco contratado (em MB) | 0 - Ilimitado
finance.available_disk_spaceEspaço em disco disponível para o Cliente
finance.call_only_localPermitir IPxIP apenas para Linhas do Cliente | 1 - Sim | 0 - Global
finance.max_devicesMáximo de Linhas que o Cliente pode criar | 0 - Ilimitado
users.idID do Usuário
users.id_perfilID do Perfil de Acesso
users.usernameUsuário de Acesso
users.nome_completoNome Completo do Usuário
users.root1 - Usuário Principal | 0 - Usuário Adicional
users.loginsQuantidade 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_attemptsQuantidade de Tentativas de Acesso com senha inválida
users.api_accessTem acesso a API? 0 - Não | 1 - Sim
users.can_spy

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

users.api_tokenAPI TOKEN para acesso a API
users.api_keyAPI KEY para acesso a API
users.statusStatus atual do usuário