...
Tip | ||
---|---|---|
| ||
/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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
$ 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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" } ] } ] } |
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 | IDid | 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:
| |
funcionalidade_id | ID de Registro de Funcionalidade da Linha, quando aplicável | |
status | Status atual da Linha IPtipo | 2 - Revenda | 4 - Assinante |
id_hie | ID da Revenda | |
id_origem | ID do Tipo de Origem | |
id_vinculo | ID do Vinculo de Cliente | |
id_vendedor | 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 |