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á api.voipmundotelecom.com.br. Nesse caso, o endereço da API seria:
Endereço da API exemplo https://suporte.voipmundotelecom.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:
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| CAMPO | DESCRIÇÃO |
|---|---|
| error | 1 em caso de erro |
| finance.allow_loss_call | Permitir Preço de Venda menor do que o Custo | 0 - Não | 1 - Sim |
| 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.disk_space | Espaço em disco contratado (em MB) | 0 - Ilimitado |
| finance.franquia_fixo_ddi | ID da Franquia Fixo DDI |
| finance.franquia_fixo_ddi_used | Minutos Utilizados na Franquia Fixo DDI |
| finance.franquia_fixo_ldn | ID da Franquia Fixo Longa Distância |
| finance.franquia_fixo_ldn_used | Minutos Utilizados na Franquia Fixo Longa Distância |
| finance.franquia_fixo_local | ID da Franquia Fixo Local |
| finance.franquia_fixo_local_used | Minutos Utilizados na Franquia Fixo Local |
| finance.franquia_last_reset | Inicio do Ciclo da Franquia |
| finance.franquia_movel_ddi | ID da Franquia Móvel DDI |
| finance.franquia_movel_ddi_used | Minutos Utilizados na Franquia Móvel DDI |
| finance.franquia_movel_ldn | ID da Franquia Móvel Longa Distância |
| finance.franquia_movel_ldn_used | Minutos Utilizados na Franquia Móvel Longa Distância |
| finance.franquia_movel_local | ID da Franquia Móvel Local |
| finance.franquia_movel_local_used | Minutos Utilizados na Franquia Móvel Local |
| finance.habilita_npn | Permite Consulta a Portabilidade Móvel |
| finance.habilita_npn_fixo | Permite Consulta a Portabilidade Fixo |
| finance.id_perfil | ID do Perfil Financeiro |
| finance.id_plano | ID do Plano de Prefixos |
| finance.id_plano_sms | ID do Plano de SMS |
| finance.inc_c | Incremento Móvel |
| finance.inc_c_ddi | Incremento Móvel DDI |
| finance.inc_f | Incremento Fixo |
| finance.inc_f_ddi | Incremento Fixo DDI |
| finance.ini_c | Tarifação Móvel Inicial |
| finance.ini_c_ddi | Tarifação Móvel DDI Inicial |
| finance.ini_f | Tarifação Fixo Inicial |
| finance.ini_f_ddi | Tarifação Fixo DDI Inicial |
| finance.max_devices | Máximo de Linhas que o Cliente pode criar | 0 - Ilimitado |
| finance.sipcode_no_prefix | SIP Code em caso de prefixo não existe |
| finance.tipo_tar | Tipo Financeiro: 0 - PRE-PAGO | 1 - PÓS-PAGO | 2 - FRANQUIA |
| finance.tmp_c | Tolerância Móvel |
| finance.tmp_c_ddi | Tolerância Móvel DDI |
| finance.tmp_f | Tolerância Fixo |
| finance.tmp_f_ddi | Tolerância Fixo DDI |
| id | id do Cliente |
| id_hie | ID da Revenda |
| id_origem | ID do Tipo de Origem |
| id_vendedor | ID do Vendendor |
| id_vinculo | ID do Vinculo de Cliente |
| reason | Descrição caso tenha ocorrido algum erro |
| status | Status do Cliente: 0 - Inativo | 1 - Ativo |
| tem_callingcard | Acesso a CallingCards: 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_did | Acesso a DID: 0 - Inativo | 1 - Ativo |
| tem_escuta | Tem Escuta de Chamadas: 0 - Inativo | 1 - Ativo |
| tem_fila | Acesso a Filas de Atendimento: 0 - Inativo | 1 - Ativo |
| tem_gravacao | Pode Gravar Chamadas: 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_portal | Acesso a Portal de Voz: 0 - Inativo | 1 - Ativo |
| tem_provisionamento | Acesso a Provisionamento: 0 - Inativo | 1 - Ativo |
| tem_ramal | Acesso a Ramais: 0 - Inativo | 1 - Ativo |
| tem_report | Flag utilizada internamente pelo Sistema |
| tem_sigame | Acesso a Siga-ME: 0 - Inativo | 1 - Ativo |
| tem_sms | Acesso a SMS: 0 - Inativo | 1 - Ativo |
| tem_ura | Acesso a URA: 0 - Inativo | 1 - Ativo |
| tipo | 2 - Revenda | 4 - Assinante |
| users.api_access | Tem acesso a API? 0 - Não | 1 - Sim |
| users.api_key | API KEY para acesso a API |
| users.api_token | API TOKEN para acesso a API |
| users.can_spy | Pode realizar escuta de ligações? 0 - Não | 1 - Sim |
| users.failed_attempts | Quantidade de Tentativas de Acesso com senha inválida |
| users.id | ID do Usuário |
| users.id_perfil | ID do Perfil de Acesso |
| users.last_attempt | Último acesso com senha inválida (unix timestamp) |
| users.last_login | Último acesso ao Painel (unix timestamp) |
| users.logins | Quantidade de Acessos ao Painel |
| users.nome_completo | Nome Completo do Usuário |
| users.root | 1 - Usuário Principal | 0 - Usuário Adicional |
| users.status | Status atual do usuário |
| users.username | Usuário de Acesso |