Sumário:

Table of Contents

Banco de dados

Além de permitir a extração de relatórios pela interface do sistema, a plataforma SIPPulse também disponibiliza um acesso a banco de dados para recuperação de informações já consolidadas em grandes volumes. Disponibilizamos view's dos CDR's das chamadas e outras informações.

Acesso a Views do Sistema

O SIPPulse disponibiliza acesso de leitura aos dados gerados pelo sistema através de acesso a tabelas e views.

Sugerimos que os acessos a volumes grandes de dados sejam feitos fora dos horários de pico para evitar perda de desempenho no ambiente.

Acessando View vi_cdrs

O SIPPulse disponibiliza acesso aos bilhetes (já tarifados) gerados pelo sistema através de uma view de banco de dados chamada vi_cdrs.

Obtendo os dados do usuário de integração de acesso a base de dados, será possível executar consultas a essa view e recuperar os bilhetes gerados pelo sistema.

Exemplo de Consulta Filtrando por Assinante, Serviço e Período:

Code Block
SELECT * FROM vi_cdrs WHERE accountcode = '600002@sippulse.com' AND service = 'pstn' AND call_start_time BETWEEN '2012-10-01 00:00:00' AND '2012-10-05 23:59:59';

O resultado da execução de uma consulta na vi_cdrs retornará os campos listados abaixo:

Campos

Campo	Tipo	Descrição	Exemplo
id (PK)	bigint	Identificador do registro	auto_increment
call_start_time	datetime	Data do início da chamada.	2012-03-24 09:27:20 yyyy-MM-dd HH:mm:ss
src_uri	varchar(255)	SIP URI do originador da chamada.	sip:600002@sippulse.com
dst_uri	varchar(255)	SIP URI do destino da chamada.	sip:554830258080@[ip do gateway]
caller_domain	varchar(255)	Domínio do assinante que originou a chamada.	sippulse.com
caller_id	varchar(255)	Login do assinante que originou a chamada	600002
sip_call_id	varchar(255)	Identificador do diálogo
sip_from_tag	varchar(255)	Tag gerada para marcar o originador da chamada.
sip_to_tag	varchar(255)	Tag gerada para marcar o destinatário da chamada.
duration	varchar(255)	Tempo da duração da chamada em segundos.	45 127
rate	double	Tarifa de venda aplicada para a chamada.	0.18 0.197
price	double	Preço total da chamada para o assinante.	0.56 2.36
accountcode	varchar(128)	Accountcode do assinante que executou a chamada.	600002@sippulse.com
service	varchar(32)	Tipo de serviço da chamada executada.	0800, acobrar, timeout, local, net, pstn, did.
rateplan_name	varchar(64)	Nome do plano de tarifas usado para tarifar a chamada.	PRÉ-BRONZE PÓS-OURO
rateplan_tx_conn	int(11)	Taxa de Conexão do plano de tarifas usado para tarifar a chamada.	30 60
rateplan_cadency	int(11)	Cadência do plano de tarifas usado para tarifar a chamada.	1 6
rateplan_markup	double	Markup do plano de tarifas usado para tarifar a chamada.	10 20.5
rateplan_prepaid	tinyint(1)	Indica se o plano de tarifas é PRÉ ou PÓS pago. 0 para pós-pago e 1 para pré-pago.	0 1
rateplan_rateid	int(11)	RateId do plano de tarifas usado para tarifar a chamada.	20000 30000
reseller_id	int(11)	Identificador de revenda a qual o assinante está associado. Se o valor estiver NULL, o assinante não está associado a nenhuma revenda.	NULL 1
reseller_name	varchar(64)	Nome da revenda a qual o assinante está associado. Se o valor estiver NULL, o assinante não está associado a nenhuma revenda.	NULL Revenda ACME
reseller_rateplan_id	int(11)	Identificador do plano de tarifas da revenda usado para tarifar a chamada.	2000 3000
gwid	int(10)	Identificador do gateway por onde a chamada foi executada.	12001
gw_address	varchar(64)	Endereço IP do gateway por onde a chamada foi executada.	201.64.23.11
gw_name	varchar(64)	Nome do gateway por onde a chamada foi executada.	Asterisk Interno Gateway SP
gw_rateid	int(11)	RateId do plano de tarifas associado ao gateway que executou a chamada.	20000 30000
providerid	int(11)	Identificador do provedor associado ao gateway que executou a chamada.	2
provider_name	varchar(64)	Nome do provedor associado ao gateway que executou a chamada.	OperadoraSul OperadoraNorte
provider_tx_conn	int(11)	Taxa de Conexão do provedor associado ao gateway que executou a chamada.	30 60
provider_cadency	int(11)	Cadência do provedor associado ao gateway que executou a chamada	1 6
profile	varchar(20)	Profile ao qual o assinante está associado.	DEFAULT
user_agent	varchar(64)	User Agent usado na execução da chamada.	Blink 0.2.7 (Windows)
src_ip	varchar(15)	Endereço IP do originador da chamada.	189.4.123.226
matched_prefix	varchar(20)	Prefixo da tarifa de venda usada para a tarifação.	5511
matched_prefix_name	varchar(128)	Nome da tarifa de venda usada para a tarifação.	SAO PAULO FIXO
reseller_rate reseller_price reseller_matched_prefix reseller_matched_prefix_name	double double varchar(20) varchar(128)	Mesma descrição dos outros campos com nome igual. Só que esses campos são associados a uma revenda quanto o assinante está em uma revenda.	0.15 1.25 5517 RIO DE JANEIRO
cost	double	Tarifa de custo aplicada para a chamada.	0.23
cost_price	double	Custo total de compra da chamada.	0.8

Acessando Tabela Acc

O SIPPulse disponibiliza acesso aos bilhetes de chamada não completadas com a causa detalhada do processamento

Obtendo os dados do usuário de integração de acesso a base de dados, será possível executar consultas a essa tabela e recuperar os bilhetes gerados pelo sistema.

Exemplo de Consulta Filtrando por Assinante, Serviço e Período:

Code Block
SELECT * FROM acc WHERE accountcode = '600002@sippulse.com' AND method = 'INVITE' AND sip_code not in (200, 302) AND service = 'pstn' AND time BETWEEN '2012-10-01 00:00:00' AND '2012-10-05 23:59:59';

O resultado da execução de uma consulta na tabela acc, retornará os campos listados abaixo:

Campos

Campo	Tipo	Descrição	Exemplo
id (PK)	bigint	Identificador do registro	auto_increment
time	datetime	Data do início da chamada.	2012-03-24 09:27:20 yyyy-MM-dd HH:mm:ss
sip_code	varchar(3)	código de retorno da transação SIP.	408
sip_reason	varchar(32)	mensagem de retorno da transação SIP.	Request Timeout
src_uri	varchar(255)	SIP URI do originador da chamada.	sip:600002@sippulse.com
dst_uri	varchar(255)	SIP URI do destino da chamada.	sip:554830258080@[ip do gateway]
caller_domain	varchar(255)	Domínio do assinante que originou a chamada.	sippulse.com
caller_id	varchar(255)	Login do assinante que originou a chamada.	600002
callid	varchar(255)	Identificador do diálogo
from_tag	varchar(255)	Tag gerada para marcar o originador da chamada.
to_tag	varchar(255)	Tag gerada para marcar o destinatário da chamada.
accountcode	varchar(128)	Accountcode do assinante que executou a chamada.	600002@sippulse.com
service	varchar(32)	Tipo de serviço da chamada executada.	0800, acobrar, timeout, local, net, pstn, did.
gwid	int(10)	Identificador do gateway por onde a chamada foi executada.	12001
profile	varchar(20)	Profile ao qual o assinante está associado.	DEFAULT
user_agent	varchar(64)	User Agent usado na execução da chamada.	Blink 0.2.7 (Windows)
src_ip	varchar(15)	Endereço IP do originador da chamada.	189.4.123.226
poippi_origem	varchar(10)	Ponto de demarcação de origem do entroncamento (DETRAF). Somente versão STFC.
poippi_destino	varchar(10)	Ponto de demarcação de destino do entroncamento (DETRAF). Somente versão STFC.
eot_origem	varchar(3)	EOT de origem do entroncamento (DETRAF). Somente versão STFC.
eot_destino	varchar(3)	EOT de destino de demarcação de entroncamento (DETRAF). Somente verão STFC.
direction	varchar(8)	Direção da Chamada. Somente versão STFC.	inbound/outbound
descritor	varchar(5)	Descritor da Chamada. Somente versão STFC

APIs de integração

A plataforma SIPPulse disponibiliza acesso a vários serviços através de WEBServices padrão SOAP (XML over HTTP). Através desta interface é possível integrar qualquer sistema utilizando a maioria das linguagens de programação do mercado.

Abaixo segue as especificações dos serviços disponíveis na API de integração.

Transações Aninhadas

O módulo de integração SOAP da plataforma SIPPulseoferece o suporte a transações aninhadas. Isso serve para que o sistema ofereça o recurso de two-phase-commit em transações iniciadas por outros sistemas, utilizando o protocolo XA.

Para que isso ocorra, o sistema que inicia a transação deverá controlar todos os serviços chamados, conforme exemplo abaixo:

O componente Transaction Coodinator será o responsável por iniciar as transações, e com base no resultado dos processamentos ele irá confirmar (commit) ou abortar (rollback) as operações.
DomainWS - Listar Domínios
Esta função tem por objetivo listar os domínios ativos na plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DomainWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DomainWS?wsdl
Operation Name: listDomains
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
sim
Dados de Retorno:
Tipo
Descrição
List<Domain>
Lista dos Domínios em que o administrador possui acesso para gerenciamento.
ProfileWS - Listar Profiles por Domínio
Esta função tem por objetivo listar os profiles associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ProfileWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ProfileWS?wsdl
Operation Name: listProfilesByDomain
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
sim
Dados de Retorno:
Tipo
Descrição
List<Profile>
Lista dos Profiles associados ao domínio.

SubscriberWS - Ativar Assinantes
Esta função tem por objetivo ativar um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS - Desativar Assinantes
Esta função tem por objetivo desativar um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS – Ativar Notificação de Saldo Baixo
Esta função tem por objetivo ativar o aviso de saldo baixo para um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateLowCreditNotification
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
Username
String
Username do assinante.
SIM
Domain
String
Domínio do assinante.
SIM
lowCreditLimit
Double
Limite para saldo ser considerado baixo.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Desativar Notificação de Saldo Baixo
Esta função tem por objetivo desativar o aviso de saldo baixo para um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockLowCreditNotification
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS - Ativar Chamadas Privadas
Esta função tem por objetivo ativar o recurso de chamadas privadas de um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activatePrivacyCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Desativar Chamadas Privadas
Esta função tem por objetivo desativar o recurso de chamadas privadas de um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockPrivacyCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Ativar Execução de Chamadas
Esta função tem por objetivo ativar a execução de chamadas deum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateOutgoingCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Desativar Execução de Chamadas
Esta função tem por objetivo desativar a execução de chamadas deum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockOutgoingCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Ativar Recebimento de Chamadas
Esta função tem por objetivo ativar o recebimento de chamadas deum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateIncommingCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Desativar Recebimento de Chamadas
Esta função tem por objetivo desativar o recebimento de chamadas deum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockIncommingCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Bloquear Chamadas a Cobrar
Esta função tem por objetivo bloquear o recebimento de chamadas a cobrar paraum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockCollectCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Desbloquear Chamadas a Cobrar
Esta função tem por objetivo desbloquear o recebimento de chamadas a cobrar paraum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateCollectCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS – Bloquear Chamadas Anônimas
Esta função tem por objetivo bloquear o recebimento de chamadas anônimas paraum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockAnonymousCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Desbloquear Chamadas Anônimas
Esta função tem por objetivo desbloquear o recebimento de chamadas anônimas paraum assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateAnonymousCalls
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Ativar Ocultação de Topologia
Esta função tem por objetivo ativar o recurso de ocultação de topologia para chamadas realizadas por um assinante.
Nota: Este recurso não é suportado para usuários com endereços atrás de NAT.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateTopologyHiding
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Bloquear Ocultação de Topologia
Esta função tem por objetivo inativar o recurso de ocultação de topologia para chamadas realizadas por um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockTopologyHiding
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Ativar Geração de Estatísticas Diárias
Esta função tem por objetivo ativar o recurso de geração de estatísticas diárias de um assinante. Estas estatísticas são apresentadas no dashboard do portal de administração.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateDailyStatistics
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Bloquear Geração de Estatísticas Diárias
Esta função tem por objetivo bloquear o recurso de geração de estatísticas diárias de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockDailyStatistics
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS - Adicionar Créditos para Assinantes
Esta função tem por objetivo adicionar créditos na conta de um assinante
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: addCredit
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
value
Double
Valor do crédito que será adicionado na conta do assinante
SIM
obs
String
Descrição da transação de inclusão de crédito
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Incluir Novos Assinantes
Esta função tem por objetivo incluir um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: insertSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
password
String
Senha do assinante.
SIM
passwordPortal
String
Senha Portal do Assinante.
SIM
profile
String
Perfil do Assinante no sistema. (recuperar via serviço ProfileWS)
SIM
ratePlanId
Integer
Identificador do plano de tarifas do assinante
SIM
contractNumber
String
Número de contrato do assinante.
NÃO
firstName
String
Nome do Assinante.
NÃO
lastName
String
Sobrenome do Assinante.
NÃO
document
String
Número do Documento do Assinante.
NÃO
address
String
Endereço do Assinante.
NÃO
number
String
Número do Endereço do Assinante.
NÃO
complement
String
Complemento do Endereço do Assinante.
NÃO
quarter
String
Bairro do Endereço do Assinante.
NÃO
city
String
Cidade do Endereço do Assinante.
NÃO
state
String
Estado do Endereço do Assinante.
NÃO
zip
String
CEP do Endereço do Assinante.
NÃO
phone
String
Telefone de Contato do Assinante.
NÃO
mobile
String
Telefone Celular de Contato do Assinante.
NÃO
countryCode
String
Código do país do Assinante. Ex.: 55 (Brasil)
SIM
areaCode
String
Código de Área do Assinante. Ex.:11 (São Paulo)
SIM
callLimit
Integer
Número de Chamadas simultânea que o Assinante poderá executar. Ex. 1
SIM
voicemail
boolean
Flag para ativação do serviço de correio de voz. Ex.: 1 (Ativo) ou 0.
SIM
voicemailPassword
String
Senha para o serviço de correio de voz
NÃO
resellerId
Integer
Identificador da revenda associada ao assinante, caso exista.
SIM
resellerBillingType
Integer
Tipo de Bilhetagem que a revenda aplicará na conta do assinante. 0: Marckup \ 1: Plano de Tarifas. Valor default 0.0.
NÃO
resellerMarckup
Double
Tipo de Bilhetagem que a revenda aplicará na conta do assinante.
0: Marckup / 1: Plano de Tarifas. Valor Default 0.
NÃO
resellerRateplanId
Integer
Quando a estratégia resellerBillingType=1, define-se o identificador do plano de tarifas que a revenda aplicará nesta conta.
NÃO
rpid
String
Número de Identificação para chamadas originadas pelo Assinante.
NÃO
callFwd
String
Endereço sip para o serviço siga-me. Ex.: sip:1000@sippulse.com
NÃO
fwdBusy
String
Endereço sip para o serviço siga-me quando ocupado. Ex.: sip:1000@sippulse.com
NÃO
noAnswer
String
Endereço sip para o serviço siga-me quando não atende. Ex.: sip:1000@sippulse.com
NÃO
activeIncomingCalls
boolean
Define se o assinante estará habilitado para receber chamadas.
Default true.
NÃO
activeOutgoingCalls
boolean
Define se o assinante estará habilitado para executar chamadas.
Default true.
NÃO
blockCollectCalls
boolean
Define se o bloqueio de recebimento de chamadas ACOBRAR está ativo. Default false. Mecanismo disponível em distro STFC.
NÃO
blockAnonymousCalls
boolean
Define se o bloqueio de recebimento de chamadas ACOBRAR está ativo. Default false.
NÃO
lowCreditNotification
boolean
Ativa o recurso de aviso de saldo baixo. Default False.
Mecanismo válido para assinantes que possuem planos PRÉ-PAGO.
NÃO
lowCreditLimit
double
Valor mínimo de crédito para ativação do mecanismo de aviso. Default 0.0.
NÃO
Dados de Retorno:
Tipo
Descrição
Integer
Identificador do novo assinante gerado pelo sistema.
SubscriberWS - Alteração de Assinantes
Esta função tem por objetivo alterar os dados de um assinante dentro da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: updateSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
password
String
Senha do assinante.
SIM
profile
String
Perfil do Assinante no sistema. (recuperar via serviço ProfileWS)
SIM
ratePlanId
Integer
Identificador do plano de tarifas do assinante
SIM
emailAdress
String
Email do Assinante.
SIM
contractNumber
String
Número de contrato do assinante.
NÃO
firstName
String
Nome do Assinante.
NÃO
lastName
String
Sobrenome do Assinante.
NÃO
document
String
Número do Documento do Assinante.
NÃO
address
String
Endereço do Assinante.
NÃO
number
String
Número do Endereço do Assinante.
NÃO
complement
String
Complemento do Endereço do Assinante.
NÃO
quarter
String
Bairro do Endereço do Assinante.
NÃO
city
String
Cidade do Endereço do Assinante.
NÃO
state
String
Estado do Endereço do Assinante.
NÃO
zip
String
CEP do Endereço do Assinante.
NÃO
phone
String
Telefone de Contato do Assinante.
NÃO
mobile
String
Telefone Celular de Contato do Assinante.
NÃO
countryCode
String
Código do país do Assinante. Ex.: 55 (Brasil)
SIM
areaCode
String
Código de Área do Assinante. Ex.:11 (São Paulo)
SIM
callLimit
Integer
Número de Chamadas simultânea que o Assinante poderá executar. Ex. 1
SIM
voicemail
boolean
Flag para ativação do serviço de correio de voz. Ex.: 1 (Ativo) ou 0.
SIM
voicemailPassword
String
Senha para o serviço de correio de voz
NÃO
rpid
String
Número de Identificação para chamadas originadas pelo Assinante.
NÃO
callFwd
String
Endereço sip para o serviço siga-me. Ex.: sip:1000@sippulse.com
NÃO
fwdBusy
String
Endereço sip para o serviço siga-me quando ocupado. Ex.: sip:1000@sippulse.com
NÃO
noAnswer
String
Endereço sip para o serviço siga-me quando não atende. Ex.: sip:1000@sippulse.com
NÃO

SubscriberWS - Consultar Saldo do Assinante
Esta função tem por objetivo consultar saldo de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: retrieveCredit
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Double
Saldo do assinante.

SubscriberWS - Trocar senha de Assinantes
Esta função tem por objetivo trocar a senha de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: changePassword
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
actualPassword
String
Senha atual do assinante.
SIM
newPassword
String
Nova senha a ser atribuída ao assinante
SIM
confirmNewPassword
String
Confirmação da nova senha.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Trocar Profile do Assinante
Esta função tem por objetivo trocar o profile de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: changeProfile
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
newProfileId
Integer
ID do Profile que será definido para o assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Remover Assinante
Esta função tem por objetivo remover um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: removeSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Consultar Senha do Assinante
Esta função tem por objetivo consultar senha de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: retrievePassword
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
String
Senha atual do assinante.

SubscriberWS – Recuperar Dados do Assinante
Esta função tem por objetivo recuperar os dados de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: retrieveSubscriber
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
SubscriberDTO
Dados atuais do assinante.
SubscriberWS – Alteração de Dados de Bilhetagem do Assinante
Esta função tem por objetivo alterar os dados de bilhetagem de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: updateSubscriberBillingInfo
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
subscriber
SubscriberBillingInfoDTO
Objeto que contém os dados de bilhetagem (descrito mais abaixo)
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Alteração de Dados Classe V do Assinante
Esta função tem por objetivo alterar os dados de Classe V de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: updateSubscriberClassV
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
subscriber
SubscriberClassVDTO
Objeto que contém os dados de bilhetagem (descrito mais abaixo).
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS – Alteração de Dados de Serviços do Assinante
Esta função tem por objetivo alterar os dados de Serviços de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: updateSubscriberServices
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
subscriber
SubscriberServicesDTO
Objeto que contém os dados de Serviços (descrito mais abaixo).
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Ativar Voicemail do Assinante
Esta função tem por objetivo ativar o voicemail de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: activateVoicemail
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
voicemailPassword
Long
Senha numérica do voicemail do assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Desativar Voicemail do Assinante
Esta função tem por objetivo desativar o voicemail de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: blockVoicemail
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

SubscriberWS - Adicionar Alias de Assinante
Esta função tem por objetivo adicionar um alias a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DBAliasesWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DBAliasesWS?wsdl
Operation Name: insertDBAliases
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
dbAliases
DbAliases
Contém os dados do alias de um assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
SubscriberDTO
Dados atuais do assinante.
SubscriberWS - Remover Alias de Assinante
Esta função tem por objetivo remover um alias a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DBAliasesWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DBAliasesWS?wsdl
Operation Name: deleteDBAliases
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
dbAliases
Integer
Identificador de registro a ser excluído.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
SubscriberWS – Recuperar Quota Diária
Esta função tem por objetivo recuperar as informações de quota diária de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: retrieveDailyQuota
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
SubscriberDTO
Dados atuais do assinante.
SubscriberWS – Alterar a Quota Diária
Esta função tem por objetivo alterar as informações de quota diária de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl
Operation Name: updateDailyQuota
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Username do assinante.
SIM
domain
String
Domínio do assinante.
SIM
dailyQuota
Boolean
Flag que indica a ativação ou não do recurso.
SIM
dailyQuotaType
String
Tipo de controle de quota diária. Valores possíveis:
M: Limita a quota diária em minutos.
V: Limita a quota diária em valores.
SIM
dailyQuotaLimit
Double
Valor limite de uso diário, com base no tipo definido acima.
SIM
dailyQuotaConsumed
Double
Valor da quota consumido até o momento.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

DidWS - Inclusão de DID's
Esta função tem como objetivo incluir um novo DID associado a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DidWS?wsdl
Operation Name: insertDid
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountCode
String
Account Code do assinante que possui o Did
SIM
aliasUsername
String
Número do Did que será utilizado na rede pública. Ex: 1130258080.
SIM
username
String
Usuário de destino de entrega da chamada ao Did.
SIM
domain
String
Domínio de destino de entrega da chamada ao Did.
SIM
monthlySubscription
Double
Valor da mensalidade do Did, caso exista.
NÃO
reverseBilling
Boolean
Flag que ativa a bilhetagem reversa. Utilizado apenas para números 0800.
NÃO
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
SubscriberDTO
Dados atuais do assinante.

DidWS - Exclusão de DID's
Esta função tem como objetivo excluir um DID associado a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DidWS?wsdl
Operation Name: deleteDid
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
didId
Integer
Identificador do DID que será excluído.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

DidWS - Listar DID's Associados a um Assinante
Esta função tem como objetivo listar os DID's associados a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DidWS?wsdl
Operation Name: listByAcc
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountCode
String
Account Code do assinante que possui o Did.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

Dados de Retorno:

Tipo
Descrição
List<Did>
Lista de DID's associados ao assinante.
DidWS - Listar DID's Disponíveis
Esta função tem como objetivo listar os DID's disponíveis no sistema.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DidWS?wsdl
Operation Name: listAvailablesNumbers
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio associado aos números disponíveis.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

Dados de Retorno:
Tipo
Descrição
List<Did>
Lista de DID's disponíveis no sistema.

ResellerWS - Inclusão de Revendas
Esta função tem como objetivo incluir uma nova Revenda no sistema.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ResellerWS?wsdl
Operation Name: insertReseller
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio da revenda.
SIM
name
String
Nome da Revenda
SIM
manager
String
Nome do Responsável pela Revenda
SIM
email
String
E-mail do responsável pela Revenda.
SIM
phone
String
Telefone do responsável pela Revenda.
NÃO
mobile
String
Telefone Móvel do rsponsável pela Revenda.
NÃO
username
String
Usuário de acesso ao portal de revendas.
SIM
password
String
Senha de acesso ao portal das revendas.
SIM
credit
Double
Valor do Crédito da Revenda (Planos Pré-pagos). Valor Default ZERO.
NÃO
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Integer
Identificador do novo registro gerado pelo sistema.
ResellerWS - Exclusão de Revendas
Esta função tem como objetivo excluir uma Revenda.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ResellerWS?wsdl
Operation Name: deleteReseller
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
resellerId
Integer
Identificador da Revenda que será excluída.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
ResellerWS - Listar Revendas
Esta função tem como objetivo listar as Revendas de um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ResellerWS?wsdl
Operation Name: listByDomain
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
Domain
String
Domínio das revendas.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<Reseller>
Lista de Revendas associados ao domínio.

ResellerWS - Adicionar Créditos para Revendas
Esta função tem por objetivo adicionar créditos na conta de uma revenda
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ResellerWS?wsdl
Operation Name: addResellerCredit
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
resellerName
String
Nome da Revenda.
SIM
Domain
String
Domínio da Revenda.
SIM
Value
Double
Valor do crédito que será adicionado na conta da revenda.
SIM
Obs
String
Descrição da transação de inclusão de crédito
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

ResellerWS - Saldo da revenda
Esta função tem por objetivo mostrar saldo de uma revenda
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/ResellerWS?wsdl
Operation Name: retrieveResellerCredit
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
resellerId
Integer
Identificador da Revenda que será excluída.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Double
O valor do crédito da revenda.
WhitelistWS - Inclusão de Whitelist
Esta função tem como objetivo incluir um novo número na whitelist do assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/WhiteListWS?wsdl
Operation Name: insertWhiteList
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Identificação do Assinante
SIM
domain
String
Domínio do Assinante
SIM
prefix
String
Número que será cadastrado na whitelist
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Integer
Identificador do novo registro gerado pelo sistema.

WhitelistWS - Exclusão de WhiteList
Esta função tem como objetivo excluir um número da lista whitelist do assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/WhiteListWS?wsdl
Operation Name: deleteWhiteList
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
whiteListId
Integer
Identificador do WhiteList que será excluído
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

WhitelistWS - Listar WhiteList
Esta função tem como objetivo listar os WhiteList's associados a um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/WhiteListWS?wsdl
Operation Name: listWhiteList
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
whiteListId
Integer
Identificador do WhiteList que será excluído
SIM
domain
String
Domínio do assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<UserWhiteList>
Lista de WhiteList's associados ao assinante.
RatePlanWS - Listar Plano de Tarifas por Domínio
Esta função tem como objetivo listar o Plano de Tarifas associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RatePlanWS?wsdl
Operation Name: listRatePlansByDomain
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio do assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<RatePlan>
Lista de RatePlan associados ao domínio
RatePlanWS - Incluir Plano de Tarifas por Domínio
Esta função tem como objetivo incluir um Plano de Tarifas associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RatePlanWS?wsdl
Operation Name: insertRatePlan
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
name
String
Nome do plano de tarifas
SIM
domain
String
Dominio associado ao plano de tarifas
SIM
rateid
Integer
Identificador da tabela de tarifas associada ao plano (Vide Rates)
SIM
prepaid
boolean
Indica se o plano é PRE-PAGO. Em caso negativo, o plano terá o comportamento de POS-PAGO. Default false.
SIM
txConnection
Integer
Taxa de Conexão que será aplicada para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.
SIM
cadency
Integer
Cadência que será aplicada após a Taxa de Conexão para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.
SIM
freeMinutes
Integer
Campo meramente informativo para calculo de franquias. Utilizado por sistemas de CRM. Default 0.
NÃO
markup
double
Taxa de Markup que será aplicada na tabela de tarifas associada ao plano. Default 0.0.
NÃO
blockCallsWithoutRate
boolean
Flag que indica se o sistema irá bloquear a execução de chamadas para destinos sem uma tarifa de venda associada. Default false.
NÃO
limitToCreditExpires
Integer
Limite de validade (em dias) para os créditos adicionados a uma conta. Válido apenas para planos PRE-PAGO. Default 0.
NÃO
txDelay
Integer
Taxa de delay (em segundos) para inicio de calculo da duração/abatimento de créditos de uma chamada. Ex. Delay = 3, a chamada será contabilizada somente após o segundo 4. Default 0.
NÃO
txDiscard
Inteeger
Taxa de descarte (em segundos). O sistema irá descartar as chamadas com tempo igual ou inferior a taxa de descarte configurada. As chamadas acima da taxa de descarte, serão tarifadas com a duração total. Default 0.
NÃO
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
RatePlan
Retorna o plano de tarifas com o identificador único gerado pelo sistema.

RatePlanWS - Alterar Plano de Tarifas por Domínio
Esta função tem como objetivo alterar um Plano de Tarifas associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RatePlanWS?wsdl
Operation Name: updateRatePlan
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
id
Integer
Identificador único do plano de tarifas
SIM
name
String
Nome do plano de tarifas
SIM
rateid
Integer
Identificador da tabela de tarifas associada ao plano (Vide Rates)
SIM
prepareid
boolean
Indica se o plano é PRE-PAGO. Em caso negativo, o plano terá o comportamento de POS-PAGO. Default false.
SIM
txConnection
Integer
Taxa de Conexão que será aplicada para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.
SIM
cadency
Integer
Cadência que será aplicada após a Taxa de Conexão para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.
SIM
freeMinutes
Integer
Campo meramente informativo para calculo de franquias. Utilizado por sistemas de CRM. Default 0.
NÃO
markup
double
Taxa de Markup que será aplicada na tabela de tarifas associada ao plano. Default 0.0.
NÃO
blockCallsWithoutRate
boolean
Flag que indica se o sistema irá bloquear a execução de chamadas para destinos sem uma tarifa de venda associada. Default false.
NÃO
limitToCreditExpires
Integer
Limite de validade (em dias) para os créditos adicionados a uma conta. Válido apenas para planos PRE-PAGO. Default 0.
NÃO
txDelay
Integer
Taxa de delay (em segundos) para inicio de calculo da duração/abatimento de créditos de uma chamada. Ex. Delay = 3, a chamada será contabilizada somente após o segundo 4. Default 0.
NÃO
txDiscard
Integer
Taxa de descarte (em segundos). O sistema irá descartar as chamadas com tempo igual ou inferior a taxa de descarte configurada. As chamadas acima da taxa de descarte, serão tarifadas com a duração total. Default 0.
NÃO
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
RatePlan
Retorna o plano de tarifas atualizado.

RatePlanWS - Remover Plano de Tarifas por Domínio
Esta função tem como objetivo remover um Plano de Tarifas associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RatePlanWS?wsdl
Operation Name: removeRatePlan
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
id
Integer
Identificador único do plano de tarifas
SIM
principal
UpserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

RateWS - Listar Tarifas de Venda
Esta função tem como objetivo listar as Tarifas de Venda de um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RateWS?wsdl
Operation Name: listRatesByParams
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
Domain
String
Domínio das tarifas de venda
SIM
Description
String
Filtro pela descrição da tarifa.
NÃO
RateId
Integer
Filtro pelo RateId da tarifa.
NÃO
Prefix
String
Filtro pelo prefixo da tarifa.
NÃO
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<Rate>
Lista de Tarifas de Venda encontradas no domínio.

RateWS – Inclusão de Tarifas de Venda
Esta função tem como objetivo incluir novas Tarifas de Venda (em lote) em um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RateWS?wsdl
Operation Name: insertRates
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
Rate
List<RateDTO>
Lista com as Tarifas de Venda que serão incluídas (descrito mais abaixo).
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

RateWS - Exclusão de Tarifas de Venda
Esta função tem como objetivo excluir uma Tarifa de Venda.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RateWS?wsdl
Operation Name: removeRate
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
RateID
Integer
Identificador da Tarifa de Venda que será excluída.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

RateWS - Exclusão de Tarifas de Venda por RateId
Esta função tem como objetivo excluir todas as Tarifas de Venda associadas a um RateId.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/RateWS?wsdl
Operation Name: removeAllRatesByRateId
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
Domain
String
Domínio das Tarifas de Venda que serão excluídas
SIM
RateID
Integer
RateId das Tarifas de Venda que serão excluídas.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

Dados de Retorno:
Tipo
Descrição
Integer
Quantidade de Tarifas de Venda que foram excluídas.

DialplanWS - Listar Plano de Discagem
Esta função tem como objetivo listar o Plano de Discagem associado a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/DialplanWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/DialplanWS?wsdl
Operation Name: listDialplansByDomain
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio do assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<Dialplan>
Lista de Dialplan associados ao domínio.

AccountGroupWS - Adicionar Account Group
Esta função tem como objetivo adicionar um Account Group.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AccountGroupWS?wsdl
Operation Name: addAccountGroup
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountManager
String
Account code da conta agrupadora.
SIM
managerProfile
String
Profile da conta agrupadora.
SIM
accounts
List<String>
Lista de Account codes que serão beneficiadas pelo agrupamento.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
AccountGroupWS - Recuperar um Account Group
Esta função tem como objetivo recuperar um Account Group.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AccountGroupWS?wsdl
Operation Name: retrieveAccountGroup
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountManager
String
Account code da conta agrupadora.
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
AccountGroup
Contém os dados da conta agrupadora e das contas agrupadas.
AccountGroupWS - Remover Account Group
Esta função tem como objetivo remover um Account Group.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AccountGroupWS?wsdl
Operation Name: removeAccountGroup
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante da plataforma
SIM
password
String
Senha de autenticação do assinante
SIM

Dados de Retorno:
Tipo
Descrição
SubscriberDTO
Contém os dados da conta do assinante autenticado.

CustomerWS - Troca de Senha do Assinante
Esta função tem como objetivo trocar a senha de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/CustomerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/CustomerWS?wsdl
Operation Name: changeCustomerPassword
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante da plataforma
SIM
actualPassword
String
Senha atual de autenticação do assinante
SIM
newPassword
String
Nova senha do assinante
SIM
confirmNewPassword
String
Confirmação da nova senha do assinante
SIM
CustomerWS - Crédito Atual do Assinante
Esta função tem como objetivo recuperar o crédito atual de um assinante da plataforma.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/CustomerWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/CustomerWS?wsdl
Operation Name: retrieveCustomerCredit
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
password
String
Senha de autenticação do assinante
SIM
domain
String
Domínio do assinante na plataforma
SIM
Dados de Retorno:
Tipo
Descrição
Double
valor atual do crédito do assinante
UserLocationWS - Listar Registros de um Assinante
Esta função tem como objetivo listar os registros de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/UserLocationWS?wsdl
Operation Name: listUserLocations
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

Dados de Retorno:
Tipo
Descrição
List<Location>
Lista contendo os registros atuais do assinante.

UserLocationWS - Adicionar Registros Permanentes para um Assinante
Esta função tem como objetivo adicionar um registro permanente para um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/UserLocationWS?wsdl
Operation Name: addUserLocation
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante
SIM
contact
String
Endereço do registro do assinante. Ex.: sip:[username]@[ipaddress]:port
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
UserLocationWS - Remover Registros Permanentes para um Assinante
Esta função tem como objetivo remover um registro permanente para um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/UserLocationWS?wsdl
Operation Name: removeUserLocation
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante
SIM
contact
String
Endereço do registro do assinante. Ex.: sip:[username]@[ipaddress]:port
SIM
principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

AddressWS – Lista as Autenticações por IP de um Assinante
Esta função tem como objetivo listar as autenticações por IP de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AddressWS?wsdl
Operation Name: listAddresses
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
List<Adress>
Lista contendo os dados de autenticação por IP de um assinante.

AddressWS – Inserir Autenticações por IP de um Assinante
Esta função tem como objetivo inserir autenticações por IP de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AddressWS?wsdl
Operation Name: insertAddresses
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountcode
String
Accountcode do assinante. Ex.: username@domain
SIM
contextinfo
String
[não obrigatório, gerado pelo sistema]
NÃO
domain
String
Domínio do assinante
SIM
group
String
[não obrigatório, gerado pelo sistema]
NÃO
Id
Integer
[não obrigatório, gerado pelo sistema no evento de inclusão]
NÃO
IpAdress
String
endereço ip para autorização
SIM
mask
Integer
máscara que será aplicada ao endereço ip, normalmente o valor 32.
SIM
method
String
pode ser informado os seguintes valores [iponly, techprefix, ip+cpt, ip+cli]
SIM
pattern
String
[não obrigatório, gerado pelo sistema no evento de inclusão]
NÃO
port
Integer
porta padrão para autenticação, para liberar todas, informe o valor 0 (zero).
SIM
protocol
String
pode ser informado os seguintes valores [tcp, udp, tls, any] normalmente usa-se any.
SIM
username
String
Username do assinante
SIM
techprefix
String
é obrigatório quando usa-se os methods techprefix e ip+cpt.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Adress
Contem o registro de autenticação por IP gerado no sistema.

AddressWS – Alterar Autenticações por IP de um Assinante
Esta função tem como objetivo alterar autenticações por IP de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AddressWS?wsdl
Operation Name: updateAddresses
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
accountcode
String
Accountcode do assinante. Ex.: username@domain
SIM
contextinfo
String
[não obrigatório, gerado pelo sistema]
NÃO
domain
String
Domínio do assinante
SIM
group
String
[não obrigatório, gerado pelo sistema]
NÃO
Id
Integer
[não obrigatório, gerado pelo sistema no evento de inclusão]
NÃO
IpAdress
String
endereço ip para autorização
SIM
mask
Integer
máscara que será aplicada ao endereço ip, normalmente o valor 32.
SIM
method
String
pode ser informado os seguintes valores [iponly, techprefix, ip+cpt, ip+cli]
SIM
Pattern
String
[não obrigatório, gerado pelo sistema no evento de inclusão]
NÃO
Port
Integer
porta padrão para autenticação, para liberar todas, informe o valor 0 (zero).
SIM
Protocol
String
pode ser informado os seguintes valores [tcp, udp, tls, any] normalmente usa-se any.
SIM
Username
String
Username do assinante
SIM
Techprefix
String
é obrigatório quando usa-se os methods techprefix e ip+cpt.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
Adress
Contem o registro de autenticação por IP gerado no sistema.

AddressWS – Excluir Autenticações por IP de um Assinante
Esta função tem como objetivo excluir autenticações por IP de um assinante.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/AddressWS?wsdl
Operation Name: removeAddresses
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio do registro de autenticação por ip.
SIM
Id
Integer
Identificador único do registro
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

HuntGroupWS – Listar HuntGroups
Esta função tem como objetivo listar os huntgroups associados a um domínio.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/HuntGroupWS?wsdl
Operation Name: listHuntGroups
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio do registro de autenticação por ip.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

Dados de Retorno:
Tipo
Descrição
List<HuntGroup>
Lista contendo os huntgroups associados ao domínio informado.

HuntGroupWS – Inserir HuntGroups
Esta função tem como objetivo inserir um novo huntgroup no sistema.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/HuntGroupWS?wsdl
Operation Name: insertHuntGroups
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
id
Integer
[Não deve ser informado no momento da inclusão, será gerado automaticamente pelo sistema]
NÃO
domain
String
Domínio do assinante
SIM
description
String
Nome do grupo.
SIM
groupList
String
Lista de usernames separados por ; (ponto e vírgula) que fazem parte do grupo
Ex.: joao;maria;jose
SIM
method
String
Tipo de distribuição das chamadas no grupo.
paralell: Entrega as chamadas para todos os membros do grupo de forma paralela.
serial: Entrega as chamadas para os membros do grupo de forma seqüencial, com base no timeout definido.
SIM
uri
String
[Não deve ser informado no momento da incluão, será gerado automaticamente pelo sistema]
NÃO
timeout
Integer
Tempo para execução da entrega da chamada, com base na método de entrega definido.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
HuntGroup
Retorna os dados do Huntgroup atualizado pelo sistema.

HuntGroupWS – Alterar HuntGroups
Esta função tem como objetivo alterar um huntgroup no sistema.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/HuntGroupWS?wsdl
Operation Name: updateHuntGroups
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
id
Integer
[Não deve ser informado no momento da inclusão, será gerado automaticamente pelo sistema]
NÃO
domain
String
Domínio do assinante
SIM
description
String
Nome do grupo.
SIM
groupList
String
Lista de usernames separados por ; (ponto e vírgula) que fazem parte do grupo
Ex.: joao;maria;jose
SIM
method
String
Tipo de distribuição das chamadas no grupo.
paralell: Entrega as chamadas para todos os membros do grupo de forma paralela.
serial: Entrega as chamadas para os membros do grupo de forma seqüencial, com base no timeout definido.
SIM
uri
String
[Não deve ser informado no momento da inclusão, será gerado automaticamente pelo sistema]
NÃO
timeout
Integer
Tempo para execução da entrega da chamada, com base na método de entrega definido.
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM
Dados de Retorno:
Tipo
Descrição
HuntGroup
Retorna os dados do Huntgroup atualizado pelo sistema.

HuntGroupWS – Excluir HuntGroups
Esta função tem como objetivo excluir um huntgroup no sistema.
URL Descritiva do Serviço:
http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl
IP_SERVER: Endereço do servidor que hospeda o sistema.
PORT: Porta de acesso ao serviço. Geralmente utilizamos a porta 8080.
Exemplo:
http://sippulse.com:8080/SipPulse/HuntGroupWS?wsdl
Operation Name: removeHuntGroup
Parâmetros:
Parâmetro
Tipo
Descrição
Requerido
id
Integer
Deverá ser informado no momento da exclusão.
SIM
domain
String
Domínio do assinante
SIM
Principal
UserPrincipal
Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).
SIM

UserPrincipal

Este objeto representa as credenciais de um administrador válido para o sistema. Todo serviço exposto para integração requisitará esta informação. Com base no principal informado, o sistema validará suas credenciais, além de verificar se o mesmo tem acesso de administração para o domínio informado.
Atributos

Parâmetro
Tipo
Descrição
Requerido
login
String
Login do administrador
SIM
password
String
Senha do administrador
SIM

SubscriberBillingInfoDTO

Este objeto representa os dados de bilhetagem de um assinante do sistema, sendo utilizado no serviço que atualiza as informações do mesmo.
Atributos

Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante na plataforma
SIM
contractNumber
String
Número do contrato do assinante
NÃO
firstName
String
Nome
NÃO
lastName
String
Sobrenome
NÃO
document
String
CPF/CNPJ
NÃO
address
String
Endereço
NÃO
number
String
Número
NÃO
complement
String
Complemento
NÃO
quarter
String
Bairro
NÃO
city
String
Cidade
NÃO
state
String
Estado
NÃO
zip
String
CEP
NÃO
phone
Long
Telefone
NÃO
mobile
Long
Celular
NÃO
SubscriberClassVDTO

Este objeto representa os dados de Classe V de um assinante do sistema, sendo utilizado no serviço que atualiza as informações do mesmo.
Atributos
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante na plataforma
SIM
callFwd
String
Siga-me
NÃO
fwdBusy
String
Siga-me ocupado
NÃO
noAnswer
String
Siga-me Não Atende
NÃO
callGroup
Integer
Call Group
NÃO
pickupGroup
String
Pickup Group
NÃO
pinCode
String
Código PIN do assinante
NÃO
bossSecretary
String
Serviço Chefe/Secretária
NÃO
SubscriberServicesDTO

Este objeto representa os dados referentes aos atributos de serviços de um assinante do sistema, sendo utilizado no serviço que atualiza as informações do mesmo.
Atributos
Parâmetro
Tipo
Descrição
Requerido
username
String
Login do assinante
SIM
domain
String
Domínio do assinante na plataforma
SIM
email
String
E-mail
NÃO
countryCode
String
Código do País
NÃO
areaCode
String
Código da Área
NÃO
cityCode
String
Código da Localidade
NÃO
localArea
String
Sigla da Localidade
NÃO
rpid
String
Id da Chamada
NÃO
callLimit
Integer
Chamadas Simultâneas
NÃO
cps
Int
Chamadas por Segundo
NÃO
keepAlive
Int
Keep Alive
NÃO

RateDTO

Este objeto representa uma Tarifa de Venda do sistema.
Atributos
Parâmetro
Tipo
Descrição
Requerido
domain
String
Domínio do assinante na plataforma
SIM
name
String
Descrição da Tarifa de Venda
SIM
prefix
String
Prefixo da Tarifa de Venda
SIM
rateId
Integer
Identificador do grupo de tarifas.
SIM
rateValue
Double
Valor de venda da Tarifa.
SIM
serviceType
String
Tipo de Ligação da Tarifa.
NÃO

Parâmetro	Tipo	Descrição	Requerido
username	String	Username do assinante.	SIM
domain	String	Domínio do assinante.	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
password	String	Senha do assinante.	SIM
profile	String	Perfil do Assinante no sistema. (recuperar via serviço ProfileWS)	SIM
ratePlanId	Integer	Identificador do plano de tarifas do assinante	SIM
emailAdress	String	Email do Assinante.	SIM
contractNumber	String	Número de contrato do assinante.	NÃO
firstName	String	Nome do Assinante.	NÃO
lastName	String	Sobrenome do Assinante.	NÃO
document	String	Número do Documento do Assinante.	NÃO
address	String	Endereço do Assinante.	NÃO
number	String	Número do Endereço do Assinante.	NÃO
complement	String	Complemento do Endereço do Assinante.	NÃO
quarter	String	Bairro do Endereço do Assinante.	NÃO
city	String	Cidade do Endereço do Assinante.	NÃO
state	String	Estado do Endereço do Assinante.	NÃO
zip	String	CEP do Endereço do Assinante.	NÃO
phone	String	Telefone de Contato do Assinante.	NÃO
mobile	String	Telefone Celular de Contato do Assinante.	NÃO
countryCode	String	Código do país do Assinante. Ex.: 55 (Brasil)	SIM
areaCode	String	Código de Área do Assinante. Ex.:11 (São Paulo)	SIM
callLimit	Integer	Número de Chamadas simultânea que o Assinante poderá executar. Ex. 1	SIM
voicemail	boolean	Flag para ativação do serviço de correio de voz. Ex.: 1 (Ativo) ou 0.	SIM
voicemailPassword	String	Senha para o serviço de correio de voz	NÃO
rpid	String	Número de Identificação para chamadas originadas pelo Assinante.	NÃO
callFwd	String	Endereço sip para o serviço siga-me. Ex.: sip:1000@sippulse.com	NÃO
fwdBusy	String	Endereço sip para o serviço siga-me quando ocupado. Ex.: sip:1000@sippulse.com	NÃO
noAnswer	String	Endereço sip para o serviço siga-me quando não atende. Ex.: sip:1000@sippulse.com	NÃO

Parâmetro	Tipo	Descrição	Requerido
subscriber	SubscriberBillingInfoDTO	Objeto que contém os dados de bilhetagem (descrito mais abaixo)	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
subscriber	SubscriberClassVDTO	Objeto que contém os dados de bilhetagem (descrito mais abaixo).	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
subscriber	SubscriberServicesDTO	Objeto que contém os dados de Serviços (descrito mais abaixo).	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
dbAliases	DbAliases	Contém os dados do alias de um assinante	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
dbAliases	Integer	Identificador de registro a ser excluído.	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
accountCode	String	Account Code do assinante que possui o Did	SIM
aliasUsername	String	Número do Did que será utilizado na rede pública. Ex: 1130258080.	SIM
username	String	Usuário de destino de entrega da chamada ao Did.	SIM
domain	String	Domínio de destino de entrega da chamada ao Did.	SIM
monthlySubscription	Double	Valor da mensalidade do Did, caso exista.	NÃO
reverseBilling	Boolean	Flag que ativa a bilhetagem reversa. Utilizado apenas para números 0800.	NÃO
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
didId	Integer	Identificador do DID que será excluído.	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
domain	String	Domínio associado aos números disponíveis.	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
domain	String	Domínio da revenda.	SIM
name	String	Nome da Revenda	SIM
manager	String	Nome do Responsável pela Revenda	SIM
email	String	E-mail do responsável pela Revenda.	SIM
phone	String	Telefone do responsável pela Revenda.	NÃO
mobile	String	Telefone Móvel do rsponsável pela Revenda.	NÃO
username	String	Usuário de acesso ao portal de revendas.	SIM
password	String	Senha de acesso ao portal das revendas.	SIM
credit	Double	Valor do Crédito da Revenda (Planos Pré-pagos). Valor Default ZERO.	NÃO
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
resellerId	Integer	Identificador da Revenda que será excluída.	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
Domain	String	Domínio das revendas.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
resellerName	String	Nome da Revenda.	SIM
Domain	String	Domínio da Revenda.	SIM
Value	Double	Valor do crédito que será adicionado na conta da revenda.	SIM
Obs	String	Descrição da transação de inclusão de crédito	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
username	String	Identificação do Assinante	SIM
domain	String	Domínio do Assinante	SIM
prefix	String	Número que será cadastrado na whitelist	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
whiteListId	Integer	Identificador do WhiteList que será excluído	SIM
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
name	String	Nome do plano de tarifas	SIM
domain	String	Dominio associado ao plano de tarifas	SIM
rateid	Integer	Identificador da tabela de tarifas associada ao plano (Vide Rates)	SIM
prepaid	boolean	Indica se o plano é PRE-PAGO. Em caso negativo, o plano terá o comportamento de POS-PAGO. Default false.	SIM
txConnection	Integer	Taxa de Conexão que será aplicada para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.	SIM
cadency	Integer	Cadência que será aplicada após a Taxa de Conexão para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.	SIM
freeMinutes	Integer	Campo meramente informativo para calculo de franquias. Utilizado por sistemas de CRM. Default 0.	NÃO
markup	double	Taxa de Markup que será aplicada na tabela de tarifas associada ao plano. Default 0.0.	NÃO
blockCallsWithoutRate	boolean	Flag que indica se o sistema irá bloquear a execução de chamadas para destinos sem uma tarifa de venda associada. Default false.	NÃO
limitToCreditExpires	Integer	Limite de validade (em dias) para os créditos adicionados a uma conta. Válido apenas para planos PRE-PAGO. Default 0.	NÃO
txDelay	Integer	Taxa de delay (em segundos) para inicio de calculo da duração/abatimento de créditos de uma chamada. Ex. Delay = 3, a chamada será contabilizada somente após o segundo 4. Default 0.	NÃO
txDiscard	Inteeger	Taxa de descarte (em segundos). O sistema irá descartar as chamadas com tempo igual ou inferior a taxa de descarte configurada. As chamadas acima da taxa de descarte, serão tarifadas com a duração total. Default 0.	NÃO
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
id	Integer	Identificador único do plano de tarifas	SIM
name	String	Nome do plano de tarifas	SIM
rateid	Integer	Identificador da tabela de tarifas associada ao plano (Vide Rates)	SIM
prepareid	boolean	Indica se o plano é PRE-PAGO. Em caso negativo, o plano terá o comportamento de POS-PAGO. Default false.	SIM
txConnection	Integer	Taxa de Conexão que será aplicada para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.	SIM
cadency	Integer	Cadência que será aplicada após a Taxa de Conexão para a tarifação das chamadas. Valores entre 1-60 (em segundos). Default 60.	SIM
freeMinutes	Integer	Campo meramente informativo para calculo de franquias. Utilizado por sistemas de CRM. Default 0.	NÃO
markup	double	Taxa de Markup que será aplicada na tabela de tarifas associada ao plano. Default 0.0.	NÃO
blockCallsWithoutRate	boolean	Flag que indica se o sistema irá bloquear a execução de chamadas para destinos sem uma tarifa de venda associada. Default false.	NÃO
limitToCreditExpires	Integer	Limite de validade (em dias) para os créditos adicionados a uma conta. Válido apenas para planos PRE-PAGO. Default 0.	NÃO
txDelay	Integer	Taxa de delay (em segundos) para inicio de calculo da duração/abatimento de créditos de uma chamada. Ex. Delay = 3, a chamada será contabilizada somente após o segundo 4. Default 0.	NÃO
txDiscard	Integer	Taxa de descarte (em segundos). O sistema irá descartar as chamadas com tempo igual ou inferior a taxa de descarte configurada. As chamadas acima da taxa de descarte, serão tarifadas com a duração total. Default 0.	NÃO
principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
Domain	String	Domínio das tarifas de venda	SIM
Description	String	Filtro pela descrição da tarifa.	NÃO
RateId	Integer	Filtro pelo RateId da tarifa.	NÃO
Prefix	String	Filtro pelo prefixo da tarifa.	NÃO
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
Rate	List<RateDTO>	Lista com as Tarifas de Venda que serão incluídas (descrito mais abaixo).	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Page Comparison

Versions Compared

Old Version 9

New Version 10

Key

Banco de dados

Acesso a Views do Sistema

Acessando View vi_cdrs

Acessando Tabela Acc

APIs de integração

Transações Aninhadas

DomainWS - Listar Domínios

ProfileWS - Listar Profiles por Domínio

SubscriberWS - Ativar Assinantes

SubscriberWS - Desativar Assinantes

SubscriberWS – Ativar Notificação de Saldo Baixo

SubscriberWS - Desativar Notificação de Saldo Baixo

SubscriberWS - Ativar Chamadas Privadas

SubscriberWS - Desativar Chamadas Privadas

SubscriberWS – Ativar Execução de Chamadas

SubscriberWS – Desativar Execução de Chamadas

SubscriberWS – Ativar Recebimento de Chamadas

SubscriberWS – Desativar Recebimento de Chamadas

SubscriberWS – Bloquear Chamadas a Cobrar

SubscriberWS – Desbloquear Chamadas a Cobrar

SubscriberWS – Bloquear Chamadas Anônimas

SubscriberWS – Desbloquear Chamadas Anônimas

SubscriberWS – Bloquear Ocultação de Topologia

SubscriberWS – Ativar Geração de Estatísticas Diárias

SubscriberWS – Bloquear Geração de Estatísticas Diárias

SubscriberWS - Adicionar Créditos para Assinantes

SubscriberWS - Incluir Novos Assinantes

SubscriberWS - Alteração de Assinantes

SubscriberWS - Consultar Saldo do Assinante

SubscriberWS - Trocar senha de Assinantes

SubscriberWS – Trocar Profile do Assinante

SubscriberWS – Remover Assinante

SubscriberWS – Consultar Senha do Assinante

SubscriberWS – Recuperar Dados do Assinante

SubscriberWS – Alteração de Dados de Bilhetagem do Assinante

SubscriberWS – Alteração de Dados Classe V do Assinante

SubscriberWS – Alteração de Dados de Serviços do Assinante

SubscriberWS - Ativar Voicemail do Assinante

SubscriberWS - Desativar Voicemail do Assinante

SubscriberWS - Adicionar Alias de Assinante

SubscriberWS - Remover Alias de Assinante

SubscriberWS – Recuperar Quota Diária

SubscriberWS – Alterar a Quota Diária

DidWS - Inclusão de DID's

DidWS - Exclusão de DID's

DidWS - Listar DID's Associados a um Assinante

DidWS - Listar DID's Disponíveis

ResellerWS - Inclusão de Revendas

ResellerWS - Exclusão de Revendas

ResellerWS - Listar Revendas

ResellerWS - Adicionar Créditos para Revendas

ResellerWS - Saldo da revenda

WhitelistWS - Inclusão de Whitelist

WhitelistWS - Exclusão de WhiteList

WhitelistWS - Listar WhiteList

RatePlanWS - Listar Plano de Tarifas por Domínio

RatePlanWS - Incluir Plano de Tarifas por Domínio

RatePlanWS - Alterar Plano de Tarifas por Domínio

RatePlanWS - Remover Plano de Tarifas por Domínio

RateWS - Listar Tarifas de Venda

RateWS – Inclusão de Tarifas de Venda

RateWS - Exclusão de Tarifas de Venda

RateWS - Exclusão de Tarifas de Venda por RateId

DialplanWS - Listar Plano de Discagem

AccountGroupWS - Adicionar Account Group

AccountGroupWS - Recuperar um Account Group

AccountGroupWS - Remover Account Group

CustomerWS - Troca de Senha do Assinante

CustomerWS - Crédito Atual do Assinante

UserLocationWS - Listar Registros de um Assinante

UserLocationWS - Adicionar Registros Permanentes para um Assinante

UserLocationWS - Remover Registros Permanentes para um Assinante

AddressWS – Lista as Autenticações por IP de um Assinante

AddressWS – Inserir Autenticações por IP de um Assinante

AddressWS – Alterar Autenticações por IP de um Assinante

Parâmetro	Tipo	Descrição	Requerido
RateID	Integer	Identificador da Tarifa de Venda que será excluída.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
Domain	String	Domínio das Tarifas de Venda que serão excluídas	SIM
RateID	Integer	RateId das Tarifas de Venda que serão excluídas.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
accountManager	String	Account code da conta agrupadora.	SIM
managerProfile	String	Profile da conta agrupadora.	SIM
accounts	List<String>	Lista de Account codes que serão beneficiadas pelo agrupamento.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
username	String	Login do assinante	SIM
domain	String	Domínio do assinante da plataforma	SIM
password	String	Senha de autenticação do assinante	SIM

Parâmetro	Tipo	Descrição	Requerido
accountcode	String	Accountcode do assinante. Ex.: username@domain	SIM
contextinfo	String	[não obrigatório, gerado pelo sistema]	NÃO
domain	String	Domínio do assinante	SIM
group	String	[não obrigatório, gerado pelo sistema]	NÃO
Id	Integer	[não obrigatório, gerado pelo sistema no evento de inclusão]	NÃO
IpAdress	String	endereço ip para autorização	SIM
mask	Integer	máscara que será aplicada ao endereço ip, normalmente o valor 32.	SIM
method	String	pode ser informado os seguintes valores [iponly, techprefix, ip+cpt, ip+cli]	SIM
pattern	String	[não obrigatório, gerado pelo sistema no evento de inclusão]	NÃO
port	Integer	porta padrão para autenticação, para liberar todas, informe o valor 0 (zero).	SIM
protocol	String	pode ser informado os seguintes valores [tcp, udp, tls, any] normalmente usa-se any.	SIM
username	String	Username do assinante	SIM
techprefix	String	é obrigatório quando usa-se os methods techprefix e ip+cpt.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
domain	String	Domínio do registro de autenticação por ip.	SIM
Id	Integer	Identificador único do registro	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
id	Integer	[Não deve ser informado no momento da inclusão, será gerado automaticamente pelo sistema]	NÃO
domain	String	Domínio do assinante	SIM
description	String	Nome do grupo.	SIM
groupList	String	Lista de usernames separados por ; (ponto e vírgula) que fazem parte do grupo Ex.: joao;maria;jose	SIM
method	String	Tipo de distribuição das chamadas no grupo. paralell: Entrega as chamadas para todos os membros do grupo de forma paralela. serial: Entrega as chamadas para os membros do grupo de forma seqüencial, com base no timeout definido.	SIM
uri	String	[Não deve ser informado no momento da incluão, será gerado automaticamente pelo sistema]	NÃO
timeout	Integer	Tempo para execução da entrega da chamada, com base na método de entrega definido.	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
id	Integer	Deverá ser informado no momento da exclusão.	SIM
domain	String	Domínio do assinante	SIM
Principal	UserPrincipal	Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo).	SIM

Parâmetro	Tipo	Descrição	Requerido
login	String	Login do administrador	SIM
password	String	Senha do administrador	SIM

Parâmetro	Tipo	Descrição	Requerido
domain	String	Domínio do assinante na plataforma	SIM
name	String	Descrição da Tarifa de Venda	SIM
prefix	String	Prefixo da Tarifa de Venda	SIM
rateId	Integer	Identificador do grupo de tarifas.	SIM
rateValue	Double	Valor de venda da Tarifa.	SIM
serviceType	String	Tipo de Ligação da Tarifa.	NÃO