Obter o Cadastro de um Cliente

Owned by Thiago dos Santos Rodrigues
Last updated: Oct 05, 2020
8 min read

Endereço de Chamada da API

/api/manageCustomers/API_TOKEN/API_KEY/id_cliente


Este Ponto de Acesso irá fornecer o Cadastro Completo de um Cliente. Se estiver utilizando Tokens de Acesso do Nível Master ou Nível Revenda, você deverá especificar o ID DO 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:

Endereço da API exemplo

https://sip.nextbilling.com.br/api/manageCustomers/API_TOKEN/API_KEY/id_cliente

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/manageCustomers/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",
         "tipo":"4",
         "id_hie":"2",
         "id_origem":"1",
         "id_vinculo":"1",
         "id_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",
         "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",
         "email2":"",
         "email2_st":"0",
         "email_financeiro":"",
         "email_financeiro_st":"0",
         "tem_ramal":"1",
         "tem_did":"1",
         "tem_sms":"1",
         "tem_escuta":"0",
         "tem_gravacao":"1",
         "tem_sigame":"1",
         "tem_fila":"1",
         "tem_ura":"1",
         "tem_portal":"1",
         "tem_callingcard":"1",
         "tem_grupo_captura":"1",
         "tem_grupo_chamada":"1",
         "tem_campanha_sms":"1",
         "tem_campanha_voz":"1",
         "tem_conferencia":"1",
         "tem_provisionamento":"1",
         "moeda":"1",
         "country_code":"55",
         "tipo_loja":"0",
         "tem_report":"0",
         "status":"1",
         "finance":{
            "tipo_tar":"0",
            "id_plano":"2",
            "id_plano_sms":"0",
            "habilita_npn":"0",
            "habilita_npn_fixo":"0",
            "saldo":"27.30000",
            "limite_credito":"0.00",
            "dia_vencimento":"1",
            "dias_bloqueio":"10",
            "status_bloqueio":"0",
            "alerta_status":"0",
            "alerta_valor":"0.00",
            "simultaneas":"5",
            "ini_f":"30",
            "inc_f":"6",
            "tmp_f":"0",
            "ini_c":"30",
            "inc_c":"6",
            "tmp_c":"0",
            "ini_f_ddi":"30",
            "inc_f_ddi":"6",
            "tmp_f_ddi":"0",
            "ini_c_ddi":"30",
            "inc_c_ddi":"6",
            "tmp_c_ddi":"0",
            "allow_loss_call":"0",
            "id_perfil":"1",
            "sipcode_no_prefix":"503",
            "franquia_fixo_local":"0",
            "franquia_fixo_ldn":"0",
            "franquia_movel_local":"0",
            "franquia_movel_ldn":"0",
            "franquia_fixo_ddi":"0",
            "franquia_movel_ddi":"0",
            "franquia_fixo_local_used":"30",
            "franquia_fixo_ldn_used":"84",
            "franquia_movel_local_used":"30",
            "franquia_movel_ldn_used":"30",
            "franquia_fixo_ddi_used":"0",
            "franquia_movel_ddi_used":"0",
            "franquia_last_reset":"0000-00-00 00:00:00",
            "disk_space":"30048",
            "available_disk_space":"25704",
            "call_only_local":"1",
            "max_devices":"0"
         },
         "users":[
            {
               "id":"5",
               "id_perfil":"3",
               "username":"assinantenext",
               "nome_completo":"Rafel",
               "email":"rafarodriguesrj@yahoo.com.br",
               "celular":"",
               "root":"1",
               "logins":"18",
               "last_login":"0",
               "last_attempt":"0",
               "failed_attempts":"0",
               "api_access":"0",
               "can_spy":"0",
               "api_token":"awe4w0q-6qw5e4-qw65e40-as65e04",
               "api_key":"asdeqwe-asdqwe-a2w140e-aw5se40",
               "status":"1"
            }
         ]
      }
   ]
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
idid do Cliente
tipo2 - 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