Suporte e tutoriais

Central de Ajuda

Encontre manuais, guias e perguntas frequentes sobre os produtos Vono. Tudo o que você precisa para usar nossas soluções, em um só lugar.

API PABX - Obter o Cadastro de um Assinante

✅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á vono.me. Nesse caso, o endereço da API seria:

Endereço da API exemplo:

https://vono.me/api/manageCustomers/API_TOKEN/API_KEY/id_cliente

❕ Caso tenha duvidas de como pegar o domínio, APITOKEN e APIKEY para preencher clique abaixo.
✦ Como pegar o dominio »
✦ Como pegar APITOKEN e APIKEY »

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:

$ curl -X GET 'https://vono.me/api/manageCustomers/3'

Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:

{
	"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": "VONO",
			"razao_social": "GRUPO VONO",
			"cpf": "xxxxxxxxxxxxxxx",
			"rg": "isento",
			"dominio": "127.0.0.1",
			"website": "",
			"cep": "xxxxxxxx",
			"endereco": "xxxxxxxxxxxxxx",
			"complemento": "xx",
			"bairro": "xxxxxxx",
			"cidade": "xxxxxxxx",
			"uf": "xx",
			"pais": "Brasil",
			"telefone": "xxxxxxxxxxx",
			"ramal": "",
			"telefone2": "",
			"celular": "",
			"fax": "",
			"celular_sms": "",
			"notificar_sms": "0",
			"contato": "Vono",
			"email": "grupovono@grupovono.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": "vono",
					"nome_completo": "grupo vono",
					"email": "grupovono@grupovono.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-6777e4-qw65e40-as15e04",
					"api_key": "asdeqwe-asd689-a2w140e-aw5se40",
					"status": "1"
				}
			]
		}
	]
}
Campo Descrição
error 1 em caso de erro
reason Descrição caso tenha ocorrido algum erro
id id do Cliente
tipo 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
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

Conheça o produto relacionado:

Ver solução Vono

Não encontrou o que procurava?

Nossa equipe de atendimento está pronta para ajudar você com dúvidas sobre produtos, configurações e suporte técnico.