Versions Compared

Old Version 4

changes.mady.by.user layza.cristini

Saved on

compared with

New Version Current

changes.mady.by.user Adriano Teixeira

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sumário:

Table of Contents

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. 

...

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.

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:

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/DomainWSProfileWS?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/DomainWSProfileWS?wsdl

Operation Name: listDomainslistProfilesByDomain

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

domain

String

Domínio valido e que o principal tenha acesso.

sim

Dados de Retorno:

Tipo

Descrição

List<Domain>

List<Profile>

Lista dos

Domínios em que o administrador possui acesso para gerenciamento

Profiles associados ao domínio.

...

SubscriberWS - Ativar Assinantes

Esta função tem por objetivo listar os profiles associados a um domínio ativar um assinante dentro da plataforma.

URL Descritiva do Serviço:

http://<IP_SERVER>:<PORT>/SipPulse/ProfileWSSubscriberWS?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/ProfileWSSubscriberWS?wsdl

Operation Name: listProfilesByDomainactivateSubscriber

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

...

List<Profile>

...

Lista dos Profiles associados ao domínio.

...

SIM

SubscriberWS - Desativar Assinantes

Esta função tem por objetivo ativar desativar um assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateSubscriberblockSubscriber

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 desativar ativar o aviso de saldo baixo para um assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockSubscriberactivateLowCreditNotification

Parâmetros:

Parâmetro

Tipo

Descrição

Requerido

username

Username

String

Username do assinante.

SIM

domain

Domain

String

Domínio do assinante.

SIM

lowCreditLimit

Double

Limite para saldo ser considerado baixo.

SIM

principal

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 ativar desativar o aviso de saldo baixo para um assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateLowCreditNotificationParâmetros:blockLowCreditNotification

Parâmetro

Tipo

Descrição

Requerido

Username

username

String

Username do assinante.

SIM

Domain

domain

String

Domínio do assinante.

SIM

lowCreditLimit

Double

Limite para saldo ser considerado baixo.

SIM

Principal

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 desativar o aviso de saldo baixo para ativar o recurso de chamadas privadas de um assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockLowCreditNotificationactivatePrivacyCalls

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 ativar desativar o recurso de chamadas privadas de um assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activatePrivacyCallsblockPrivacyCalls

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 desativar o recurso ativar a execução de chamadas privadas deum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockPrivacyCallsactivateOutgoingCalls

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 ativar desativar a execução de chamadas deum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateOutgoingCallsblockOutgoingCalls

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 desativar a execução ativar o recebimento de chamadas deum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockOutgoingCallsactivateIncommingCalls

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 ativar desativar o recebimento de chamadas deum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateIncommingCallsblockIncommingCalls

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 desativar bloquear o recebimento de chamadas dea cobrar paraum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockIncommingCallsblockCollectCalls

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 bloquear desbloquear o recebimento de chamadas a cobrar paraum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockCollectCallsactivateCollectCalls

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 desbloquear bloquear o recebimento de chamadas a cobrar anônimas paraum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateCollectCallsblockAnonymousCalls

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 bloquear desbloquear o recebimento de chamadas anônimas paraum assinante dentro da plataforma.

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockAnonymousCallsactivateAnonymousCalls

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 desbloquear ativar o recebimento recurso de ocultação de topologia para chamadas anônimas paraum assinante dentro da plataformarealizadas 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://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateAnonymousCallsactivateTopologyHiding

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 ativar inativar 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://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateTopologyHidingblockTopologyHiding

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 inativar ativar o recurso de ocultação de topologia para chamadas realizadas por um assinantegeraçã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://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockTopologyHidingactivateDailyStatistics

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 ativar bloquear 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://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: activateDailyStatisticsblockDailyStatistics

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 bloquear o recurso de geração de estatísticas diárias de adicionar créditos na conta de um assinante. 

URL Descritiva do Serviço:

...

http://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: blockDailyStatisticsaddCredit

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

NÃO

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 adicionar créditos na conta de incluir um assinante dentro da plataforma.

URL Descritiva do Serviço:

...

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

...

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

://sippulse.com:8080/SipPulse/SubscriberWS?wsdl

Operation Name: insertSubscriber

Parâmetros: 

Parâmetro

Tipo

Descrição

Requerido

>= 4.7.4

username

String

Username do assinante.

SIM

SIM

domain

String

Domínio do assinante.

SIM

SIM

password

String

Senha do assinante.

SIM

SIM

passwordPortal

String

Senha Portal do Assinante.

SIM

SIM

emailAddress

String

Email do assinantes, utilizado para envio de notificações.

SIM

SIM

profile

String

Perfil do Assinante no sistema. (recuperar via serviço ProfileWS)

SIM

SIM

ratePlanId

Integer

Identificador do plano de tarifas do assinante

SIM

SIM

countryCode

String

Código do país do Assinante. Ex.: 55 (Brasil)

SIM

SIM

areaCode

String

Código de Área do Assinante. Ex.:11 (São Paulo)

SIM

SIM

callLimit

Integer

Número de Chamadas simultânea que o Assinante poderá executar. Ex. 1

SIM

SIM

voicemail

boolean

Flag para ativação do serviço de correio de voz. Ex.: 1 (Ativo) ou 0.

SIM

SIM

resellerId

Integer

Identificador da revenda associada ao assinante, caso exista.

SIM

SIM

lowCreditLimit

Double

Valor mínimo de crédito para ativação do mecanismo de aviso. Default 0.0.

SIM

NÃO

resellerBillingType

Integer

Tipo de Bilhetagem que a revenda aplicará na conta do assinante. 0: Marckup \ 1: Plano de Tarifas. Valor default 0.0.

SIM

NÃO

resellerMarckup

Double

Tipo de Bilhetagem que a revenda aplicará na conta do assinante.
0: Marckup / 1: Plano de Tarifas. Valor Default 0.

SIM

NÃO

contractNumber

String

Número de contrato do assinante.

NÃO

NÃO

firstName

String

Nome do Assinante.

NÃO

NÃO

lastName

String

Sobrenome do Assinante.

NÃO

NÃO

document

String

Número do Documento do Assinante.

NÃO

NÃO

address

String

Endereço do Assinante.

NÃO

NÃO

number

String

Número do Endereço do Assinante.

NÃO

NÃO

complement

String

Complemento do Endereço do Assinante.

NÃO

NÃO

quarter

String

Bairro do Endereço do Assinante.

NÃO

NÃO

city

String

Cidade

do Endereço do Assinante

do Endereço do Assinante.

NÃO

NÃO

state

String

Estado do Endereço do Assinante.

NÃO

NÃO

zip

String

CEP do Endereço do Assinante.

NÃO

NÃO

phone

String

Telefone de Contato do Assinante.

NÃO

NÃO

mobile

String

Telefone Celular de Contato do Assinante.

NÃO

NÃO

voicemailPassword

String

Senha para o serviço de correio de voz

NÃO

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

state

NÃO

rpid

String

Estado do Endereço do

Número de Identificação para chamadas originadas pelo Assinante.

NÃO

NÃO

zip

callFwd

String

CEP do Endereço do Assinante.

Endereço sip para o serviço siga-me. Ex.: sip:1000@sippulse.com

NÃO

phoneValor mínimo de crédito para ativação do mecanismo de aviso. Default 0.0.

NÃO

fwdBusy

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

Endereço sip para o serviço siga-me quando ocupado. Ex.: sip:1000@sippulse.com

NÃO

NÃO

noAnswer

String

Endereço sip para o serviço siga-me quando não atende. Ex.: sip:1000@sippulse.com

NÃO

NÃO

activeIncomingCalls

boolean

Define se o assinante estará habilitado para receber chamadas. 

Default true.

NÃO

NÃO

activeOutgoingCalls

boolean

Define se o assinante estará habilitado para executar chamadas. 

Default true.

NÃO

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

NÃO

blockAnonymousCalls

boolean

Define se o bloqueio de recebimento de chamadas ACOBRAR está ativo. Default false.

NÃO

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

NÃO

callsOnlyByIp

boolean

Se chamadas serão liberadas apenas para autenticação por IP, que será setado por padrão com (true). Na criação não tem como criar como false.

NÃO

NÃO

cityCode

String

Código Nacional da Localidade.

NÃO

NÃO

localArea

String

Área Local do Assinante.

NÃO

NÃO

addServiceHeader

boolean

Adiciona um header no pacote para sinalizar que é uma chamada a cobrar.

NÃO

NÃO

copyPassertedRpid

boolean

Copia o conteudo do P-Asserted-Identity para o From ao passar pelo SIPProxy.

NÃO

NÃO

softphoneAllowed

boolean

Habilita o uso do Softphone pelo assinante.

NÃO

NÃO

rings

Integer

Tempo máximo para o atendimento da chamada (segundos).

NÃO

NÃO

blockEntry0303

boolean

Bloqueia chamadas entrantes vindas de callcenter.

NÃO

NÃO

validateSource0303

boolean

Valida o formarto 0303 caso o número é valido e ele venha de callcenter para WholeSale.

NÃO

NÃO

vldOriginCli

boolean

Verica se o CallerId do from Header é valido. No caso se é um numero fixo e com RN1 válido.

NÃO

NÃO

rn1User

Integer

RN1 do Assinante para validação da operadora de origem deste número, ex: 55001.

NÃO

NÃO

Dados de Retorno:

Tipo

Descrição

Integer

Identificador do novo assinante gerado pelo sistema.

SubscriberWS - Alteração de Assinantes

...

Operation Name: updateSubscriber

Parâmetros:

Parâmetro

Tipo

Descrição

Requerido

id

Integer

Id do assinante a ser alterado

SIM

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

emailAdress

String

Email do Assinante.

SIM

areaCode

String

Código de Área do Assinante. Ex.:11 (São Paulo)

SIM

Email do Assinante.

SIM

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

rings

Integer

Tempo máximo para o atendimento da chamada (segundos).

SIM* até a 4.7.3

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

localArea

String

Área Local do Assinante.

NÂO

callLimit

Integer

Número de Chamadas simultânea que o Assinante poderá executar. Ex. 1

SIM

NÃO

voicemail

boolean

Flag para ativação do serviço de correio de voz. Ex.: 1 (Ativo) ou 0.

SIM

NÃO

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

activeIncomingCalls

boolean

Define se o assinante estará habilitado para receber chamadas. 

NÃO

activeOutgoingCalls

boolean

Define se o assinante estará habilitado para executar chamadas. 

NÃO

callsOnlyByIp

boolean

Se chamadas serão liberadas apenas para autenticação por IP.

NÃO

SubscriberWS - Consultar Saldo do Assinante

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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 

...

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 

...

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 

...

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 

...

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 

...

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 

...

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

...

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

didToRuri

boolean

Insere o aliasUsername no Request Uri no invite para o assinante.

SIM

monthlySubscription

Double

Valor da mensalidade do Did, caso exista.

NÃO

SIM

reverseBilling

Boolean

Flag que ativa a bilhetagem reversa. Utilizado apenas para números 0800.

NÃO

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.

DidWS - Exclusão de DID's

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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 

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...

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 

...

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

...

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

...

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

...

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

...

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

...

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:

...

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

...

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

...

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

...

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

...

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.

...

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