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.
Além desse acesso, 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.
Abaixo segue as especificações dos serviços disponíveis na API de integração.
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 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: 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 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: 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 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: 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 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: 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 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: 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 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: 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 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: 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 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: 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. | 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: