Integração - PCRT 4.7

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:

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:

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:

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:

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:

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:

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:

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/WhiteListWS?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:

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:

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:

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:

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:

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:

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:

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:

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/DialplanWS?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:

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:

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:

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:

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:

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:

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:

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:

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: