Sumário:
| Table of Contents |
|---|
...
Banco de dados
Além de permitir a extração de relatórios pela interface do sistema, a plataforma SIPPulse também disponibiliza um acesso a banco de dados para recuperação de informações já consolidadas em grandes volumes. Disponibilizamos view's dos CDR's das chamadas e outras informações.
Acesso a Views do Sistema
O SIPPulse disponibiliza acesso de leitura aos dados gerados pelo sistema através de acesso a tabelas e views.
Sugerimos que os acessos a volumes grandes de dados sejam feitos fora dos horários de pico para evitar perda de desempenho no ambiente.
Acessando View vi_cdrs
O SIPPulse disponibiliza acesso aos bilhetes (já tarifados) gerados pelo sistema através de uma view de banco de dados chamada vi_cdrs.
...
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 |
src_uri | varchar(255) | SIP URI do originador da chamada. | |
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. | |
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. | |
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
...
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 |
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. | |
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. | |
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. | |
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.
...
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.
...
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.
...
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.
...
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.
...
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.
...
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.
...
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.
...
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.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Ativar Execução de Chamadas
Esta função tem por objetivo ativar a execução de chamadas deum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Desativar Execução de Chamadas
Esta função tem por objetivo desativar a execução de chamadas deum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Ativar Recebimento de Chamadas
Esta função tem por objetivo ativar o recebimento de chamadas deum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Desativar Recebimento de Chamadas
Esta função tem por objetivo desativar o recebimento de chamadas deum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Bloquear Chamadas a Cobrar
Esta função tem por objetivo bloquear o recebimento de chamadas a cobrar paraum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Desbloquear Chamadas a Cobrar
Esta função tem por objetivo desbloquear o recebimento de chamadas a cobrar paraum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Bloquear Chamadas Anônimas
Esta função tem por objetivo bloquear o recebimento de chamadas anônimas paraum assinante dentro da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Desbloquear Chamadas Anônimas
Esta função tem por objetivo desbloquear o recebimento de chamadas anônimas paraum assinante dentro da plataforma.
...
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.
...
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.
...
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.
...
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.
...
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
...
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.
...
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.
...
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 |
copyPassertedRpid | boolean | Flag que ativa ou desativa o copiar P-Asserted para from header | SIM |
softphoneAllowed | boolean | Flag que ativa ou desativa o provisionamento via QR code do softphone pelo assinante | SIM |
callsOnlyByIp | boolean | Flag que ativa ou desativa a execução de chamadas somente por IP | SIM |
rings | Integer | Tempo máximo para o atendimento da chamada (segundos). | SIM |
addServiceHeader | boolean | Adiciona um header no pacote para sinalizar que é uma chamada a cobrar | NÃO |
blockAnonymousCalls | boolean | Bloqueia o recebimento de chamadas anônimas | NÃO |
blockCollectCalls | boolean | Bloqueia o recebimento de chamadas a cobrar | NÃO |
blockEntry0303 | boolean | Bloqueia chamadas entrantes vindas de callcenter. | NÃO |
lowCreditLimit | Double | Limite para Saldo Baixo | NÃO |
lowCreditNotification | boolean | Ativa o envio de email de notificação de saldo baixo | NÃO |
resellerBillingType | Integer | NÃO | |
resellerMarkup | Double | NÃO | |
validateSource0303 | boolean | Valida o formarto 0303 caso o número é valido e ele venha de callcenter para WholeSale. | NÃO |
SubscriberWS - Consultar Saldo do Assinante
Adiciona um header no pacote para sinalizar que é uma chamada a cobrar |
...
Tipo | Descrição |
|---|---|
Double | Saldo do assinante. |
SubscriberWS - Trocar senha de Assinantes
Esta função tem por objetivo trocar a senha de um assinante.
...
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.
...
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.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Consultar Senha do Assinante
Esta função tem por objetivo consultar senha de um assinante da plataforma.
...
Tipo | Descrição |
|---|---|
String | Senha atual do assinante. |
SubscriberWS – Recuperar Dados do Assinante
Esta função tem por objetivo recuperar os dados de um assinante da plataforma.
...
Tipo | Descrição |
|---|---|
SubscriberDTO | Dados atuais do assinante. |
SubscriberWS – Alteração de Dados de Bilhetagem do Assinante
Esta função tem por objetivo alterar os dados de bilhetagem de um assinante da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
subscriber | SubscriberBillingInfoDTO | Objeto que contém os dados de bilhetagem (descrito mais abaixo) | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Alteração de Dados Classe V do Assinante
Esta função tem por objetivo alterar os dados de Classe V de um assinante da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
subscriber | SubscriberClassVDTO | Objeto que contém os dados de bilhetagem (descrito mais abaixo). | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Alteração de Dados de Serviços do Assinante
Esta função tem por objetivo alterar os dados de Serviços de um assinante da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
subscriber | SubscriberServicesDTO | Objeto que contém os dados de Serviços (descrito mais abaixo). | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS - Ativar Voicemail do Assinante
Esta função tem por objetivo ativar o voicemail de um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
voicemailPassword | Long | Senha numérica do voicemail do assinante | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS - Desativar Voicemail do Assinante
Esta função tem por objetivo desativar o voicemail de um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Username do assinante. | SIM |
domain | String | Domínio do assinante. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS - Adicionar Alias de Assinante
Esta função tem por objetivo adicionar um alias a um assinante.
...
Tipo | Descrição |
|---|---|
SubscriberDTO | Dados atuais do assinante. |
SubscriberWS - Remover Alias de Assinante
Esta função tem por objetivo remover um alias a um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
dbAliases | Integer | Identificador de registro a ser excluído. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
SubscriberWS – Recuperar Quota Diária
Esta função tem por objetivo recuperar as informações de quota diária de um assinante.
...
Tipo | Descrição |
|---|---|
SubscriberDTO | Dados atuais do assinante. |
SubscriberWS – Alterar a Quota Diária
Esta função tem por objetivo alterar as informações de quota diária de um assinante.
...
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 |
SubscriberWS – Bloqueia chamadas entrantes vindas de callcenter com 0303. *A partir da versão 5.2
Esta função tem por objetivo de bloquear as chamadas advindas de callcenter com o prefixo 0303.
...
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 – Ativa as chamadas entrantes vindas de callcenter com 0303 *A partir da versão 5.2
Esta função tem por objetivo de ativar as chamadas advindas de callcenter com o prefixo 0303.
...
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 – Ativa a Validação de Origem 0303. *A partir da versão 5.2
Esta função ativa a validação do formato 0303 caso o número é valido e ele venha de callcenter para WholeSale.
...
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 – Desativa a Validação de Origem 0303. *A partir da versão 5.2
Esta função tem por objetivo de desativar as chamadas advindas de callcenter com o prefixo 0303.
...
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 |
DidWS - Inclusão de DID's
Esta função tem como objetivo incluir um novo DID associado a um assinante.
...
Tipo | Descrição |
|---|---|
SubscriberDTO | Dados atuais do assinante. |
DidWS - Exclusão de DID's
Esta função tem como objetivo excluir um DID associado a um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
didId | Integer | Identificador do DID que será excluído. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
DidWS - Listar DID's Associados a um Assinante
Esta função tem como objetivo listar os DID's associados a um assinante.
...
Tipo | Descrição |
|---|---|
List<Did> | Lista de DID's associados ao assinante. |
DidWS - Listar DID's Disponíveis
Esta função tem como objetivo listar os DID's disponíveis no sistema.
...
Tipo | Descrição |
|---|---|
List<Did> | Lista de DID's disponíveis no sistema. |
ResellerWS - Inclusão de Revendas
Esta função tem como objetivo incluir uma nova Revenda no sistema.
...
Tipo | Descrição |
|---|---|
Integer | Identificador do novo registro gerado pelo sistema. |
ResellerWS - Exclusão de Revendas
Esta função tem como objetivo excluir uma Revenda.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
resellerId | Integer | Identificador da Revenda que será excluída. | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
ResellerWS - Listar Revendas
Esta função tem como objetivo listar as Revendas de um domínio.
...
Tipo | Descrição |
|---|---|
List<Reseller> | Lista de Revendas associados ao domínio. |
ResellerWS - Adicionar Créditos para Revendas
Esta função tem por objetivo adicionar créditos na conta de uma revenda
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
resellerName | String | Nome da Revenda. | SIM |
Domain | String | Domínio da Revenda. | SIM |
Value | Double | Valor do crédito que será adicionado na conta da revenda. | SIM |
Obs | String | Descrição da transação de inclusão de crédito | SIM |
Principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
ResellerWS - Saldo da revenda
Esta função tem por objetivo mostrar saldo de uma revenda
...
Tipo | Descrição |
|---|---|
Double | O valor do crédito da revenda. |
WhitelistWS - Inclusão de Whitelist
Esta função tem como objetivo incluir um novo número na whitelist do assinante.
...
Tipo | Descrição |
|---|---|
Integer | Identificador do novo registro gerado pelo sistema. |
WhitelistWS - Exclusão de WhiteList
Esta função tem como objetivo excluir um número da lista whitelist do assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
whiteListId | Integer | Identificador do WhiteList que será excluído | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
WhitelistWS - Listar WhiteList
Esta função tem como objetivo listar os WhiteList's associados a um assinante.
...
Tipo | Descrição |
|---|---|
List<UserWhiteList> | Lista de WhiteList's associados ao assinante. |
RatePlanWS - Listar Plano de Tarifas por Domínio
Esta função tem como objetivo listar o Plano de Tarifas associados a um domínio.
...
Tipo | Descrição |
|---|---|
List<RatePlan> | Lista de RatePlan associados ao domínio |
RatePlanWS - Incluir Plano de Tarifas por Domínio
Esta função tem como objetivo incluir um Plano de Tarifas associados a um domínio.
...
Tipo | Descrição |
|---|---|
RatePlan | Retorna o plano de tarifas com o identificador único gerado pelo sistema. |
RatePlanWS - Alterar Plano de Tarifas por Domínio
Esta função tem como objetivo alterar um Plano de Tarifas associados a um domínio.
...
Tipo | Descrição |
|---|---|
RatePlan | Retorna o plano de tarifas atualizado. |
RatePlanWS - Remover Plano de Tarifas por Domínio
Esta função tem como objetivo remover um Plano de Tarifas associados a um domínio.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
id | Integer | Identificador único do plano de tarifas | SIM |
principal | UpserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
RateWS - Listar Tarifas de Venda
Esta função tem como objetivo listar as Tarifas de Venda de um domínio.
...
Tipo | Descrição |
|---|---|
List<Rate> | Lista de Tarifas de Venda encontradas no domínio. |
RateWS – Inclusão de Tarifas de Venda
Esta função tem como objetivo incluir novas Tarifas de Venda (em lote) em um domínio.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
Rate | List<RateDTO> | Lista com as Tarifas de Venda que serão incluídas (descrito mais abaixo). | SIM |
Principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
RateWS - Exclusão de Tarifas de Venda
Esta função tem como objetivo excluir uma Tarifa de Venda.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
RateID | Integer | Identificador da Tarifa de Venda que será excluída. | SIM |
Principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
RateWS - Exclusão de Tarifas de Venda por RateId
Esta função tem como objetivo excluir todas as Tarifas de Venda associadas a um RateId.
...
Tipo | Descrição |
|---|---|
Integer | Quantidade de Tarifas de Venda que foram excluídas. |
DialplanWS - Listar Plano de Discagem
Esta função tem como objetivo listar o Plano de Discagem associado a um domínio.
...
Tipo | Descrição |
|---|---|
List<Dialplan> | Lista de Dialplan associados ao domínio. |
AccountGroupWS - Adicionar Account Group
Esta função tem como objetivo adicionar um Account Group.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
accountManager | String | Account code da conta agrupadora. | SIM |
managerProfile | String | Profile da conta agrupadora. | SIM |
accountsaccount | List<String><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 |
Para agrupar mais de uma conta é necessário adicionar mais campos “accounts” no mesmo request:
| Code Block |
|---|
<ser:addAccountGroup>
<accountManager>conta_agrupadora@email.com</accountManager>
<managerProfile>profile_conta_agrupadora</managerProfile>
<account>testeAgrupadora@dominio.com</account>
<account>testeAgrupadora2@dominio.com</account> |
AccountGroupWS - Recuperar um Account Group
Esta função tem como objetivo recuperar um Account Group.
...
Tipo | Descrição |
|---|---|
AccountGroup | Contém os dados da conta agrupadora e das contas agrupadas. |
AccountGroupWS - Remover Account Group
Esta função tem como objetivo remover um Account Group.
...
Tipo | Descrição |
|---|---|
SubscriberDTO | Contém os dados da conta do assinante autenticado. |
CustomerWS - Troca de Senha do Assinante
Esta função tem como objetivo trocar a senha de um assinante da plataforma.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Login do assinante | SIM |
domain | String | Domínio do assinante da plataforma | SIM |
actualPassword | String | Senha atual de autenticação do assinante | SIM |
newPassword | String | Nova senha do assinante | SIM |
confirmNewPassword | String | Confirmação da nova senha do assinante | SIM |
CustomerWS - Crédito Atual do Assinante
Esta função tem como objetivo recuperar o crédito atual de um assinante da plataforma.
...
Tipo | Descrição |
|---|---|
Double | valor atual do crédito do assinante |
UserLocationWS - Listar Registros de um Assinante
Esta função tem como objetivo listar os registros de um assinante.
...
Tipo | Descrição |
|---|---|
List<Location> | Lista contendo os registros atuais do assinante. |
UserLocationWS - Adicionar Registros Permanentes para um Assinante
Esta função tem como objetivo adicionar um registro permanente para um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Login do assinante | SIM |
domain | String | Domínio do assinante | SIM |
contact | String | Endereço do registro do assinante. Ex.: sip:[username]@[ipaddress]:port | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
UserLocationWS - Remover Registros Permanentes para um Assinante
Esta função tem como objetivo remover um registro permanente para um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Login do assinante | SIM |
domain | String | Domínio do assinante | SIM |
contact | String | Endereço do registro do assinante. Ex.: sip:[username]@[ipaddress]:port | SIM |
principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
AddressWS – Lista as Autenticações por IP de um Assinante
Esta função tem como objetivo listar as autenticações por IP de um assinante.
...
Tipo | Descrição |
|---|---|
List<Adress> | Lista contendo os dados de autenticação por IP de um assinante. |
AddressWS – Inserir Autenticações por IP de um Assinante
Esta função tem como objetivo inserir autenticações por IP de um assinante.
...
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.
...
Tipo | Descrição |
|---|---|
Adress | Contem o registro de autenticação por IP gerado no sistema. |
AddressWS – Excluir Autenticações por IP de um Assinante
Esta função tem como objetivo excluir autenticações por IP de um assinante.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
domain | String | Domínio do registro de autenticação por ip. | SIM |
Id | Integer | Identificador único do registro | SIM |
Principal | UserPrincipal | Objeto que contém as credenciais de acesso de um administrador do sistema (descrito mais abaixo). | SIM |
HuntGroupWS – Listar HuntGroups
Esta função tem como objetivo listar os huntgroups associados a um domínio.
...
Tipo | Descrição |
|---|---|
List<HuntGroup> | Lista contendo os huntgroups associados ao domínio informado. |
HuntGroupWS – Inserir HuntGroups
Esta função tem como objetivo inserir um novo huntgroup no sistema.
...
Tipo | Descrição |
|---|---|
HuntGroup | Retorna os dados do Huntgroup atualizado pelo sistema. |
HuntGroupWS – Alterar HuntGroups
Esta função tem como objetivo alterar um huntgroup no sistema.
...
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.
...
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.
...
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.
...
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.
...
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.
...
Parâmetro | Tipo | Descrição | Requerido |
|---|---|---|---|
username | String | Login do assinante | SIM |
domain | String | Domínio do assinante na plataforma | SIM |
String | SIM | ||
countryCode | String | Código do País | SIM |
areaCode | String | Código da Área | SIM |
cityCode | String | Código da Localidade | SIM |
localArea | String | Sigla da Localidade | SIM |
rpid | String | Id da Chamada | SIM |
callLimit | Integer | Chamadas Simultâneas | SIM |
cps | Int | Chamadas por Segundo | SIM |
keepAlive | Int | Keep Alive | SIM |
RateDTO
Este objeto representa uma Tarifa de Venda do sistema.
...
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 |
ReloadModulesWS - reloadSubscriber
Esse método realiza o reload dos dados do assinante, a chamada do botão limpar cache da tela assinantes.
...
Obs: Método disponível a partir da versão 5.1
ReloadModulesWS - reloadProfile
Esse método realiza o reload dos dados do profile, a chamada do botão limpar cache da tela profile.
...
Obs: Método disponível a partir da versão 5.1
ReloadModulesWS - reloadDid
Esse método realiza o reload dos dados do DID, a chamada do botão limpar cache da tela did.
...
Obs: Método disponível a partir da versão 5.1
ReloadModulesWS - reloadAddress
Esse método realiza o reload dos dados da autenticação por IP, a chamada do botão carregar alterações da tela de Autenticação por IP.
...
Obs: Método disponível a partir da versão 5.1
ReloadModulesWS - reloadHuntGroup
Esse método realiza o reload dos dados do Hunt Group (Grupo de busca), a chamada do botão limpar cache do Hunt Group.
...