SoapSiptek SOAP WebService interface description

Endpoint URI: https://plat1.dazsoft.com/webservice/index.php

WSDL URI: https://plat1.dazsoft.com/webservice/index.php?WSDL

PHP SOAP client download URI: https://plat1.dazsoft.com/webservice/index.php?PHPSOAPCLIENT

Complex types

AuthEstrutura

Estrutura para autenticação das solicitações.

• string usuario (nillable = true, minoccurs = 1, maxoccurs = 1)
  Usuário para autenticação.
• string senha (nillable = true, minoccurs = 1, maxoccurs = 1)
  Senha de autenticação

CDR

Estrutura base de um CDR (Call Detail Record)

• string techPrefix (nillable = true, minoccurs = 1, maxoccurs = 1)
  Prefixo identificador de serviço
• string origem (nillable = true, minoccurs = 1, maxoccurs = 1)
  Conta voip/Numero de origem da chamada
• string destino (nillable = true, minoccurs = 1, maxoccurs = 1)
  Numero de destino da chamada
• string contaCobranca (nillable = true, minoccurs = 1, maxoccurs = 1)
  Conta de cobrança utilizada na chamada
• string datahora (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data e hora que a chamada foi realizada.
• string regiao (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome da região de destino da chamada
• int duracao (nillable = false, minoccurs = 1, maxoccurs = 1)
  Duração arredondada da chamada
• float preco (nillable = false, minoccurs = 1, maxoccurs = 1)
  Preço da chamada
• int sipcode (nillable = false, minoccurs = 1, maxoccurs = 1)
  Codigo SIP de finalizacao da chamada
• string nomeDisplay (nillable = true, minoccurs = 1, maxoccurs = 1)
  nome no Display

CDRArray

This is an array type of CDR.

Estrutura base de um CDR (Call Detail Record)

CDRList

Estrutura base do retorno de uma lista de bilhetes

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa.
• CDRArray lista_cdr (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de bilhetes
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

CallerIDArray

This is an array type of CallerID.

Estrutura base de um array de Caller ID

CallerIDEstrutura

Estrutura base de informaçcoes do callerID de um perfil de terminação.

• int tipo_callerid (nillable = false, minoccurs = 1, maxoccurs = 1)
  Define como tratamos CallerID (0 = não iremos alterar, 1 = substitui com CallerID informado, 2 = acrescenta 00 se necessario, 3 = utiliza P-Asserted-Identity).
• string callerid (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informe qual será o callerID apenas caso seja informado $tipo_callerid = 1.
• string servico (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informe qual o servico do CallerID especifico.
• string tech_prefix (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informe qual o tech do servico.

CallerIDList

Estrutura padrão para retorno das funções

• boolean status (nillable = false, minoccurs = 1, maxoccurs = 1)
  Status da solicitação
• CallerIDArray lista_callerid (nillable = true, minoccurs = 1, maxoccurs = 1)
  lista de caller id
• string erro (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa qual o erro que retornou, se vazio, não houve erro.

ChamadasSimultaneasEstrutura

Estrutura base de numero de chamadas simultaneas.

• int chamadas_totais (nillable = false, minoccurs = 1, maxoccurs = 1)
  totais de chamadas.
• int chamadas_atendidas (nillable = false, minoccurs = 1, maxoccurs = 1)
  chamadas atendidas de acordo com o parametro.

CidadeEstrutura

Estrutura base de uma Cidade na plataforma.

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador único da região.
• string sigla_estado (nillable = true, minoccurs = 1, maxoccurs = 1)
  Sigla do Estado.
• string nome (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome da Cidade.

CidadeEstruturaArray

This is an array type of CidadeEstrutura.

Estrutura base de um Array de CidadeEstrutura

CidadeList

Estrutura base de uma lista de regiões na plataforma.

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros.
• CidadeEstruturaArray cidades (nillable = true, minoccurs = 1, maxoccurs = 1)
  Array de Cidades.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

ClienteArray

This is an array type of Cliente.

Estrutura base de um array do consumo

ClienteEstrutura

Estrutura base de um Cliente na plataforma

• int id (nillable = true, minoccurs = 1, maxoccurs = 1)
  Identificador unico do Cliente no sistema. Se novo cliente = 0.
• string nome (nillable = false, minoccurs = 1, maxoccurs = 1)
  Nome do usuário ou razao social se empresa
• string login (nillable = false, minoccurs = 1, maxoccurs = 1)
  Login do usuário para acesso ao painel. Esta informação deve ser única em todo o sistema.
• string senha (nillable = false, minoccurs = 1, maxoccurs = 1)
  Senha do usuário para acesso ao painel.
• string endereco (nillable = true, minoccurs = 1, maxoccurs = 1)
  Logradouro do usuário.
• string bairro (nillable = true, minoccurs = 1, maxoccurs = 1)
  Bairro do usuário.
• string cidade (nillable = true, minoccurs = 1, maxoccurs = 1)
  Cidade do usuário.
• string estado (nillable = true, minoccurs = 1, maxoccurs = 1)
  Código de duas letras do estado do usuário.
• string telefone (nillable = true, minoccurs = 1, maxoccurs = 1)
  Número de telefone para contato com o usuário.
• string email (nillable = true, minoccurs = 1, maxoccurs = 1)
  E-mail de contato com o usuário. Utilizado para notificações caso habilitado.
• string cpf (nillable = true, minoccurs = 1, maxoccurs = 1)
  CPF do usuário caso pessoa física.
• string cnpj (nillable = true, minoccurs = 1, maxoccurs = 1)
  CNPJ do usuário caso pessoa jurídica.
• string inscricao_estadual (nillable = true, minoccurs = 1, maxoccurs = 1)
  Inscrição Estadual do usuário caso pessoa jurídica.
• string inscricao_municipal (nillable = true, minoccurs = 1, maxoccurs = 1)
  Inscrição Municipal do usuário caso pessoa jurídica.
• int revenda (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador da revenda. Caso não possua, enviar 0 ou nulo.
• int max_cps (nillable = false, minoccurs = 1, maxoccurs = 1)
  Máximo de chamadas por segundo que o usuário pode fazer. 0 = ilimitado.
• int max_chamadas_simult (nillable = false, minoccurs = 1, maxoccurs = 1)
  Máximo de chamadas simultaneas que o usuário pode fazer. 0 = ilimitado.
• int prepaid_mode (nillable = false, minoccurs = 1, maxoccurs = 1)
  Modo do sistema pré-pago. 0 = saldo individual por conta voip, 1 = saldo compartilhado entre as contas voip do cliente.
• float cota_diaria_limite (nillable = false, minoccurs = 1, maxoccurs = 1)
  Cota limite DIÁRIA de consumo. Se atingir este limite, bloqueia realizar novas chamadas.
• float cota_mensal_limite (nillable = false, minoccurs = 1, maxoccurs = 1)
  Cota limite MENSAL de consumo. Se atingir este limite, bloqueia realizar novas chamadas.
• float franquia_minima (nillable = false, minoccurs = 1, maxoccurs = 1)
  Franquia mínima pós-paga configurada. Caso não atinja este valor, será gerado um pedido com este valor.
• float cobranca_extra_mensal (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor pós-pago cobrado mensalmente junto com o consumo ou a franquia.
• string cep (nillable = true, minoccurs = 1, maxoccurs = 1)
  CEP do usuário.
• float cota_diaria_consumo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Consumo atual do cliente no dia.
• float cota_mensal_consumo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Consumo atual do cliente no mês.
• int tipo_cobranca (nillable = false, minoccurs = 1, maxoccurs = 1)
  Como o cliente será cobrado 1 = Semanal, 2 = Quinzenal, 3 = Mensal.
• int dia_cobranca (nillable = false, minoccurs = 1, maxoccurs = 1)
  Dia em que o cliente será cobradp.
• int bloqueia_prejuizo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Bloqueio de prejuizo do cliente
• int expira_saldo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Configuração do Tempo de expiração do Saldo, -1 padrão da Plataforma, 0 = Não expira, >= 1 quantidade de dias após ultima recarga para o saldo expirar.
• int bloqueia_fixo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Bloqueio para Fixo.
• int bloqueia_movel (nillable = false, minoccurs = 1, maxoccurs = 1)
  Bloqueio para Móvel.
• int bloqueia_internacional (nillable = false, minoccurs = 1, maxoccurs = 1)
  Bloqueio para Internacional.
• string id_externo_cliente (nillable = true, minoccurs = 1, maxoccurs = 1)
  ID externo do cliente.

ClientesList

Estrutura base do retorno de uma lista de Clientes

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa.
• ClienteArray lista_clientes (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Clientes
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

Consumo

Estrutura base de consumo do Cliente

• int total_chamadas (nillable = false, minoccurs = 1, maxoccurs = 1)
  Numero total de chamadas realizadas pelo Cliente
• int cliente_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Id do cliente que realizou a chamada.
• string datahora (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data e hora que a chamada foi realizada.
• float venda (nillable = false, minoccurs = 1, maxoccurs = 1)
  preço da chamada
• float custo (nillable = false, minoccurs = 1, maxoccurs = 1)
  custo da chamada
• float duracao (nillable = false, minoccurs = 1, maxoccurs = 1)
  Duração arredondada em minutos da chamada

ConsumoArray

This is an array type of Consumo.

Estrutura base de um array do consumo

ConsumoList

Estrutura base do retorno de uma lista de consumo do cliente

• ConsumoArray list_consumo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Consumos
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

ContaVoipEstrutura

Estrutura base de uma conta voip na plataforma.

• string numero (nillable = true, minoccurs = 1, maxoccurs = 1)
  Numero da conta voip para autenticação das chamadas.
• string dominio (nillable = true, minoccurs = 1, maxoccurs = 1)
  Domínio da conta voip para autenticação das chamadas.
• string senha (nillable = true, minoccurs = 1, maxoccurs = 1)
  Senha da conta voip para autenticação das chamadas.
• int cliente_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador único do cliente que será dono da conta.
• boolean postpaid (nillable = false, minoccurs = 1, maxoccurs = 1)
  Tipo da conta, "true" para pós-paga ou "false" para pré-paga.
• int aviso_saldo_habilita (nillable = false, minoccurs = 1, maxoccurs = 1)
  Caso a conta seja pré-paga, habilita o aviso de saldo baixo.
• int aviso_saldo_valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor para aviso de saldo baixo.
• int assinatura_valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  Assinatura mensal para pré-pago. Desconta mensalmente dos créditos desta conta, o valor configurado.
• int assinatura_dia (nillable = false, minoccurs = 1, maxoccurs = 1)
  O valor da assinatura mensal é descontado neste dia. Ambos os campos precisam ser setados para cobrar.
• float saldo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Campo somente leitura, informa o saldo da conta voip.
• string chamadas_ilimitadas_fixo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Sim ou não para chamadas ilimitadas para fixo. 0 = Não e 1 = Sim
• string chamadas_ilimitadas_movel (nillable = true, minoccurs = 1, maxoccurs = 1)
  Sim ou não para chamadas ilimitadas para movel. 0 = Não e 1 = Sim
• string chamadas_ilimitadas_internacional (nillable = true, minoccurs = 1, maxoccurs = 1)
  Sim ou não para chamadas ilimitadas para internacional. 0 = Não e 1 = Sim
• string permitir_registros_do_ip (nillable = true, minoccurs = 1, maxoccurs = 1)
  Somente serão aceitos registros e chamadas que sejam originados do IP cadastrado. Se o campo estiver vazio não haverá limitação.
• string permitir_registros_do_user_agent (nillable = true, minoccurs = 1, maxoccurs = 1)
  Somente serão aceitos registros e chamadas que tenham o determinado User-Agent na mensagem SIP. Se o campo estiver vazio não haverá limitação.
• string erro_motivo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa motivo de erro caso ocorra.

ContaVoipEstruturaArray

This is an array type of ContaVoipEstrutura.

Estrutura base de um Array de ContaVoipEstrutura

ContaVoipList

Estrutura base do retorno de uma Lista de Contas VOIPs

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa
• ContaVoipEstruturaArray contas_voips (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Contas Voips
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

EstruturaRegiao

Estrutura base de uma Região na plataforma.

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador único da região.
• string nome (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome da tabela de venda.

EstruturaRegiaoArray

This is an array type of EstruturaRegiao.

Estrutura base de um Array de EstruturaRegiao

EstruturaRegiaoList

Estrutura base de uma lista de regiões na plataforma.

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios
• EstruturaRegiaoArray regioes (nillable = true, minoccurs = 1, maxoccurs = 1)
  Array de Regiões.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

EstruturaSaldo

Estrutura base de uma Região na plataforma.

• string servico (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Servico
• string tech_prefix (nillable = true, minoccurs = 1, maxoccurs = 1)
  Tech prefix do serviço
• float minutos (nillable = false, minoccurs = 1, maxoccurs = 1)
  Minutos para falar
• int id_regiao (nillable = false, minoccurs = 1, maxoccurs = 1)
  Região que foi utilizada para o calculo de minutos.

EstruturaSaldoList

Estrutura base de uma lista de regiões na plataforma.

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios
• EstruturaSaldo saldo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Saldo em minutos.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

FornecedoresArray

This is an array type of Fornecedores.

Estrutura base de um array de Fornecedores

FornecedoresEstrutura

Estrutura base de Fornecedores na plataforma

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador unico do Fornecedor.
• string nome (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Fornecedor.

FornecedoresList

Estrutura base do retorno de uma lista de Fornecedores

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa
• FornecedoresArray lista_fornecedores (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Fornecedores
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

IpDeOrigemEstrutura

Estrutura base de um IP de origem na plataforma.

• int cliente_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Id do cliente dono do IP de origem.
• string ip (nillable = true, minoccurs = 1, maxoccurs = 1)
  Ip de origem que será cadastrado.
• boolean pospago (nillable = false, minoccurs = 1, maxoccurs = 1)
  Informa se o IP a ser cadastrado é pospago ou não ( 0 = pré pago, 1 = pós pago)
• boolean compartilhado (nillable = false, minoccurs = 1, maxoccurs = 1)
  diz se é um Ip compartilhado ou não, se compartilhado, necessario informar $tech_prefix
• string tech_prefix (nillable = true, minoccurs = 1, maxoccurs = 1)
  tech prefix de autenticação do IP.
• boolean monitora_ping (nillable = false, minoccurs = 1, maxoccurs = 1)
  diz se o IP será monitorado por ping (0 = não, 1 = sim).
• int tabela_roteamento_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  ID da tabela de roteamento que o IP utilizara.
• int tabela_venda_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  ID da tabela de venda.
• boolean notificacao_saldo_habilitado (nillable = false, minoccurs = 1, maxoccurs = 1)
  notificação de saldo habilitado. (0 = não, 1 = sim)
• float notificacao_saldo_valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  valor de saldo para ser notificado.
• int local (nillable = false, minoccurs = 1, maxoccurs = 1)
  DDD local dos numeros discados pelo IP. EX: 12341234 = 55 + Local + 12341234.
• string erro_motivo (nillable = true, minoccurs = 1, maxoccurs = 1)
  motivo de erro.

IpDeOrigemEstruturaArray

This is an array type of IpDeOrigemEstrutura.

Estrutura base de um Array de IpDeOrigemEstrutura

IpDeOrigemList

Estrutura base do retorno de uma Lista de IPs de Origem

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa
• IpDeOrigemEstruturaArray ips_de_origem (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de IPs de Origem
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

NumeroRemotoEstrutura

Estrutura base de um Numero Remoto na plataforma.

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  id unico do numero remoto.
• string numero (nillable = true, minoccurs = 1, maxoccurs = 1)
  Numero Remoto.
• int cliente_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  id unico do cliente.
• string service (nillable = true, minoccurs = 1, maxoccurs = 1)
  Conta VoIP, exemplo "numero@dominio".
• int provider (nillable = false, minoccurs = 1, maxoccurs = 1)
  fornecedor.
• int tabela_custo (nillable = false, minoccurs = 1, maxoccurs = 1)
  tabela de custo.
• int tabela_venda (nillable = false, minoccurs = 1, maxoccurs = 1)
  tabela de venda.
• int type_service (nillable = false, minoccurs = 1, maxoccurs = 1)
  informa se o numero é vinculado a ip ou conta voip. 0 = ip , 1 = voip.
• int cobrar (nillable = false, minoccurs = 1, maxoccurs = 1)
  habilita tarifação de chamada.
• int postpaid (nillable = false, minoccurs = 1, maxoccurs = 1)
  Tipo da conta, 2 para conta VOIP/IP, 1 para pós-paga ou 0 para pré-paga.
• int prepaid_group (nillable = false, minoccurs = 1, maxoccurs = 1)
  grupo de saldo
• int aviso_saldo_habilita (nillable = false, minoccurs = 1, maxoccurs = 1)
  Caso a conta seja pré-paga, habilita o aviso de saldo baixo.
• int aviso_saldo_valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor para aviso de saldo baixo.
• int assinatura_valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  Assinatura mensal para pré-pago. Desconta mensalmente dos créditos desta conta, o valor configurado.
• int assinatura_dia (nillable = false, minoccurs = 1, maxoccurs = 1)
  O valor da assinatura mensal é descontado neste dia. Ambos os campos precisam ser setados para cobrar.
• float saldo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Campo somente leitura, informa o saldo do Numero Remoto.
• string observacao (nillable = true, minoccurs = 1, maxoccurs = 1)
  observação sobre o numero remoto.
• string erro_motivo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa motivo de erro caso ocorra.
• boolean registrar (nillable = false, minoccurs = 1, maxoccurs = 1)
  Informa se o numero remoto deve registrar no fornecedor. (0 = não registrar, 1 = registrar)
• string servidor (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa o servidor do registro.
• string usuario (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa o usuario do registro.
• string senha (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa a senha do registro.
• int bloquear_fixo (nillable = false, minoccurs = 1, maxoccurs = 1)
  0 = não bloqueia, 1 = bloqueia
• int bloquear_movel (nillable = false, minoccurs = 1, maxoccurs = 1)
  0 = não bloqueia, 1 = bloqueia
• int bloquear_internacional (nillable = false, minoccurs = 1, maxoccurs = 1)
  0 = não bloqueia, 1 = bloqueia
• int bloquear_outros (nillable = false, minoccurs = 1, maxoccurs = 1)
  0 = não bloqueia, 1 = bloqueia
• int bloquear_prefixo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Bloquear Códigos de área Nacional. (0 = não bloqueia, 1 = bloqueia)
• string bloquear_prefixos (nillable = true, minoccurs = 1, maxoccurs = 1)
  String contendo os prefixos que serão bloqueados sepados por virgula. Ex.: 11,12,21,81
• int max_chamadas_simultaneas (nillable = false, minoccurs = 1, maxoccurs = 1)
  Limita a quantidade máxima de chamadas simultâneas que o Número remoto pode receber. 0 = Ilimitado.

NumerosRemotosArray

This is an array type of NumerosRemotos.

Estrutura base de um array de Numeros remotos

NumerosRemotosList

Estrutura base do retorno de uma Numeros Remotos

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa
• NumerosRemotosArray lista_remotos (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Numeros Remotos
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

PedidosArray

This is an array type of Pedidos.

Estrutura base de um array de Pedidos

PedidosEstrutura

Estrutura padrão para retorno das funções

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Id do pedido.
• string data_gerado (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data que foi cadastrado.
• int customer_id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Id do Cliente.
• int status (nillable = false, minoccurs = 1, maxoccurs = 1)
  Status do pedido.
• string data_pagamento (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data que foi efetuada o pagamento.
• string descricao (nillable = true, minoccurs = 1, maxoccurs = 1)
  Descrição do pedido.
• float valor_total (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor total do pedido.
• float faturado (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor faturado.
• string data_faturamento (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data do faturamento.
• int manual (nillable = false, minoccurs = 1, maxoccurs = 1)
  manual ou Automatico.
• string data_inicial (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data inicial da consulta.
• string data_final (nillable = true, minoccurs = 1, maxoccurs = 1)
  Data final da consulta.
• string customer_name (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Cliente.
• string id_externo_cliente (nillable = true, minoccurs = 1, maxoccurs = 1)
  ID externo do Cliente.
• string[] itens (nillable = true, minoccurs = 1, maxoccurs = 1)
  Array de itens do pedido.

PedidosItensEstrutura

Estrutura padrão para retorno das funções

• int quantidade (nillable = false, minoccurs = 1, maxoccurs = 1)
  Quantidade daquele item.
• float preco (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor unitario do item.
• float valor (nillable = false, minoccurs = 1, maxoccurs = 1)
  Valor total (Quantidade*Valor).
• string descricao (nillable = true, minoccurs = 1, maxoccurs = 1)
  Descrição do item.
• string nometipo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Tipo do item.

PedidosList

Estrutura padrão para retorno das funções

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Quantidade de pedidos.
• PedidosArray lista_pedidos (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista contendo todos os pedidos.
• string erro (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

RetornoEstrutura

Estrutura padrão para retorno das funções

• boolean status (nillable = false, minoccurs = 1, maxoccurs = 1)
  Status da solicitação
• string erro (nillable = true, minoccurs = 1, maxoccurs = 1)
  Mensagem de erro
• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador único do objeto inserido, se houver. Se não, retorna zero.

SaldoArray

This is an array type of Saldo.

Estrutura base de um array do consumo

SaldoEstrutura

Estrutura base do saldo da plataforma

• int id_cliente (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador unico do Cliente.
• string nome_cliente (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Cliente.
• int tipo_saldo (nillable = false, minoccurs = 1, maxoccurs = 1)
  Tipo de Saldo 0 = Saldo por Serviço, 1 = Saldo compartilhado
• SaldoServicosArray servicos (nillable = true, minoccurs = 1, maxoccurs = 1)
  Saldos dos servicos

SaldoList

Estrutura base do retorno de saldos

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros.
• SaldoEstrutura lista_saldo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de saldos.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

SaldoServicos

Estrutura base de saldos por servicos

• int tipo_servico (nillable = false, minoccurs = 1, maxoccurs = 1)
  Tipo de servico: 2 = Conta IP, 3 = Conta VOIP e 4 = Número remoto.
• string servico (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Servico.
• string saldo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Saldo do serviço

SaldoServicosArray

This is an array type of SaldoServicos.

Estrutura base de um array de Saldo dos serviços

ServicoArray

This is an array type of Servico.

Estrutura base de um array do servico

ServicoEstrutura

Estrutura base de servicos

• int id_cliente (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador unico do Cliente.
• string nome_cliente (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome do Cliente.
• ContaVoipList contas_voip (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Contas Voips
• IpDeOrigemList ips_de_origem (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de IPs de Origem
• NumerosRemotosList numeros_remoto (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Números Remoto

ServicoList

Estrutura base do retorno de servicos

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros.
• ServicoEstrutura lista_servico (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de servicos.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

ServicosArray

This is an array type of Servicos.

Estrutura base de um array de serviços

SigaMeEstrutura

Estrutura base de um siga-me da conta voip na plataforma.

• string conta_voip (nillable = true, minoccurs = 1, maxoccurs = 1)
  conta voip para vinculo do siga-me.
• int todas (nillable = false, minoccurs = 1, maxoccurs = 1)
  Encaminhamento do siga-me para todas as chamadas. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_todas (nillable = true, minoccurs = 1, maxoccurs = 1)
  Destino do siga-me para todas chamadas na conta VoIP. se VoIP informar [numero voip]@[dominio].
• int offline (nillable = false, minoccurs = 1, maxoccurs = 1)
  Encaminhamento do siga-me quando conta offline. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_offline (nillable = true, minoccurs = 1, maxoccurs = 1)
  Destino do siga-me quando conta offline. se VoIP informar [numero voip]@[dominio].
• int indisponel (nillable = false, minoccurs = 1, maxoccurs = 1)
  Encaminhamento do siga-me quando conta indisponivel ou ocupada. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_indisponel (nillable = true, minoccurs = 1, maxoccurs = 1)
  Destino do siga-me quando conta indisponivel ou ocupada. se VoIP informar [numero voip]@[dominio].
• string erro_motivo (nillable = true, minoccurs = 1, maxoccurs = 1)
  Informa motivo de erro caso ocorra.

StatusRegistroArray

This is an array type of StatusRegistro.

Estrutura base de um array de informacoes de status do registro

StatusRegistroEstrutura

Estrutura base de informaçcoes do registro.

• string conta (nillable = true, minoccurs = 1, maxoccurs = 1)
  conta Voip registrada.
• string expira (nillable = true, minoccurs = 1, maxoccurs = 1)
  horario que expira o registro.
• string contato (nillable = true, minoccurs = 1, maxoccurs = 1)
  contato enviado pelo cliente para o registro.
• string user_agent (nillable = true, minoccurs = 1, maxoccurs = 1)
  user agent responsavel pelo registro.
• string socket (nillable = true, minoccurs = 1, maxoccurs = 1)
  socket onde foi recebida a solicitação de registro.

StatusRegistroList

Estrutura base do retorno de uma lista do Status da conta VoIP

• boolean registrado (nillable = false, minoccurs = 1, maxoccurs = 1)
  status de registro da conta Voip.
• StatusRegistroArray lista_informacoes_status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de informacoes do registro.
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

StatusRegistroRemotoEstrutura

Estrutura base de informaçcoes do registro de numero remoto.

• boolean registrado (nillable = false, minoccurs = 1, maxoccurs = 1)
  Status do registro do numero remoto.
• string servidor (nillable = true, minoccurs = 1, maxoccurs = 1)
  Servidor onde devemos solicitar o registro do DID.
• string usuario (nillable = true, minoccurs = 1, maxoccurs = 1)
  Usuario utilizado para registrar o DID.
• string senha (nillable = true, minoccurs = 1, maxoccurs = 1)
  senha utilizada para registrar o DID.

TabelaPrecoArray

This is an array type of TabelaPreco.

Estrutura base de um array de Tabelas de Preço

TabelaPrecoEstrutura

Estrutura base de uma Tabela de Preço na plataforma

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador unico da Tabela de Preço.
• string nome (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome da Tabela de Preço.

TabelaPrecoList

Estrutura base do retorno de uma lista de Tabela de Preço

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa.
• TabelaPrecoArray lista_tabelas_preco (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Tabelas de Precos
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

TabelaRoteamentoEstrutura

Estrutura base de uma Tabela de Roteamento na plataforma

• int id (nillable = false, minoccurs = 1, maxoccurs = 1)
  Identificador unico da Tabela de Roteamento.
• string nome (nillable = true, minoccurs = 1, maxoccurs = 1)
  Nome da Tabela de Roteamento.
• string descricao (nillable = true, minoccurs = 1, maxoccurs = 1)
  Descrição da Tabela de Roteamento.

TabelasRoteamentoArray

This is an array type of TabelasRoteamento.

Estrutura base de um array de Tabelas de Roteamento

TabelasRoteamentoList

Estrutura base do retorno de uma lista de Tabelas de Roteamento

• int total_registros (nillable = false, minoccurs = 1, maxoccurs = 1)
  Total de registros dos critérios, independente do numero de registros limitado pela pesquisa.
• TabelasRoteamentoArray lista_tabelas_roteamento (nillable = true, minoccurs = 1, maxoccurs = 1)
  Lista de Tabelas de Roteamanto
• string status (nillable = true, minoccurs = 1, maxoccurs = 1)
  Status da pesquisa. Vazio se pesquisar com sucesso ou o erro, caso ocorra algum.

Public methods

AlteraAvisoSaldo

RetornoEstrutura AlteraAvisoSaldo (
    AuthEstrutura auth,
    string servico,
    int tech_prefix,
    int tipo_servico,
    int notifica_saldo,
    int saldo
)

Configura o aviso de saldo ou o valor mínimo a ser avisado por e-mail do Serviço
Exemplo: 0 = Não notifica saldo, 1 = Notifica o saldo por e-mail.

• AuthEstrutura auth
  object
• string servico
  Serviço que sera configurado o saldo. Para Conta VOIP é necessario inserir "username@dominio".
• int tech_prefix
  informe o tech prefix caso o serviço seja um IP de origem. (vazio se for Conta VoIP ou Numero Remoto).
• int tipo_servico
  Tipo do serviço. Exemplo: 1 = IP de Origem, 2 = Conta VOIP, 3 = Número Remoto
• int notifica_saldo
  Permitir notificar ou não o aviso do saldo baixo.
• int saldo
  Saldo mínimo a ser avisado por e-mail.

Return value RetornoEstrutura: object

AlteraCallerID

RetornoEstrutura AlteraCallerID (
    AuthEstrutura auth,
    string servico,
    string tech_prefix,
    int tipo_callerid,
    string callerid
)

Altera informações do Caller ID. (Para limpa, basta não informar CallerID e passar tipo como 0).

• AuthEstrutura auth
  object
• string servico
  servico para buscarmos a configuração do Caller ID.
• string tech_prefix
  Tech prefix do servico para buscarmos a configuração do Caller ID.
• int tipo_callerid
  Define como tratamos CallerID (0 = não iremos alterar, 1 = substitui com CallerID informado, 2 = acrescenta 00 se necessario, 3 = utiliza P-Asserted-Identity).
• string callerid
  Caller ID que iremos gravar.

Return value RetornoEstrutura: object

AlteraNumeroRemoto

RetornoEstrutura AlteraNumeroRemoto (
    AuthEstrutura auth,
    NumeroRemotoEstrutura obj
)

Altera Numero Remoto no sistema

• AuthEstrutura auth
  object
• NumeroRemotoEstrutura obj
  object

Return value RetornoEstrutura: object

AtualizaCliente

RetornoEstrutura AtualizaCliente (
    AuthEstrutura auth,
    ClienteEstrutura obj
)

Atualiza Cliente no sistema. O Login não pode ser alterado.

• AuthEstrutura auth
  object

Return value RetornoEstrutura: object

AtualizaContaVoip

RetornoEstrutura AtualizaContaVoip (
    AuthEstrutura auth,
    ContaVoipEstrutura obj,
    int tabela_roteamento_id,
    int tabela_preco_id,
    int ddd_local
)

Atualiza Conta Voip no sistema

• AuthEstrutura auth
  object
• ContaVoipEstrutura obj
  object
• int tabela_roteamento_id
  ID da tabela de roteamento utilizada por esta conta voip. Caso não queira alterar, passar parametro vazio.
• int tabela_preco_id
  ID da tabela de preço utilizada por esta conta voip. Caso não queira alterar, passar parametro vazio.
• int ddd_local
  Esse numero sera prefixo o local da conta Voip

Return value RetornoEstrutura: object

AtualizaIpDeOrigem

RetornoEstrutura AtualizaIpDeOrigem (
    AuthEstrutura auth,
    IpDeOrigemEstrutura obj
)

Editar Ip's de origem, de forma compartilhada ou não compartilhada por IP + tech_prefix se compartilhado.

• AuthEstrutura auth
  object
• IpDeOrigemEstrutura obj
  object

Return value RetornoEstrutura: object

BloquearServico

RetornoEstrutura BloquearServico (
    AuthEstrutura auth,
    string servico,
    string tech_prefix,
    int tipo_servico,
    int tipo_bloqueio
)

Bloquear serviço para realizar e/ou receber chamadas.

• AuthEstrutura auth
  object
• string servico
  informe o serviço que será bloqueado.
• string tech_prefix
  informe o tech prefix caso o serviço seja um IP de origem. (vazio se for Conta VoIP)
• int tipo_servico
  informe o tipo do serviço que será bloqueado (1 = conta VoIP, 2 = IP de origem).
• int tipo_bloqueio
  informe o tipo de bloqueio (1 = bloqueado para realizar chamadas, 2 = bloqueado para realizar e receber chamadas).

Return value RetornoEstrutura: object

DesbloquearServico

RetornoEstrutura DesbloquearServico (
    AuthEstrutura auth,
    string servico,
    string tech_prefix,
    int tipo_servico
)

Desbloquear serviço para realizar e/ou receber chamadas.

• AuthEstrutura auth
  object
• string servico
  informe o serviço que será bloqueado.
• string tech_prefix
  informe o tech prefix caso o serviço seja um IP de origem. (vazio se for Conta VoIP)
• int tipo_servico
  informe o tipo do serviço que será bloqueado (1 = conta VoIP, 2 = IP de origem).

Return value RetornoEstrutura: object

DesvinculaNumeroRemoto

RetornoEstrutura DesvinculaNumeroRemoto (
    AuthEstrutura auth,
    string numero_remoto
)

Desvincula cliente e serviço do numero remoto.

• AuthEstrutura auth
  object
• string numero_remoto
  numero remoto que desvincularemos de cliente e fornecedor.

Return value RetornoEstrutura: object

InsereCliente

RetornoEstrutura InsereCliente (
    AuthEstrutura auth,
    ClienteEstrutura obj
)

Insere Cliente no sistema, preparando para inserir os serviços

• AuthEstrutura auth
  object
• ClienteEstrutura obj
  object

Return value RetornoEstrutura: Status da inserção com o identificador único do cliente

InsereContaVoip

RetornoEstrutura InsereContaVoip (
    AuthEstrutura auth,
    ContaVoipEstrutura obj,
    int tabela_roteamento_id,
    int tabela_preco_id,
    int ddd_local
)

Insere Conta Voip no sistema

• AuthEstrutura auth
  object
• ContaVoipEstrutura obj
  object
• int tabela_roteamento_id
  ID da tabela de roteamento utilizada por esta conta voip
• int tabela_preco_id
  ID da tabela de preço utilizada por esta conta voip
• int ddd_local
  Esse numero sera prefixo o local da conta Voip

Return value RetornoEstrutura: object

InsereIpDeOrigem

RetornoEstrutura InsereIpDeOrigem (
    AuthEstrutura auth,
    IpDeOrigemEstrutura obj
)

Inserir Ip's de origem, de forma compartilhada ou não compartilhada.

• AuthEstrutura auth
  object
• IpDeOrigemEstrutura obj
  object

Return value RetornoEstrutura: object

InsereNumeroRemoto

RetornoEstrutura InsereNumeroRemoto (
    AuthEstrutura auth,
    NumeroRemotoEstrutura obj
)

Insere Numero Remoto no sistema

• AuthEstrutura auth
  object
• NumeroRemotoEstrutura obj
  object

Return value RetornoEstrutura: Status da inserção, se 1 = Numero Remoto inserido, 0 = Numero Remoto não inserido.

InsereSaldo

RetornoEstrutura InsereSaldo (
    AuthEstrutura auth,
    string numero,
    string dominio,
    float valor
)

Insere saldo em conta voip

• AuthEstrutura auth
  object
• string numero
  Numero da conta voip
• string dominio
  Domínio da conta voip
• float valor
  Valor a ser inserido. Informar valor negativo se desejar remover saldo.

Return value RetornoEstrutura: object

InsereSaldoMinutos

EstruturaSaldoList InsereSaldoMinutos (
    AuthEstrutura auth,
    int id_cliente,
    string servico,
    string tech_prefix,
    int id_regiao,
    int minutos
)

Retorna insere o saldo em minutos de acordo com a região selecionada

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do Cliente.
• string servico
  Conta Voip ou IP de Origem
• string tech_prefix
  Tech prefix do IP de Origem
• int id_regiao
  Identificador único da região.
• int minutos
  Quantidade de minutos a ser adicionado ou retirado do cliente.

Return value EstruturaSaldoList: object

RemoveCliente

RetornoEstrutura RemoveCliente (
    AuthEstrutura auth,
    int id
)

Remove Cliente no sistema, removendo também todos seus serviços

• AuthEstrutura auth
  object
• int id
  Identificador único do Cliente que será removido.

Return value RetornoEstrutura: object

RemoveContaVoip

RetornoEstrutura RemoveContaVoip (
    AuthEstrutura auth,
    string numero,
    string dominio
)

Remove conta voip do sistema

• AuthEstrutura auth
  object
• string numero
  Numero da conta voip que será removida.
• string dominio
  Domínio da conta voip que será removida.

Return value RetornoEstrutura: object

RemoveIpDeOrigem

RetornoEstrutura RemoveIpDeOrigem (
    AuthEstrutura auth,
    string ip,
    boolean compartilhado,
    string tech_prefix
)

Remover Ip's de origem, de forma compartilhada ou não compartilhada por IP + tech_prefix se compartilhado.

• AuthEstrutura auth
  object
• string ip
  Ip que será removido.
• boolean compartilhado
  true ou false para o IP compartilhado.
• string tech_prefix
  tech prefix do IP que será removido.

Return value RetornoEstrutura: object

RemoveNumeroRemoto

RetornoEstrutura RemoveNumeroRemoto (
    AuthEstrutura auth,
    int id
)

Remove Numero Remoto no sistema

• AuthEstrutura auth
  object
• int id
  Identificador único do NUmero Remoto que será removido.

Return value RetornoEstrutura: object

RetornaCidades

CidadeList RetornaCidades (
    AuthEstrutura auth,
    int id,
    int sigla_estado,
    int nome,
    int registro_inicial
)

Retorna objeto do Cliente

• AuthEstrutura auth
  object
• int id
  Identificador único da Cidade
• int sigla_estado
  Sigla do Estado
• int nome
  Nome da Cidade
• int registro_inicial
  Registro inicial

Return value CidadeList: object

RetornaCliente

ClienteEstrutura RetornaCliente (
    AuthEstrutura auth,
    int id
)

Retorna objeto do Cliente

• AuthEstrutura auth
  object
• int id
  Identificador único do Cliente que será pesquisado.

Return value ClienteEstrutura: object

RetornaClientePorNome

ClienteEstrutura RetornaClientePorNome (
    AuthEstrutura auth,
    string nome_cliente
)

Retorna objeto do Cliente

• AuthEstrutura auth
  object
• string nome_cliente
  Identificador único do Cliente que será pesquisado.

Return value ClienteEstrutura: object

RetornaClientesPorNome

ClientesList RetornaClientesPorNome (
    AuthEstrutura auth,
    string nome_cliente
)

Retorna objeto do Cliente

• AuthEstrutura auth
  object
• string nome_cliente
  Identificador único do Cliente que será pesquisado.

Return value ClientesList: object

RetornaContaVoip

ContaVoipEstrutura RetornaContaVoip (
    AuthEstrutura auth,
    string numero,
    string dominio
)

Retorna uma Conta Voip para consulta

• AuthEstrutura auth
  object
• string numero
  Numero da conta voip para consulta.
• string dominio
  Domínio da conta voip para consulta.

Return value ContaVoipEstrutura: object

RetornaFornecedores

FornecedoresList RetornaFornecedores (
    AuthEstrutura auth,
    string nome
)

Retorna Objeto Lista Fornecedores

• AuthEstrutura auth
  object
• string nome
  nome do fornecedor.

Return value FornecedoresList: object

RetornaIpDeOrigem

IpDeOrigemEstrutura RetornaIpDeOrigem (
    AuthEstrutura auth,
    string ip,
    boolean compartilhado,
    string tech_prefix
)

Retorna IP de origem filtrando por IP + tech_prefix caso seja compartilhado.

• AuthEstrutura auth
  object
• string ip
  Ip que será retornado as informações.
• boolean compartilhado
  true ou false para o IP compartilhado.
• string tech_prefix
  tech prefix do IP que será retornado as informações.

Return value IpDeOrigemEstrutura: $obj object

RetornaListaCDR

CDRList RetornaListaCDR (
    AuthEstrutura auth,
    string data_inicio,
    string data_fim,
    string conta_voip,
    int cliente_id,
    string numero_destino,
    string nomeDisplay,
    int registros,
    int registros_inicio,
    string tech_prefix
)

Pesquisa e retorna lista de chamadas. Máximo de 2 meses e 1000 registros por consulta.

• AuthEstrutura auth
  object
• string data_inicio
  Data de inicio da pesquisa - Formato YYYY-MM-DD
• string data_fim
  Data de fim da pesquisa - Formato YYYY-MM-DD
• string conta_voip
  Numero@Dominio da conta voip para pesquisa
• int cliente_id
  ID único do cliente para pesquisa
• string numero_destino
  Numero de destino para pesquisa. Chamadas para rede publica, consultar no formato internacional (00 PAIS AREA NUMERO)
• string nomeDisplay
  Nome de display para pesquisa.
• int registros
  Quantos registros serão buscados
• int registros_inicio
  A partir de qual registro retorna a pesquisa, Usar junto com registros.
• string tech_prefix
  Qual prefixo identificador de serviço será pesquisado

Return value CDRList: object

RetornaListaRegioes

EstruturaRegiaoList RetornaListaRegioes (
    AuthEstrutura auth,
    string nome
)

Retorna objeto do Saldo

• AuthEstrutura auth
  object
• string nome
  Nome da Região [opcional]

Return value EstruturaRegiaoList: object

RetornaNumerosRemotos

NumerosRemotosList RetornaNumerosRemotos (
    AuthEstrutura auth,
    int id,
    string numero
)

Retorna Objeto Lista Numeros Remotos

• AuthEstrutura auth
  object
• int id
  id unico do numero remoto, caso queira listar todos numeros remotos apenas passe esse campo vazio ('').
• string numero
  numero remoto, caso queira listar todos numeros remotos apenas passe esse campo vazio ('').

Return value NumerosRemotosList: object

RetornaPedidos

PedidosList RetornaPedidos (
    AuthEstrutura auth,
    int periodo_pedido,
    int tipo_pedido,
    string data_inicio,
    string data_fim,
    int cliente_id,
    int registro_inicial,
    int registros_por_consulta
)

Retorna Lista de Pedidos da plataforma

• AuthEstrutura auth
  object
• int periodo_pedido
  Periodo do pedido, 0 = Customizado (Nesse caso, será necessaria informar data inicial e data final, 1 = Hoje, 2 = Ontem, 3 = Mes Atual, 4 = Mes Anterior.
• int tipo_pedido
  tipo do pedido, 0 = Automático, 1 = Manual. Para não utilizar esse filtro, informe o parametro como null.
• string data_inicio
  Data minima do periodo dos pedidos.
• string data_fim
  Data maxima do periodo dos pedidos.
• int cliente_id
  ID para pesquisar um cliente especifico.
• int registro_inicial
  Registro inicial da busca.
• int registros_por_consulta
  Quantidade de registros retornados na busca, limitado em 100.

Return value PedidosList: object

RetornaSaldo

SaldoList RetornaSaldo (
    AuthEstrutura auth,
    string tipo,
    int id_cliente,
    int id_servico
)

Retorna objeto do Saldo

• AuthEstrutura auth
  object
• string tipo
  tipo de Busca de saldo. 1 = Cliente, 2 = Conta IP, 3 = Conta Voip, 4 = Numero Remoto
• int id_cliente
  Identificador único do Cliente.
• int id_servico
  Identificador único do Serviço.//Se $tipo = 1 setar este valor como 0. SE $tipo = 2 ou $tipo = 3 ou $tipo = 4 e este campo estiver vazio retorna todos os saldos do serviço selecionado

Return value SaldoList: object

RetornaSaldoMinutos

EstruturaSaldoList RetornaSaldoMinutos (
    AuthEstrutura auth,
    int id_cliente,
    string servico,
    string tech_prefix,
    int id_regiao
)

Retorna objeto do Saldo em Minutos do Serviço

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do Cliente.
• string servico
  Conta Voip ou IP de Origem
• string tech_prefix
  Tech prefix do IP de Origem
• int id_regiao
  Identificador único da região.

Return value EstruturaSaldoList: object

RetornaServicos

ServicoList RetornaServicos (
    AuthEstrutura auth,
    string id_cliente
)

Retorna todos os Serviços do cliente para a consulta

• AuthEstrutura auth
  object
• string id_cliente
  Identificador único do cliente

Return value ServicoList: object

RetornaTabelasPrecoPorNome

TabelaPrecoList RetornaTabelasPrecoPorNome (
    AuthEstrutura auth,
    string nome_tabela_preco
)

Retorna Objeto Lista TabelaPreco

• AuthEstrutura auth
  object
• string nome_tabela_preco
  Nome da Tabela de Preço que será pesquisada.

Return value TabelaPrecoList: object

RetornaTabelasRoteamentoPorNome

TabelasRoteamentoList RetornaTabelasRoteamentoPorNome (
    AuthEstrutura auth,
    string nome_tabela_roteamento
)

Retorna Objeto Lista TabelasRoteamento

• AuthEstrutura auth
  object
• string nome_tabela_roteamento
  Nome da tabela de roteamento que será pesquisada.

Return value TabelasRoteamentoList: object

bloqueiaCliente

RetornoEstrutura bloqueiaCliente (
    AuthEstrutura auth,
    int id_cliente
)

Bloqueia Cliente

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do cliente

Return value RetornoEstrutura: object

bloqueiaServico

RetornoEstrutura bloqueiaServico (
    AuthEstrutura auth,
    int id_cliente,
    string servico
)

Bloqueia Conta VOIP e/ou IP de Origem

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do cliente
• string servico
  nome do serviço se for conta VOIP passar nomeconta@dominio, se for IP de Origem passar o IP de Origem

Return value RetornoEstrutura: object

buscarConsumoCliente

ConsumoList buscarConsumoCliente (
    AuthEstrutura auth,
    int id_cliente,
    string data_inicio,
    string data_final
)

Busca o consumo do cliente por período

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do cliente
• string data_inicio
  Data e Hora do inicio do intervalo de busca do consumo
• string data_final
  Data e Hora do final do intervalo de busca do consumo

Return value ConsumoList: object

desbloqueiaCliente

RetornoEstrutura desbloqueiaCliente (
    AuthEstrutura auth,
    int id_cliente
)

Desbloqueia Cliente

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do cliente

Return value RetornoEstrutura: object

desbloqueiaServico

RetornoEstrutura desbloqueiaServico (
    AuthEstrutura auth,
    int id_cliente,
    string servico
)

Desbloqueia Conta VOIP e/ou IP de Origem

• AuthEstrutura auth
  object
• int id_cliente
  Identificador único do cliente
• string servico
  nome do Serviço se for conta VOIP passar nomeconta@dominio, se for IP de Origem passar o IP de Origem

Return value RetornoEstrutura: object

insereSigaMe

RetornoEstrutura insereSigaMe (
    AuthEstrutura auth,
    string conta_voip,
    int todas,
    string destino_todas,
    int offline,
    string destino_offline,
    int indisponel,
    string destino_indisponel
)

Insere ou altera o siga-me para a conta voip informada.

• AuthEstrutura auth
  object
• string conta_voip
  Conta voip que será inserido o siga-me.
• int todas
  Encaminhamento do siga-me para todas as chamadas. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_todas
  Destino do siga-me para todas chamadas na conta VoIP. se VoIP informar [numero voip]@[dominio].
• int offline
  Encaminhamento do siga-me quando conta offline. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_offline
  Destino do siga-me quando conta offline. se VoIP informar [numero voip]@[dominio].
• int indisponel
  Encaminhamento do siga-me quando conta indisponivel ou ocupada. 0 = Nenhum, 1 = Conta VoIP, 2 = numero externo.
• string destino_indisponel
  Destino do siga-me quando conta indisponivel ou ocupada. se VoIP informar [numero voip]@[dominio].

Return value RetornoEstrutura: object

removeSigaMe

RetornoEstrutura removeSigaMe (
    AuthEstrutura auth,
    string conta_voip
)

Remove siga-me.

• AuthEstrutura auth
  object
• string conta_voip
  Conta voip que será removido o siga-me.

Return value RetornoEstrutura: object

retornaCallerID

CallerIDList retornaCallerID (
    AuthEstrutura auth,
    string servico,
    string tech_prefix
)

Retorna informações do Caller ID.

• AuthEstrutura auth
  object
• string servico
  servico para buscarmos a configuração do Caller ID.
• string tech_prefix
  Tech prefix do servico para buscarmos a configuração do Caller ID.

Return value CallerIDList: object

retornaChamadasSimultaneas

ChamadasSimultaneasEstrutura retornaChamadasSimultaneas (
    AuthEstrutura auth,
    int cliente_id
)

Retorna numero de chamadas simultaneas.

• AuthEstrutura auth
  object
• int cliente_id
  Parametro que diz qual o ID do cliente que vamos listar as chamadas, caso não seja informado, retornamos todos.

Return value ChamadasSimultaneasEstrutura: object

retornaSigaMe

SigaMeEstrutura retornaSigaMe (
    AuthEstrutura auth,
    string conta_voip
)

Retorna siga-me para a conta voip.

• AuthEstrutura auth
  object
• string conta_voip
  Conta voip para buscar o siga-me.

Return value SigaMeEstrutura: object

retornaStatusContaVoip

StatusRegistroList retornaStatusContaVoip (
    AuthEstrutura auth,
    string conta_voip
)

Retorna status para a conta voip.

• AuthEstrutura auth
  object
• string conta_voip
  Conta voip para buscar o status.

Return value StatusRegistroList: object

retornaStatusRemoto

StatusRegistroRemotoEstrutura retornaStatusRemoto (
    AuthEstrutura auth,
    string numero_remoto
)

Retorna status do registro do numero remoto.

• AuthEstrutura auth
  object
• string numero_remoto
  numero remoto para buscar o status.

Return value StatusRegistroRemotoEstrutura: object

Powered by PhpWsdl - PDF download: Download this page as PDF