Anda di halaman 1dari 173

SIP Julho

2016
Pulse
Verso do Sistema: 4.0 (FINAL)

Este documento voltado aos administradores da plataforma


SIPPulse. Todos os direitos reservados. 2009/2015 SIPPulse
Guia do
Tecnologia Ltda.
Administrador
Sumrio
1. Introduo 8
2. Arquitetura do sistema 10
3. Tecnologia 11
4. Solues 11
5. Caractersticas 12
6. Aplicabilidade 14
7. Instalao 15
8. Administrao 16
Portal dos Administradores 16
Domnios 17
Profiles 19
Controle do Codecs e Streams no SDP 21
Expresses Regulares 21
Plano de Discagem 23
Gerenciamento de Plano de Discagem 24
Administradores do Sistema 25
Grupo de Administradores 26
Componentes do Sistema 27
Tela de Configurao do Sistema 28
Assinantes 29
Validao da autenticao de chamadas 29
Tela de entrada de dados de assinantes 30
Recursos de PABX 32
Recursos STFC 32
Interceptao Legal 32
Recursos PRO 33
Gerenciamento de Assinantes 34
Incluso de Crdito para Assinantes 35
Autenticao por IP 35
Troncos SIP 37

9. Roteamento 38
Provedores 38
Gateways 38
Funcionalidades Avanadas no Gateway 39
Lista de Gateways 40
Regras de Roteamento 42

2
Gerenciamento de Regras de Roteamento 42
Hunt Group 44
Time Routing 44
Configuraes de DIDs 45
Importao de Nmeros DIDS 47
Prefixo para Domnio 47
DID por rea local 48
Roteamento baseado na qualidade da terminao 49
Determinando o custo mais adequado para a operao 49
Novos parmetros para cada rota 49
Modelo de insero de dados 50
Importando regras para quality routing 51
Configurao dos gateways 51
Lista Negra Global Dinmica 52
Entrada esttica de dados 53
Bloqueio 53

10. PABX-IP 54
Configurao de Anncios 54
Salas de Conferncia 55
Unidades de Resposta Audvel (URA) 55
Tela de Configurao da URA 56
Filas de Atendimento (DAC) 56
Tela de Configurao da Fila de Atendimento 57
Criando membros da fila 58
Monitoria de Fila 58

11. Gravao de Chamadas 59


12. Relatrios 60
Detalhamento de Chamadas Saintes 60
Detalhamento de Chamadas Entrantes 61
Detalhamento de Chamadas Gateway 62
Consumo por Fornecedores 62
Chamadas Perdidas 63
Chamadas Timeout 63
Motivo de Desligamento 64
Rentabilidade por Revendas 65
Rentabilidade por Provedores 65
Rentabilidade por Account Code 66
Rentabilidade por Rota 66

13. Monitorao 68
Dashboard 68

3
Logs do Sistema 70
Nvel padro de log 70
Iniciar e Parar Monitoramento 71
Excluir Selecionados e Excluir Todos 71
Exportar para CSV 71
Busca de Logs 71
Sip Trace 71
ASR dos Gateways 72
ASR dos Clientes 74
CFR por Gateway 74
Informaes de Transbordos 75
Zabbix 76
Monit 76
Voip Monitor (Opcional) 77
Inventrio 77

14. Agendamento de Tarefas 78


Gerao de LCR 78
Re-tarifao 79
Exportao de Relatrios 80

15. Revendas 81
Definio de Revendedores 81
Incluso de Crdito para Revendas 82
Log Incluso de Crdito Revenda 82

16. Bilhetagem 83
Servio Pr-pago 83
Plano de Tarifas 84
Estratgia de Fechamento da chamada 85
Controle de Arredondamento de Chamada 87
Truncar 87
Arredondar para cima 88
Arredondar na mdia 88
Tipos de Ligaes 89
Tarifas de Venda 89
Gerenciamento Tarifas de Venda 90
Tarifas de Compra 92
Gerenciamento Tarifas de Compra 92
Verificar Inconsistncias 93
Agrupamento de Contas 95

17. Segurana 96
Acesso Criptografado 96

4
Proteo Contra Inundao de Requisies (SIP Flood) 96
Proteo contra SIP Packet Replay Attack 97
Proteo Contra Ataques por Pacotes Mal Formados 97
Descarte Seletivo de Assinaturas Conhecidas 98
Proteco contra DNS e Registration Poisoning 98
Proteo Contra Mltiplas Falhas de Autenticao 98
Sistema Anti-fraude para Chamadas Internacionais (Opcional) 98
Configurao da Poltica de Segurana 100
Suporte a Criptografia e Chaves Digitais 101
Display de senhas e armazenamento 101
Suporte para LDAP 102
Protees Providas pelo Sistema Operacional 102
Syn Flood 102
Gratuitious ARP 102
Ping Flood 102
Oversized Packets, Unfragmented, SYN-FIN, SYN-RST, X-mas, nmap FIN, NULLFlags 102
Banimento de Port Scans 103
Finger of Death 103
Gerencia de Redes 103
SNMP 104
Configurao de Alarmes 105

18. Auditoria Sistmica 106


19. Backup da Plataforma 106
20. Integrao 107
DomainWS - Listar Domnios 107
ProfileWS - Listar Profiles por Domnio 108
SubscriberWS - Ativar Assinantes 108
SubscriberWS - Desativar Assinantes 109
SubscriberWS Ativar Notificao de Saldo Baixo 109
SubscriberWS - Desativar Notificao de Saldo Baixo 110
SubscriberWS - Ativar Chamadas Privadas 111
SubscriberWS - Desativar Chamadas Privadas 111
SubscriberWS Ativar Execuo de Chamadas 112
SubscriberWS Desativar Execuo de Chamadas 113
SubscriberWS Ativar Recebimento de Chamadas 113
SubscriberWS Desativar Recebimento de Chamadas 114
SubscriberWS Bloquear Chamadas a Cobrar 114
SubscriberWS Desbloquear Chamadas a Cobrar 115
SubscriberWS Bloquear Chamadas Annimas 116
SubscriberWS Desbloquear Chamadas Annimas 116

5
SubscriberWS Ativar Ocultao de Topologia 117
SubscriberWS Bloquear Ocultao de Topologia 118
SubscriberWS Ativar Gerao de Estatsticas Dirias 118
SubscriberWS Bloquear Gerao de Estatsticas Dirias 119
SubscriberWS - Adicionar Crditos para Assinantes 120
SubscriberWS - Incluir Novos Assinantes 120
SubscriberWS - Alterao de Assinantes 123
SubscriberWS - Consultar Saldo do Assinante 125
SubscriberWS - Trocar senha de Assinantes 125
SubscriberWS Trocar Profile do Assinante 126
SubscriberWS Remover Assinante 127
SubscriberWS Consultar Senha do Assinante 127
SubscriberWS Recuperar Dados do Assinante 128
SubscriberWS Alterao de Dados de Bilhetagem do Assinante 129
SubscriberWS Alterao de Dados Classe V do Assinante 129
SubscriberWS Alterao de Dados de Servios do Assinante 130
SubscriberWS - Ativar Voicemail do Assinante 130
SubscriberWS - Desativar Voicemail do Assinante 131
SubscriberWS - Adicionar Alias de Assinante 132
SubscriberWS - Remover Alias de Assinante 132
SubscriberWS Recuperar Quota Diria 133
SubscriberWS Alterar a Quota Diria 134
DidWS - Incluso de DID's 135
DidWS - Excluso de DID's 136
DidWS - Listar DID's Associados a um Assinante 136
DidWS - Listar DID's Disponveis 137
ResellerWS - Incluso de Revendas 138
ResellerWS - Excluso de Revendas 139
ResellerWS - Listar Revendas 139
ResellerWS - Adicionar Crditos para Revendas 140
ResellerWS - Saldo da revenda 141
WhitelistWS - Incluso de Whitelist 142
WhitelistWS - Excluso de WhiteList 142
WhitelistWS - Listar WhiteList 143
RatePlanWS - Listar Plano de Tarifas por Domnio 144
RatePlanWS - Incluir Plano de Tarifas por Domnio 144
RatePlanWS - Alterar Plano de Tarifas por Domnio 146
RatePlanWS - Remover Plano de Tarifas por Domnio 147
RateWS - Listar Tarifas de Venda 148
RateWS Incluso de Tarifas de Venda 148
RateWS - Excluso de Tarifas de Venda 149
RateWS - Excluso de Tarifas de Venda por RateId 150

6
DialplanWS - Listar Plano de Discagem 151
AccountGroupWS - Adicionar Account Group 151
AccountGroupWS - Recuperar um Account Group 152
AccountGroupWS - Remover Account Group 153
CustomerWS - Autenticao de Assinantes 153
CustomerWS - Troca de Senha do Assinante 154
CustomerWS - Crdito Atual do Assinante 155
UserLocationWS - Listar Registros de um Assinante 156
UserLocationWS - Adicionar Registros Permanentes para um Assinante 156
UserLocationWS - Remover Registros Permanentes para um Assinante 157
AddressWS Lista as Autenticaes por IP de um Assinante 158
AddressWS Inserir Autenticaes por IP de um Assinante 158
AddressWS Alterar Autenticaes por IP de um Assinante 160
AddressWS Excluir Autenticaes por IP de um Assinante 161
HuntGroupWS Listar HuntGroups 162
HuntGroupWS Inserir HuntGroups 162
HuntGroupWS Alterar HuntGroups 163
HuntGroupWS Excluir HuntGroups 164
UserPrincipal 165
SubscriberBillingInfoDTO 165
SubscriberClassVDTO 166
SubscriberServicesDTO 167
RateDTO 168

21. Transaes Aninhadas 169


22. Acesso a Views do Sistema 169
Acessando View vi_cdrs 169
Acessando Tabela Acc 172

7
1. Introduo
O SIPPulse CALL SWITCH uma plataforma de software, 100% nacional, para provimento
de servios de voz sobre IP, projetada para operadoras e provedores de servios de voz.

Suas caractersticas, flexibilidade, escalabilidade e capacidade de integrao a tornam


tambm aptas a suportarem redes de voz e mdia privadas, seja para empresas ou organismos
governamentais com grande distribuio geogrfica e alto nmero de colaboradores. A plataforma
possui uma estrutura de sinalizao SIP avanada capaz de atender os assinantes com rapidez e
confiabilidade.

O SIPPulse baseia-se no protocolo SIP e opera atravs de um engine altamente sofisticada


que implementa as regras definidas pela ITU (International Telecommunication Union). A plataforma
suporta tambm as RFC's definidas pela IETF (Internet Engineering Task Force), descritas abaixo:

RFC 3261 Session Initiation Protocol (SIP);


RFC 5341 The Internet Assigned Number Authority (IANA) Uniform Resource Identifier (URI) Parameter Register
RFC 3265 Especific Event Notification;
RFC 4028 SIP Session Timer;
RFC 3262 Reliability for Provisional Responses in the SIP;
RFC 3550 RTP: A Transport Protocol for Real-Time Applications
RFC 3261 Session Initiation Protocol (SIP);
RFC 3711 The Secure Real-Time Transport Protocol (SRTP);
RFC 2327 SDP: Session Description Protocol;
RFC 4733 RTP Payload for DTMF Digits, Telephone Tones and Telephone Signals;
RFC 3264 An Offer/Answer Model with SDP;
RFC 2959 Real-Time Transport Protocol (RTP) Management Information Base;
RFC 3266 Support for IPv6;
RFC 3551 RTP Profile for Audio and Video Conferences with Minimal Control;
RFC 6157 IPv6 Transition in the SIP;
RFC 3389 RTP Payload for Comfort Noise (CN);
RFC 3515 SIP Refer Method;
RFC 3486 Compressing the SIP;
RFC 3891 SIP Replaces Header;
RFC 3856 A Presence Event Package for the SIP;
RFC 3892 SIP Referred-by;
RFC 2474 Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers;
RFC 5389 Session Traversal Utilities do NAT (STUN);
RFC 2475 An Architecture for Differentiated Services;
RFC 5766 Traversal Using Relays around NAT TURN;
RFC 2597 Assured Forwarding PHB Group;
RFC 6086 SIP INFO Method and Package Framework;
RFC 3246 An Expedited Forwarding PHB;
RFC 3311 SIP UPDATE Method;
RFC 2507 IP Header Compression;
RFC 5359 SIP Service Examples;
RFC 2508 Compressing IP/UDP/RTP Headers for Low-Speed Serial Links;
RFC 3325 Private Extensions to the SIP;
RFC 7235 Hypertext Transfer Protocol (HTTP/1.1): Authentication;
RFC 3323 A Privacy Mechanism for SIP;
RFC3702 Authentication, Authorization, and Accounting Requirements for the SIP.
RFC 3581 A Extension to the SIP for Symmetric Response Routing;

8
A plataforma pode ser utilizada para trabalhar em mltiplos domnios com modelos de
tarifao ps e pr-pago, de forma independente. A condio de multi-domnio permite a criao de
parties lgicas do sistema segregando assinantes de diferentes clientes corporativos, ou em uma
operao privada, de diferentes departamentos/organizaes.

A soluo est preparada para trabalhar de forma redundante e suporta at 50.000 registros
de assinantes por instncia (um assinante pode ter mais que um registro, estando homologada para
processar 300 requisies de chamadas por segundo e podendo suportar mais de 10.000 chamadas
em curso, por instncia ou n de Cluster (vide manual de alta disponibilidade).

O sistema suporta o cadastro de at 2M de rotas, atravs de gateways E1, FXO, GSM e SIP.

Na camada de apresentao ao gestor e usurios o SIPPulse implementa abordagem de


interface grfica amigvel, capaz de atender todos os requisitos de operao do dia-a-dia.

Alm de atender a padres mundiais para telefonia IP, a Plataforma SIPPulse Softswitch
aderente a requisitos definidos pela ANATEL e ABRTelecom para operaes em redes de telefnica
publica (RTPC), alm de estar aderentes a requisitos constantes na arquitetura ePING e na portaria
Portaria Interministerial n 141, de 02 de maio de 2014.

Seu desempenho, interoperabilidade, flexibilidade funcional e operacional e facilidade de


uso, tornam esta plataforma a opo ideal para operadoras ou empresas que demandem segurana e
confiabilidade operacional, eficincia e qualidade em sua operao.

9
2. Arquitetura do sistema
A plataforma SIPPulse CALL SWITCH um softswitch que oferece servios de roteamento
de chamadas telefnicas utilizando protocolo SIP em Redes IP.
Desenvolvido para atender as demandas crescentes e elsticas do mercado de
telecomunicaes de mdia (voz e imagem), suporta operaes de redes pblicas (PSTN), operadoras
de atacado e redes privadas (PBX), tanto em sua capacidade operacional quanto nas funcionalidades
que oferece.1
Suas caractersticas de elasticidade permitem sua implantao de forma econmica e eficaz
em operadoras pblicas (STFC) locais com baixa demanda de trfego ou em grandes operadoras
regionais ou nacionais e mesmo operadoras de atacado. O ambiente pode ser expandido verticalmente
(de acordo com o crescimento do volume de operaes) e horizontalmente, com adio de
funcionalidades complementares.
Aderente s RFCs do IETF, a integrao do SIPPulse CALL SWITCH bastante simples,
permitindo sua operao em ambientes heterogneos que sejam baseados nas mesmas
recomendaes.
A arquitetura do PULSE CALL SWITCH contempla 6 componentes: Portal & Banco de
Dados, SIP Proxy, Media Gateways, Media Relay Servers, Bilhetagem. O ambiente deve ser
contemplando por gateways compatveis com o ambiente2.

1
Algumas funcionalidades so opcionais e obtidas atravs de mdulos complementares.
2
Os principais media gateways oferecidos no mercado so compatveis com o SPCALL SWITCH

10
3. Tecnologia
O SIPPulse CALL SWITCH construdo sobre protocolo SIP na camada de sinalizao e
roteamento, Java EE na camada de aplicaes e banco de dados para registro das informaes. Para
sistema operacional adotamos o LINUX CENT OS.
O uso destas tecnologias aferem ao SIPPulse CALL SWITCH maior eficcia e menor custo
de investimento e operacional, tanto por seu custo de aquisio quanto por seu baixo consumo de
recursos de processamento.
A camada de apresentao, desenvolvida com conceitos webservices (padro SOAP),
permite a fcil integrao do PULSE CALL SWITCH atravs de mais de 100 servios nativos3.
O Protocolo SIP foi escolhido pois tornou-se o padro de fato escolhido pelas maiores
operadoras da atualidade. Todas as tecnologias colaboram para a elasticidade do ambiente.

4. Solues
O SIPPulse Call Switch pode ser configurado para operar com as seguintes funes:
CRT: Voltado para operaes de atacado com alto volume de sinalizao e gerao de
CDRs, tambm utilizado para redes privadas em funes de Classe IV conectando
localidades remotas e centralizando a gesto do uso de recursos de rede;
SCM: Operadoras SCM que queiram oferecer servios de Telefonia IP para seus clientes.
Inclui Revenda e recursos de Classe V4. No possui numerao prpria oferecida na rede
pblica.
STFC: Voltado para operaes de redes pblicas (STFC) incorpora as funes PULSE SCM
e agrega os recursos necessrios operao em rede pblica (BDO, Transito e DETRAF).
CORP: Desenhado para redes privadas pode incorporar servios de mdia avanada (requer
mdulo de mdia avanada) permitindo sua operao como:
o Classe IV;
o Incluindo recursos de PABX IP (PULSE Mdia Avanada);
o Sobrevivncia.
HPBX: Destinado a operadoras STFC ou SCM que tenham como oferta servios de PABX
IP em nuvem.
Para complementar a oferta das solues acima, os seguintes mdulos e produtos podem ser
oferecidos em conjunto aumentando a oferta de servios e tornando seu negcio mais eficaz:
Revenda
Permite a associao de empresas que revendam servios da operadora.
Topology Hiding
Aumenta nvel de segurana rede fazendo ocultao da topologia de sua rede impedindo o
back trace de chamadas.
Multi-domnio

3
A documentao dos WS disponveis entregue ao cliente na implantao do sistema.
4
Correio de Voz, Siga-me, Hunt Group, Time Routing

11
Permite a operao de ambientes distintos em uma rede de operadoras. Tipicamente
utilizada com oferta de servios HPBX.
Gravador
SBC
Desenhado para desempenhar 5 funes bsicas: Ocultao de Topologia, Entroncamento
SIP, Firewall, Transcodificao e converso de sinalizao. Pode ser utilizado na entrada
ou sada de redes.
TFPS
Sistema desenhado para combater fraudes de fomento de trfego internacional, pode ser
implantado conjuntamente com solues PULSE e de forma independente.
ATI
Sistema de consulta base de portabilidade, permitindo a identificao automtica da
operadora do nmero chamado.

5. Caractersticas
FUNES SIP Stateful SIP Proxy Server RFC3261 Multi-domnio
Dialog Stateful SIP Proxy Multi-leg paralelo e serial
SIP registrar Mltiplos registros em uma nica conta
UDP/TCP/TLS Limite de chamadas por registro
Limite de chamadas por gateway
TARIFAO Agrupamento de contas Mltiplos planos de tarifas
Tarifao pr-paga e ps-paga em tempo Suporte para markup nas tarifas
real, disponvel a administradores e clientes Suporte para durao mnima e min.
Keep-Alive para corrigir chamadas presas gratuitos
Bilhetagem reversa para nmeros 0800 e Taxas de compra e venda
DID Exportao para PDF e EXCEL
Relatrio de rentabilidade por usurio Tarifao de mltiplas pernas de chamada
Relatrio de rentabilidade por provedor Cadncia e delay de chamadas flexvel
Relatrio detalhado de chamadas Bloqueio de chamadas sem tarifas
Aviso de saldo baixo Permite mltiplos registos e mltiplas
chamadas
ROTEAMENTO Mltiplas tabelas de roteamento Roteamento DNS para domnios externos
Mltiplos planos de discagem Roteamento de DIDs
At 2.000.000 rotas Trunking c/ Autenticao p/IP
Transbordo automtico Trunking com Aut. p/IP e Tech Prefix
Relatrio de ASR e CCR para gateways Suporte para RPID e PAI(RFC3325)
Substituio automtica de cdigo de rea Suporte para substituico da From URI
e pas para usurios Suporte para substituio da To URI
Traduo numrica (Dialplan) Manipulao do CallerID (exceto STFC)
Gesto de transbordo de gateway Multicaller ID
Limite de chamadas por provedor
SOBREVIVNCIA Registro de assinantes locais Chamadas saintes: Roteamento
Chamadas entrantes livre simplificado (rotas locais e LDN
predefinidas)

12
NAT Deteco automtica de NAT Ping no NAT para manter a porta aberta
Suporte para STUN e TURN Mltiplos media relay servers
Suporta p/ NAT Simtrico balanceados para melhor desempenho

SEGURANA Proteo contra INVITE REPLAY ATTACKS Suporte para TLS/SRTP


Operacional (Check FORM and AUTH) Mecnismo anti-flood
Proteo contra Fuzzing Attacks Banimento de IP com mltipas falhas
Senhas fortes mandatrias Deteco de ataque por assinatura
Ocultao de topologia Auditoria Sistmica
Segurana refinada para administradores
SEGURANA Autenticao por domnio, IP+techprefix, Cota de uso (minutos ou crditos)
Funcional IP+CLI
Controle de autenticaes em paralelo
MONITORAMENTO Tela de dashboard com informaes em Real Time Statistics
tempo real Relatrios de ASR, CCR e CFR dos
Sip Trace gateways
INTERFACE WEB Portal de Administrao Portal de Revendas
Portal do Usurio Portal de Trnsito (STFC apenas)
CONFIABILIDADE Hot Backup (Opcional) Load Balancing e Failover (Opcional)
MULTI-IDIOMA Suporte I18N
RECURSOS STFC Chamada Cobrar Detraf
BDO Roteamento CSP
Nmeros especiais Central de Trnsito
REVENDAS Portal de Revendas Tarifao especfica para revendas
Dashboard de produo
MULTIDOMINIO Separao de ambientes por cliente Perfis por domnio
Plano de Rotas por domnio Plano de Tarifas por domnio
MIDIA FUNES Siga-me Correio de voz
BSICAS Siga-me incondicional Siga-me se no atender
Siga-me se ocupado
MDIA AVANADA VIDE DATASHET ADVANCED MEDIA

13
6. Aplicabilidade

Capacidade
A capacidade5 comprovada em operao continuada do SIPPulse CALLSWITCH , por instncia:

Usurios registrados: 50.000;


Usurios ativos: > 50.000;
Ativao de Chamadas (CPS): 300;
Chamadas em Paralelo: 6.000 por n de cluster;
Sesses em paralelo com tratamento RTP Proxy: 1.000/servidor;
Sesses em paralelo com uso de mdia avanada ou gravador:120/servidor;
Rotas registradas: at 2 Milhes;

5
Os fatores de capacidade aqui apresentados so nominais. O desempenho efetivo do ambiente depender
ainda de outros fatores de sua operao como sinalizao recebida (fornecedores e clientes), desempenho
de rotas e gateways de sada e outros fatores, que devero ser avaliados e monitorados constantemente.

14
7. Instalao
A plataforma SIPPulse uma soluo baseada em software que pode ser hospedada em
qualquer hardware comum de mercado, inclusive em ambientes virtuais.

Abaixo segue uma tabela de sugesto de hardware para acomodar cada mdulo do sistema.

SIPPulse Call SWICTH

Chamadas Application Server / SIP Proxy RTP Proxy Central de Transito


em Curso Database Server (At 50.000 registros) (At 1.000 por Instncia) (Somente STFC)

1 Proc 6N
90 16 GB RAM
600 GB HD SAS 15K - raid 10

1 Proc 6N 1 Proc 4N
300 32 GB RAM 8 GB RAM
1TB HD SAS 15K - raid 10 350 GB HD

1 Proc 6N 1 Proc 4N 1 Proc 4N


600 32 GB RAM 8 GB RAM 8 GB RAM
1TB HD SAS 15K - raid 10 350 GB HD 350 GB HD

1 Proc 6N 1 Proc 4N 1 Proc 4N


900 32 GB RAM 8 GB RAM 8 GB RAM
1TB HD SAS 15K - raid 10 350 GB HD 350 GB HD

1 Proc 8N 1 Proc 4N 1 Proc 4N 1 Proc 4N


1.200 64 GB RAM 8 GB RAM 4 GB RAM 8 GB RAM
1TB HD SAS 15K - raid 10 350 GB HD 350 GB HD 350 GB HD

1 Proc 8N 1 Proc 4N 1 Proc 4N 1 Proc 4N


2.100 128 GB RAM 8 GB RAM 8 GB RAM 8 GB RAM
1TB HD SAS 15K - raid 10 350 GB HD 350 GB HD 350 GB HD

2 Proc 8N 1 Proc 8N 1 Proc 4N 1 Proc 8N


3.000 128 GB RAM 16GB RAM 8 GB RAM 16GB RAM
1TB HD SAS 15K - raid 10 350 GB HD 350 GB HD 350 GB HD

2 Proc 8N 2 Proc 8N 1 Proc 4N 2 Proc 8N


4.500 128 GB RAM 16 GB RAM 8 GB RAM 16 GB RAM
2TB HD SAS 15K - raid 10 350 GB HD 350 GB HD 350 GB HD

4 Proc 8N 2 Proc 8N 1 Proc 4N 2 Proc 8N


6.000 356 GB RAM 16 GB RAM 8 GB RAM 16 GB RAM
2TB HD SAS 15K - raid 10 350 GB HD 350 GB HD 350 GB HD

Acima
Consultar Estratgia de Cluster
6000

15
8. Administrao
Portal dos Administradores
A plataforma SIPPulse disponibiliza um Portal de Administrao baseado em web, capaz de
configurar, monitorar e gerenciar todos os componentes da soluo de forma centralizada. O portal
suporta mltiplos administradores com permisses de acesso bem especficos.

Baseado em tecnologias de ponta, oferece acesso multi-idioma e uma interface amigvel de


fcil compreenso, compatvel com os navegadores de mercado.

16
Domnios
A plataforma SIPPulse capaz de operar com mltiplos domnios. Os assinantes, rotas, tarifas
e perfis esto associados a um domnio. Ao criar um novo domnio um perfil padro ser criado
iniciando como identificador do domnio.

Por exemplo, o primeiro domnio receber uma identificao de 1 e criar automaticamente


um novo Profile (chamado DEFAULT), com um grupo de planos de discagem identificado como
1000 e um grupo de planos de rotas identificados como 1000.

Lista de Atributos dos Domnios:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Nome do Domnio SIM N/A
URL Logo Endereo da Logomarca personalizada NO N/A
Link Logo Endereo do Link ao clicar no logo NO N/A
SKIN Personalizao dos Portais de Assinantes e Revenda NO N/A
Ativar Lista Ativa o Acesso a Lista de Contatos no Portal dos Assinantes SIM False

Tela de Configurao de Domnios

17
Tela do Portal dos Assinantes Personalizado

Tela do Portal dos Revendedores Personalizado

18
Profiles
Um dos recursos mais importantes do sistema a criao de Profiles. Cada usurio est
associado a um nico Profile. Os Profiles esto ligados diretamente aos domnios e cada
administrador de domnio pode configurar inmeros Profiles.

Ao criar um domnio, um Profile padro (chamado DEFAULT) gerado pelo sistema. Os


Profiles definem o grupo de Planos de Discagem (que nmeros o usurio est autorizado a discar), o
grupo de Regras de Roteamento (como os prefixos sero roteados para os gateways), Plano de Tarifas
(para tarifao pr e ps paga), alm de um Grupo de Media Server e Grupo de Servidores RTP,
Invite Timer (tempo de espera para atendimento) e o Tipo de Mensagens (Sinalizao ou Audio).

Lista de Atributos dos Profiles:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado ao Profile SIM N/A
Plano de Tarifas Plano de Tarifao Default do Profile SIM N/A
Nome do Profile Nome do Profile SIM N/A
Grupo de Rotas Identificador do Grupo de Rotas associado ao Profile SIM N/A
Invite Timer Tempo Mximo para atendimento de chamadas (segundos) SIM 47
Dialplan Identificador do Plano de Discagem associado ao Profile SIM N/A
Grupo RTP Identificador do Grupo de Servidores RTP do Profile SIM 1
Grupo Media Identificador do Grupo de Servidores Media do Profile SIM N/A
Tipo Numerao Define o padro de manipulao dos nmeros discados pelos SIM E164
assinantes:
E164: Suporta Transformaes no Dialplan
DIALED: No aplica Transformaes no Dialplan
Estratgia GWs Define a estratgia que ser usada no transbordo das chamadas: SIM NORMAL
NORMAL: Em caso de falhas na tentativa do primeiro gateway, o
sistema transbordar para o prximo gateway associado a rota;
FALLBACK: Em caso de falha na tentativa do primeiro gateway, o
sistema transbordar a chamada para a prxima rota, menos especfica
(usar com cuidado);
WEIGHT: Distribui as chamadas entre os gateways associados a rota
usando a estratgia de peso;
NUMBER STRICT: Executa processa as rotas que tenham o prefixo
exatamente igual ao nmero chamado. No processa por proximidade.
Keep Alive Define qual a estratgia para verificar se as chamadas ativas esto NO N/A
presas:
MEDIA KEEP ALIVE: O sistema ir forar o udio RTP das chamadas
passagem pelo mdulo de RTP. Com isso o sistema controlar o trmino
das chamadas atravs do trfego de media;
CALLER KEEP ALIVE: O sistema far o controle das chamadas enviando
pacotes (OPTIONS) para o solicitante do dilogo;
SIP SESSION TIMERS: O sistema implementa o recurso de acordo com a
RFC 4028.
Kepp Alive Tempo mximo de durao das chamadas (segundos). SIM 7200
Timeout
Whitelist Ativa o recurso de whitelist para o profile. NO False
Domnios Externos Ativa o recurso de executar chamadas para domnios externos a NO False
plataforma.
Domnios Dialplan Ativa o recurso de troca de domnios no plano de discagem. NO False

19
RN1 (ATI) Flag que indica se o sistema ir gravar o RN1 das operadoras nos NO False
bilhetes. Esse recurso ser utilizado para as chamadas que fazem
consulta a base de portabilidade, utilizando o servio ATI.
Gravao Portal Flag que ativa a exibio de chamadas gravadas no portal dos NO False
dos Assinantes assinantes.
Durao Portal Se a durao no portal do usurio deve aparecer como real ou em bloco. NO Real
Usurio Por exemplo com cadncia 30/6 uma chamada de 31 segundos aparece
como 31 (real) ou 36 (bloco).

Tela de Configurao de Profiles

Obs1. Aps salvar as alteraes o boto Limpar Cache deve ser acionado para que a rea de cache
seja atualizada.

20
Controle do Codecs e Streams no SDP
possvel agora forar determinados codecs e remover streams indesejadas da negociao SIP. No
PROFILE do assinante, voc pode selecionar que codecs voc deseja manter dos que forem
oferecidos pelo cliente. A regra apagar todos exceto os selecionados. No exemplo abaixo, o
operador est bloqueando todos os codecs exceto G711a (PCMA), G711u (PCMU) e G.729. Os
nomes dos CODECs segue o padro da RFC 3551. Alguns CODECS como o H.264 no podem ser
bloqueados pois usam payload dinmico e seu nome no est diretamente associado a um
identificador conhecido.

Da mesma forma possvel remover fluxos (streams de udio indesejados). Supondo que voc
queira remover o suporte a T.38, voc pode selecionar por exemplo s voz como fluxo de mdia.
Todos os outros fluxos como vdeo e image (T.38) sero removidos.

Expresses Regulares
O recurso de Expresses regulares funciona como um assistente de regras pr-definidas que
sero utilizadas na criao de regras de Planos de discagem (visto a seguir).

O sistema disponibiliza um conjunto de expresses pr-definidas, que podem ser alteradas


e/ou complementadas.

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado a Expresso Regular. SIM N/A
Nome da Nome da Expresso Regular SIM N/A
Expresso
Expresso Expresso Regular que ser processada nos nmeros. SIM N/A
Expr. Regra de Transformao dos nmeros. NO N/A
Transformada
Expr. Substituda Regra de Separao e/ou substituio dos nmeros em grupos. NO N/A

Tela de Configurao de Expresses Regulares

21
22
Plano de Discagem
O plano de discagem tem trs funes. A primeira determinar que nmeros um determinado
usurio est autorizado a discar. A segunda transformar estes nmeros para um formato
padronizado, por exemplo E.164, se necessrio. Aps a transformao, o sistema ir executar o a ao
associada ao atributo da regra encontrada.

Lista de Atributos de Configurao de um Plano de Discagem:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado a Expresso Regular. SIM N/A
Nome da Regra Nome do Plano de Discagem SIM N/A
Expresso Default Expresso Regular que ser processada nos nmeros. SIM N/A
Atributo Ao que ser executada pela regra, vide abaixo: SIM userloc
usrloc: Envia o numero chamado para a Tabela de Localizao;
routing: Envia o numero chamado para a Tabela de Roteamento;
media: Envia o numero chamado para o Media Server;
interdomain: Envia o numero discado para o modulo de converso de
domnios;
ati: Envia o numero chamado para o servio de Consulta a Portabilidade
Local;
ati-hosted: Envia o numero chamado para o servio de Consulta a
Portabilidade (cloud);
forbidden: Retorna 403 Forbidden para o numero chamado.
Tamanho da Regra Regra de Separao e/ou substituio dos nmeros em grupos. NO N/A
DialplanId Identificador do plano de discagem (associao com Profile) SIM 1000
Prioridade Regra Defina a prioridade da regra em caso de regras dbias. SIM 0
Operador Define o tipo de avaliao da regra. String / Regular Expression. SIM Regexp
Tamanho da Regra Nmero de dgitos a serem considerados na regra (0 para todos) SIM 0

Tela de Configurao de Planos de Discagem

23
Gerenciamento de Plano de Discagem
Aqui possvel gerenciar os planos de discagem com maior facilidade utilizando recursos
para sua manipulao, como importao, exportao e cpia.

Em Importao de Planos de Discagem possvel importar um novo plano de discagem a


partir de uma planilha excel, conforme o modelo que encontra-se logo abaixo do menu de importao.
Para realizar a importao necessrio preencher o domnio e o dialplan Id, sendo o dialplan id um
novo nunca utilizado, depois clicar em Add e selecionar o arquivo preenchido conforme modelo e
clicar em Upload para finalizar a importao.

Em Exportao de Planos de Discagem possvel exportar um plano de discagem j criado


no sistema para um arquivo, seguindo o mesmo padro usado na importao. Assim sendo possvel
editar um plano de discagem inteiro mais facilmente e depois importar novamente para o sistema.
Para realizar a exportao necessrio selecionar o domnio e o dialplan id que ser exportado e clicar
no boto Exportar para CSV, depois aparecendo o arquivo na lista abaixo para download.

Em Copia de Planos de Discagem possvel copiar um plano de discagem inteiro para um


novo plano de discagem, mudando somente seu dialplan id e domnio. Para executar a copia
necessrio selecionar o domnio e dialplan id de origem, que ser o plano copiado, e preencher o
domnio e dialplan de destino, podendo o domnio ser ou no o de origem e o dialplan id de destino
obrigatoriamente tem que ser um no utilizado, depois das informaes preenchidas preciso clicar
em Copiar para executar a copia.

24
Administradores do Sistema
O SIPPulse conta com o cadastro de Administradores do Sistema. Para cadastrar um novo
Administrador, basta acessar Configuraes do Sistema > Administradores do Sistema.

De acordo com o perfil selecionado, o administrador poder ter restries de acesso a


funcionalidades. Por padro o sistema vem com trs tipos de perfis pr-configurados, MASTER,
DOMNIO e OPERAO, que podem ser editados, alm de poder ser criados perfis novos.

ATRIBUTO DESCRIO REQ. DEF.


Nome Nome do Administrador. SIM N/A
Sobrenome Sobrenome do Administrador. SIM N/A
E-mail E-mail do Administrador. SIM N/A
Login Login do Administrador. SIM N/A
Senha Senha de Acesso do Administrador. SIM N/A
Perfil Perfil de Acesso do Administrador. SIM N/A
Domnios Acesso Domnios de Acesso para a Gesto do Administrador. SIM N/A

Tela de Configurao de Administradores do Sistema

25
Grupo de Administradores
Aqui so criados e editados os perfis dos administradores do sistema. Por padro s o
Administrador MASTER vem com todas as permisses ativas, podendo criar e modificar os perfis.

Para criar um novo perfil preciso clicar no boto Novo, colocando um nome para o novo
perfil e selecionando as permisses que ele ter da lista. Ao editar as permisses de um perfil j criado,
preciso logar novamente para que elas tenham validade.

Tela de Configurao de Grupos de Administradores

26
Componentes do Sistema
Aqui so mostrados todos os componentes do sistema cadastrados, para reconhecimento de
todo o sistema. Aqui temos o seu nome, tipo, endereo ip e porta. Caso algum dos componentes tiver
seu IP trocado, voc pode editar esse componente aqui de forma fcil. Tambm pode se adicionar
novos componentes, caso necessite.

Tela de Configurao de Componentes do Sistema

Servidores RTP
Para a criao de um novo servidor RTP, deve ser informado o protocolo utilizado, seu
endereo IP, a porta utilizada e h qual grupo ele pertence. Sendo que o grupo s aceita valores entre
zero e nove. Ainda h o campo para indicar se ele est ativo ou no.

Tela de Configurao de Servidores RTP

Ao editar-se ou adicionar um novo servidor RTP ao sistema, depois de salvar as


informaes preciso clicar no boto Carregar Alteraes para que essas novas configuraes
tenham validade.

27
Configurao do Sistema
Essa pgina destina-se a configuraes gerais do sistema e seus servios.

Em Configuraes Gerais do Sistema onde so feitas as configuraes gerais que afetam


todo sistema. A configurao de Fuso Horrio define a formatao em que as horas sero exibidas
em todas as pginas do sistema, no alterando a informao original, somente a sua visualizao.

No painel Configuraes de Aviso de Saldo Baixo so feitas todas as configuraes


referente ao servio de mandar email avisando que seu saldo est abaixo do limite configurado para
o assinante. Nesse painel possvel visualizar se o servio est rodando ou no.

Ao lado da informao se o servio est rodando ou no, existe um boto que ativa e desativa
o servio do aviso de saldo baixo, ao ativar o servio clicando no boto o servio far sua primeira
execuo em 1 minuto. A execuo desse servio consiste em verificar quais assinantes esto com
esse recurso ativado e destes usurios quais deles esto com o saldo abaixo do limite configurado. Ao
encontrar esses usurios mandado um email avisando que seu saldo est baixo. O servio ser
executado de tempo em tempo aps a sua primeira execuo conforme configurado em Periodicidade
do Aviso, sendo possvel visualizar ao lado do boto que ativa/desativa o servio quando ser sua
prxima execuo. A opo Ativar Notificao Saldo Baixo ativa ou no a execuo do servio
automaticamente ao iniciar o sistema.

Tela de Configurao do Sistema

28
Assinantes
Os Assinantes representam os usurios autorizados a executarem/ receberem chamadas na
plataforma. Segue abaixo os dados de cadastro de um Assinante:

ATRIBUTO DESCRIO REQ. DEF.


Login Identificador do Assinante na plataforma. SIM N/A
E-mail E-mail do Administrador. SIM N/A
Dominio Domnio do Assinante. SIM N/A
Senha Senha do Assinante. SIM N/A
Profile Perfil de Operao do Assinante. SIM N/A
Plano de Tarifao Plano de Tarifao do Assinante. SIM N/A
Cdigo Pas Cdigo do Pas de Origem do Assinante. SIM 55
Cdigo de rea Cdigo de rea do Assinante. SIM 11
RPID Identificador de Chamadas para o Assinante. NO N/A
Keep Alive Estratgia de Keep Alive para o Assinante. NO N/A
Limite Chamadas Nmero Mximo de Chamadas Simultneas (0 para ilimitado). SIM 0
Chamadas p/ Seg. Nmero Mximo de Chamadas por Segundo (CAPS) (0 para ilimitado). SIM 0
Receb. Chamadas Ativa/Bloqueia o recebimento de Chamadas. SIM True
Exec. Chamadas Ativa/Bloqueia a Execuo de Chamadas. SIM True
Sip Trace Ativa/Bloqueia a Monitorao de SIP Trace. SIM False
Gravao Ativa/Bloqueia a Gravao de Chamadas. SIM False
Chamadas Ativa/Bloqueia o Recebimento de Chamadas Annimas. SIM False
Anonim.
Chamadas ACobrar Ativa/Bloqueia a autorizao para recebimento de Chamadas A Cobrar SIM False
(distro STFC).
Chamadas Ativa/Bloqueia o Envio de Chamadas do Assinante sem o Identificador. SIM False
Privadas
Monitorao Ativa/Bloqueia a Monitorao de Estatsticas do Assinante SIM False
Ocult. Topologia Ativa/Bloqueia o Recurso de Ocultao de Topologia. SIM False
Expresso ID Expresso regular para validar a identificao de chamada NO Vazio
Chamada

Validao da autenticao de chamadas


muito comum em operaes de tronco SIP, limitar o identificador de chamadas para evitar
caller_id spoofing. Com este novo recurso voc pode criar uma expresso regular limitando que
nmeros podem ser enviados como identificar da chamada (Caller ID). Se por exemplo voc
quiser limitar os identificadores de chamada de um cliente dos nmeros 1133334000
1133334999, voc pode criar uma expresso regular da seguinte forma ^1133334[0-9]{3}.

A identificao da chamada pode ser obtida atravs do campo From ou do campo P-Asserted-ID
sendo o segundo o prioritrio na identificao do assinante.

Caso a identificao da chamada SEJA preenchida no assinante a validao NO ser feita.

29
Pode-se ainda, configurar os recursos avanados associados a conta do Assinante:

Aliases Interno;
Blacklist (Entrada / Sada);
Whitelist;
Registro Permanente.

Tela de entrada de dados de assinantes

a aba Informaes de Bilhetagem so configuradas as informaes e servios de bilhetagem


do assinante. As informaes que podem ser configuradas so se o assinante pertence a uma revenda,

30
seus dados pessoais e os servios que envolvem bilhetagem. Os servios que podem ser configurados
so:

Notificao Saldo Baixo;


Cota de Consumo Dirio.

Para a Notificao Saldo Baixo existe o flag para ativar ou desativar o servio e um campo
para definir o limite para o saldo ser considerado baixo e mandar o aviso. Esse servio s pode ser
configurado somente para assinantes associados planos de tarifas pr-pagos.

Para a Cota de Consumo Dirio existe tambm um flag para ativar ou desativar o servio.
Quando ativado o servio so desbloqueados outros campos, um deles define se a cota do assinante
ser limitada a um consumo de minutos dirio ou valor. H um campo para configurar o limite dirio
da cota, quando esse limite for atingido no dia, o assinante ficar impossibilitado de realizar novas
chamadas at o dia seguinte quando a cota zerada.

Tela de Configurao de Informaes de Bilhetagem

Obs. Aps salvar as alteraes o boto Limpar Cache deve ser acionado para que a rea de cache
seja atualizada.

Tela de Configurao dos Recursos de Classe V

Na aba ClasseV, configura-se os recursos avanados de PBX, associados a conta do Assinante:

ATRIBUTO DESCRIO REQ. DEF.


Siga-me Configura o recurso de Siga-me. NO N/A
Siga-me Ocupado Configura o recurso de Siga-me se Ocupado. NO N/A
Siga-me No Atende Configura o recurso de Siga-me No Atende. NO N/A

31
Correio de Voz Ativa/ Inativa o recurso de Correio de Voz. NO False
Senha Correio de Senha do Correio de Voz. NO False
Voz
Invite Timer Tempo para aguardar antes de chamar o siga-me ou correio de voz NO 0

Recursos de PABX
Uma nova aba chamada de recursos de PABX est disponvel para os clientes que tem a licena de
HPBX.

ATRIBUTO DESCRIO REQ. DEF.


Chefe/ Secretria Ativa o Recurso de Chefe Secretria. NO N/A
Call Group Configura O Grupo de Captura que o Assinante Pertence. NO N/A
Pickup Group Configura o Grupo que o Assinante poder Capturar as Chamadas. NO N/A
Pin Code Cdigo PIN da Conta do Assinante. NO N/A
Ativar Mobilidade Ativar o servio de mobilidade de extenso acionado pelo *94 NO NO
PIN Code Mobilidade Senha para ativar o servio de mobilidade NO N/A
MAC Address MAC Address do Telefone Associado a este usurio NO N/A
Provisionamento
Template Mscara com as configuraes padres para o tipo de telefone NO N/A
Provisionamento associado ao cliente
SIP Server de Endereo do servidor IP do provisionamento NO N/A
Provisionamento

Recursos STFC
Alguns campos adicionais devem ser preenchidos no caso de assinantes com licena STFC.

O cdigo nacional da localidade deste nmero e sua sigla alm de um campo informativo
definindo se o nmero portado.

Interceptao Legal
Se for preenchido o campo de interceptao legal, a chamada ser desviada em conferncia para o
nmero informado neste campo. A chamada derivada entrar na conferncia em mudo evitado
que o cliente perceba que est sendo interceptado.

32
Recursos PRO
Nesta verso criamos uma ABA PRO para clientes que contrataram os recursos avanados do
sistema. Os dois recursos avanados do sistema so a lista negra dinmica e o roteamento com
qualidade. Estes recursos permitem uma melhor utilizao dos gateways e consequente melhoria
na eficincia

Na tela acima voc pode:

Ativar Lista Negra Dinmica (bldynactive). Se o usurio ir utilizar e popular e lista negra. No h
opo de usar sem popular.

Tempo de Expirao (bltime). o tempo que a entrada permanecer na lista negra). Aps expirado
o tempo o registro removido do banco de dados.

Cdigos de Bloqueio SIP (bldynsip). Quando um cliente receber um cdigo de resposta SIP dentro
desta expresso regular, ele incluir o registro do nmero na lista negra. A lista completa de
cdigos SIP est espalhada em diversas RFCs, uma boa referncia a Wikipedia
https://en.wikipedia.org/wiki/List_of_SIP_response_codes

Exemplo: 404|403|402

Cdigos de Bloqueio Q.850 (bldynq850). Este cdigos permitem que voc use a informao
contida no campo Reason das requisies SIP. So cdigos padro ISDN. Uma lista completa dos
cdigos Q.850 voc pode encontrar em https://www.itu.int/rec/T-REC-Q.850/en.

Exemplo: 1|22|28

Como a lista negra funciona. Os nmeros presentes na lista negra so bloqueados


automaticamente. A lista global, no existe uma lista por usurio. Quando as chamadas so
enviadas, dependendo do cdigo de retorno, a lista criada automaticamente. A lista negra pode
ser editada pelo administrador do sistema e tambm possvel importar via CSV registros na lista.

Abaixo um screenshot do preenchimento destes dados no menu

33
No exemplo acima, o sistema ir colocar na lista negra quaisquer nmeros retornando com 404 ou
402 ou cdigos Q.850 1 (Unallocated Number) e 2 (No route to specified transito network). Estes
so s exemplos, verifique os cdigos mais apropriados sua operao.

Gerenciamento de Assinantes
Aqui possvel gerenciar os assinantes criados no sistema com maior facilidade utilizando
recursos para sua manipulao, como importao, exportao e cpia.

Em Importao de Assinantes possvel importar para o sistema vrios assinantes de uma


nica vez atravs de uma planilha excel, conforme o modelo que encontra-se na pgina. Como no
assinante existem muitas informaes, a importao no contempla todas elas, somente as principais,
sendo muito delas ainda opcionais.

Para realizar a importao necessrio preencher o domnio de que os assinantes faro parte,
depois clicar em Add para selecionar o arquivo preenchido conforme modelo e clicar em Upload para
finalizar a importao. Lembrando que os assinantes importados no devem existir no sistema.

Em Exportao de Assinantes possvel exportar todos os assinantes de um domnio para


um arquivo, seguindo o mesmo padro usado na importao. Sendo assim possvel editar os
assinantes mais facilmente e depois importar novamente para o sistema. Para realizar a exportao
necessrio selecionar o domnio dos assinantes que sero exportados e clicar no boto Exportar para
CSV, depois aparecendo o arquivo na lista abaixo para download.

34
Em Copia de Assinantes possvel copiar um assinante para criar um novo a partir deste,
mudando somente suas principais informaes. Para executar a copia necessrio selecionar o
domnio e o assinante de origem, que ser copiado, e preencher as informaes que sero diferentes
como login, senha e e-mail, depois das informaes preenchidas preciso clicar em Copiar para
executar a copia.

O novo assinante criado com a copia ser criado no mesmo domnio do assinante de origem,
pois muitas das configuraes que sero copiadas de um assinante para outro so atreladas ao
domnio, no sendo possvel copiar um assinante para um domnio diferente.

Incluso de Crdito para Assinantes


Aqui o Administrador pode adicionar crditos para um Assinante. Para adicionar crdito
necessrio preencher os campos:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado ao Assinante. SIM N/A
Assinante Identificao do Assinante que receber o crdito. SIM N/A
Valor Valor que ser creditado na conta do Assinante SIM N/A
Observaes Informaes complementares do crdito. NO N/A

O sistema far a incluso do crdito e gravar um log contendo os dados do administrador que
executou a incluso.

Autenticao por IP
Atravs deste recurso o administrador pode autorizar chamadas vindas de outras plataformas
para serem processadas pelo SIPPulse, vinculando-as a uma conta de assinante.

Abaixo segue o passo a passo para a configurao:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado a conta de autenticao. SIM N/A
Assinante Identificao do Assinante para autenticao. SIM N/A
IP Origem Endereo IP de Origem. SIM N/A
IP Final Endereo IP Final, em caso de configuraes em range de IPs. NO N/A
Mscara Mscara que ser aplicada para validar o(s) endereo(s) de SIM 32
autenticao.
Grupo Identificao do Grupo de Autenticao SIM 1000
Protocolo Protocolo de Comunicao: SIM ANY

35
ANY: Todos
TCP: Somente em TCP
UDP: Somente em UDP
TLS: Somente em TLS
SCTP: Somente em SCTP
Porta Porta de Autenticao (0 para habilitar todas) SIM 0

Tela de Configurao de Autenticao por IP

36
Troncos SIP
A plataforma SIPPulse disponibiliza um recurso de criao de Troncos SIP em lotes,
realizando o Provisionamento Automtico, Associando Nmeros DID e de todas as contas.

Para realizar a gerao de Troncos SIP, bastar preencher os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Accontcode Conta Piloto SIM N/A
Faixa Inicial Faixa inicial dos troncos. SIM N/A
Faixa Final Faixa final dos troncos. SIM N/A
Password Estratgia de gerao de senha: SIM Piloto
Master Piloto: Senha do piloto para os troncos;
Novo Aleatrio: O sistema ir gerar novas senhas aleatrias.
Id da Chamada Estratgia do Identificador das Chamadas: SIM Piloto
Master Piloto: Identificador da conta piloto;
Novo do Assinante: Novo nmero gerado para o tronco;
Vazio: Identificador vazio.
Registro Permanente Ativa a gerao de registros permanentes para o os troncos. NO N/A
Endereo IP: Endereo IP do equipamento de registro;
Porta: Porta de sinalizao.
DIDs Gerao de DIDs associados para os troncos. NO N/A
Autenticao por IP Gerao de Autenticaes por IP para os troncos. NO N/A

Tela de Configurao de Troncos SIP

37
9. Roteamento
Provedores
Atravs de um provedor, podemos criar gateways e definir tarifas de custo de uma
determinada operadora. Com isso o sistema passar a calcular o custo de todas as chamadas
direcionadas para essa operadora.

Para realizar os cadastros de provedores, bastar preencher os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Nome do Provedor Nome do Provedor. SIM N/A
Taxa de Conexo Define a Taxa de Conexo de Compra do Fornecedor. SIM 60
Cadncia Define a Cadncia de Compra do Fornecedor. SIM 60
Delay Inicial Configura um delay (segundos) para iniciar a contabilizao da SIM 0
durao das chamadas.
Taxa de Descarte Configura uma Taxa de Descarte (segundos) para tarifao de custo SIM 0
das chamadas.

Tela de Configurao de Provedores

Gateways
Aqui so cadastrados os Gateways, que sero suas portas de sada para a rede pblica (PSTN)
atravs de uma operadora.

Para cadastrar um novo gateway precisamos preencher os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Tipo de Gateway Define o tipo do Gateway: SIM N/A
GATEWAY: Terminaes IP convencionais;
MEDIA_SERVER: Media Servers;
SBC: Session Border Controller;
INTERCONN: Interconexes de Transito STFC.
Provedor Provedor Associado ao Gateway. SIM N/A
Nome do Gateway Descrio do Gateway SIM N/A
Endereo IP Endereo IP do Gateway SIM N/A
Prefixo Valor que ser prefixado as chamadas encaminhadas ao gateway. NO N/A
Ex.: 4455 + NUMERO

38
Strip Quantidade de caracteres que ser removido do nmero antes de NO 0
encaminhar a chamada para o gateway. Em casos de combinaes
com o campo prefixo, o sistema ir remover a quantidade de
caracteres especificada e depois adicionar o prefixo ao nmero.
RateID Identificador da tabela de tarifas de custo, associada ao gateway. NO N/A
Monitorao Ativa/Bloqueia a monitorao de estatsticas no gateway. SIM false

Tela de Cadastro de Gateways

Funcionalidades Avanadas no Gateway


Os parmetros dos gateways a partir desta verso so informados diretamente na interface
grfica. O formato anterior ser migrado durante a instalao. Para usar QROUTING obrigatrio
informar os campos com o novo formato. Abaixo seguem todos os parmetros que podem ser
usados nos gateways.

Suporte a CLI (Calling Line Identification): Se o gateway suporta ou no o uso de


identificadores da chamada (Ex. Chipeiras no suportam CLI, em outras palavras no
suportam a insero do identificador de chamadas definido pelo assinante).
Formato da CLI: Permite a configurao da forma de passagem do identificador de
chamadas para o gateway. Os valores possveis so rfc3325, replacefrom, rpid e by-pass. O
valor rfc3325usa um cabealho do tipo P-Asserted-ID para passar o identificador, o rpid
usa o antigo padro Cisco passando o cabealho Remote-Party-ID e o replacefrom Altera
o campo From: do cabealho SIP. O valor bypass no altera o identificador e usa o que
o cliente enviar como cabealho em P-Asserted-ID ou Remote-Party-ID. (pai,rpid,from)

39
Tipo de CLI: Dar preferncia a identificao descrita no usurio ou gateway. Os valores
possveis so user, gateway e did. O parmetro user mostra o callerid definido no
assinante se houver gateway mostra o callerid do gateway ao invs do assinante e did
mostra o callerid associado a rea local do nmero de A informado na tabela DID. (usr,
gw,did).

Caller ID (CLI): Identificador de chamadas do gateway, caso o usurio no o possua ou a


preferncia esteja como gateway.
Display (CLD - Calling Line Display). Alterar o display no campo From:. Normalmente este
campo possui o nome do cliente ou do usurio do ramal.
Taxa mnima de MOS ( Mean Opinion Score). Informado sobre o gateway. Na dvida use
50 o MOS mximo.
Mximo de Chamadas (MaxCalls). Nmero mximo de chamadas simultneas permitidas
neste gateway.
Dialplan ID: Identificador do plano de discagem para tratamento de chamadas entrantes.
opcional e usado nas rotas de interconexo para tratar alguns tipos de chamadas.
NAT: Forar o uso de NAT para chamadas enviadas para este gateway
Copiar Request-URI para o cabealho TO: Isto usado para suportar gateways que no
aceitam o destino final na Request URI e necessitam que o destino final esteja no campo
TO.

Lista de Gateways
Aqui possvel agrupar gateways em uma lista. S necessrio dar um nome a lista e escolher
os gateways que faro parte da lista. S preciso fazer uma lista de gateways para facilitar algumas
funes. Por exemplo, nas Regras, caso voc tenha alguns gateways que se encaixam nas mesmas
regras, voc pode fazer a lista para na hora de aplicar a regra no ficar colocando um por um os
gateways que vo fazer parte dela.

40
41
Regras de Roteamento
O corao do sistema de roteamento o mdulo de roteamento dinmico. Atravs dele o
administrador poder criar seus planos de roteamento para as operadoras de acordo com o prefixo das
chamadas. Neste caso o sistema encontrar a regra mais prxima do nmero discado pelo usurio.

Para criar uma nova regra, siga os passos abaixo:

ATRIBUTO DESCRIO REQ. DEF.


Nome da Regra Nome da Regra de Roteamento. SIM N/A
Recorrncia Permite definir a validade de uma regra. NO N/A
Grupo de Rotas Identificador do Grupo de Rotas da regra. SIM 0
Prioridade Prioridade da Regra de Roteamento. SIM 0
Gateways Associao de Gateways ou Listas de Gateways regra de SIM N/A
roteamento.

Tela de Configurao de Regras de Roteamento

Gerenciamento de Regras de Roteamento


Aqui possvel gerenciar as regras de roteamento com maior facilidade utilizando recursos
para sua manipulao, como importao, exportao e cpia.

Em Importao de Regras de Roteamento Dinmico possvel importar um conjunto de


regras de roteamento atravs de uma planilha excel. A planilha modelo fica disponvel para download
na rea de importao (vide imagem acima). O sistema capaz de importar milhares de registros em

42
poucos segundos, fazendo com que a administrao das regras seja simplificada. Ao trmino da
importao, no se esquea de clicar no boto Carregar Alteraes para que o sistema atualize o seu
cache com os novos dados.

1- Faa o download do Template;


2- Abra o Template e complete todos os campos em relao regra de roteamento que so:

ATRIBUTO DESCRIO REQ. DEF.


Nome da Regra Nome da Regra de Roteamento. SIM N/A
Recorrncia Permite definir a validade de uma regra. NO N/A
Grupo de Rotas Identificador do Grupo de Rotas da regra. SIM 0
Prioridade Prioridade da Regra de Roteamento. SIM 0
Gateways IDs Especfica o cdigo de identificao do Gateway, podendo ser mais de SIM N/A
um separado por vrgula:
- Gateway List Type igual a G os IDs so somente separados por
vrgula, Ex: 1,2,3.
- Gateway List Type igual a L so separados por vrgula e prefixado o
# na frente, Ex: #1,#2,#3;
Gateway Type Define se a lista de itens associados regra so Gateways (G) ou SIM G
Listas de Gateways (L).

Tela de Importao de Regras de Roteamento, via template

Em Exportao de Regras de Roteamento Dinmico possvel exportar as regras de


roteamento de um grupo de rotas especifico para um arquivo, seguindo o mesmo padro usado na
importao. Sendo assim possvel editar as regras de roteamento mais facilmente e depois importar
novamente para o sistema. Para realizar a exportao necessrio selecionar o grupo de rotas que
ser exportado e clicar no boto Exportar para CSV, depois aparecendo o arquivo na lista abaixo para
download.

Em Copia de Regras de Roteamento Dinmico possvel copiar as regras de roteamento


de um grupo de rotas para um novo grupo de rotas. Para executar a copia necessrio selecionar o
grupo de rotas de origem, que ser as regras copiadas, e preencher o grupo de rotas de destino, sendo
obrigatoriamente um no utilizado, depois das informaes preenchidas preciso clicar em Copiar
para executar a copia.

43
Hunt Group
Hunt Group um grupo de assinantes onde ser adicionado um DID para todos eles. Por
exemplo, cada assinante tem o seu DID, prem tambm h como associar um DID para um grupo
de assinantes. O mtodo de ring nos assinantes pode ser programado de duas formas:

Paralelo - Desse mtodo todos os assinantes cadastrados no Hunt Group tocaro no


mesmo momento;
Serial - Nesse mtodo ter uma sequncia e um timeout definido pelo usurio.
Ento o sistema passar a tocar cada ramal em sequncia, passando para o prximo
assim que o timeout terminar.

Time Routing
Time Routing um roteamento de chamada entrante, feito atravs de horrios. Por
exemplo, uma empresa que atende somente em horrio comercial. Ento configurado o Time
Routing para esse assinante e durante o horrio comercial a chamada vai cair no ramal da
recepcionista e fora do horrio a chamada cai em uma mensagem.

44
Configuraes de DIDs
DID vem de Direct Inward Dialing. O mesmo serve para caso voc queira que um nmero
da rede pblica redirecione diretamente para algum usurio do sistema. Nesta pgina possvel
visualizar os DIDS j criados e a opo para a criao de novos.

Para listar os DIDS criados preciso selecionar o Domnio e filtrar os resultados pela Conta
Agrupadora ou pelo Nmero de Entrada.

45
Para a criao de um novo DID necessrio clicar no boto Novo e seguir os seguintes
passos:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio associado ao DID. SIM N/A
Conta Agrupadora Conta detentora do nmero DID. NO N/A
Nmero de Entrada Nmero do DID. SIM N/A
Tipo de Destino Destino para o qual as chamadas sero encaminhadas: SIM Usurio
Usurio: Encaminha a chamada para um usurio e domnio
informados;
Hunt Group: Encaminha a chamada para um Huntgroup do sistema.
Time Routing: Encaminha a chamada para um Time Routing do
sistema.
Conferncia: Encaminha a chamada para uma Sala de Conferncia do
sistema.
URA: Encaminha a chamada para uma URA do sistema.
Gateways Associao de Gateways ou Listas de Gateways regra de SIM N/A
roteamento.
Assinatura Mensal Campo informativo sobre o valor de assinatura mensal do DID. NO N/A
Normalmente utilizador por sistemas de CRM.
Bilhetagem Reversa Ativa/Inativa a tarifao reversa de chamadas entrantes para o NO N/A
nmero DID. Normalmente utilizado para nmeros 0800.

Tela de Configurao de DIDs

46
Importao de Nmeros DIDS
Na primeira aba dessa tela possvel listar e pesquisar os DIDS que j foram importados
anteriormente e se esto em uso ou no, tendo a opo de exclu-los. possvel pesquisar os DIDS
pelo nmero DID ou se esto em uso ou no.

Na segunda aba possvel realizar a importao de vrios nmeros DIDS, que estaro
disponveis para serem usados na criao de um novo DID. Para isso necessrio baixar o template
e preenche-lo. Depois de preenchido, basta selecionar o Domnio em que os DIDS sero importados
e executar a importao.

Prefixo para Domnio


Aqui voc configura um prefixo para executar chamadas entre domnios.

1. Informe o domnio de origem. Ex.: sippulse.com;


2. Informe o prefixo de acesso. Ex.: 22;
3. Informe o domnio de destino. Ex.: voffice.com.br.

Com bases nos dados do exemplo, caso um assinante no domnio sippulse.com ligue para
221000 o sistema ir entregar a chamada na conta 1000 do domnio voffice.com.br.

47
Ao editar-se ou adicionar um novo Prefixo Para Domnio no sistema, depois de salvar as
informaes preciso clicar no boto Carregar Alteraes para que essas novas configuraes
tenham validade.

DID por rea local


Este um novo recurso da licena STFC. Agora possvel manipular o identificador de chamada
dependendo da rea local do usurio. Por exemplo, um usurio de Florianpolis na rea local 4396
(reas locais conforme o CADUP/SAPN, Sistema de Administrao do Plano de Numerao da
Anatel) pode abrir uma chamada para um destino remoto e usar um nmero neste destino
remoto. Para isso o cliente deve possuir um DID em cada local onde deseja enviar o nmero local.
Os Call Centers vo particularmente ficar satisfeitos com este recurso, pois h estatsticas
mostrando que a chance de uma pessoa atender uma chamada com identificar local 52% maior
que se o originador for de um destino de longa distncia ou desconhecido. Para fazer este recurso
funcionar siga os passos abaixo:

1 Crie um DID para a conta na rea local onde voc deseja enviar.

No exemplo acima, o assinante possui um DID 1121333456 na rea local 3827 (So Paulo). Se uma
chamada deste cliente chamada terminar em um gateway da rea 3827 ele deve binar
1132331240.

2 Para que o sistema funcione, preciso que o gateway esteja preparado para binar o DID. Isto
feito na configurao do gateway.

48
Roteamento baseado na qualidade da terminao
As operadoras poderiam aumentar seu lucro se pudessem em tempo real, avaliar qual operadora
possui o menor custo atendendo as necessidades de qualidade. O objetivo do quality routing
permitir que a deciso da melhor rota seja tomada em tempo real de acordo com uma srie de
parmetros.

Determinando o custo mais adequado para a operao


Determinar a operadora de menor custo para uma operao no tarefa fcil pois requer o
processamento de diversas planilhas de tarifas que possuem diferentes cadncias, delas e tarifa de
interconexo. Ser necessrio criar um ajuste de cadncia para poder comparar o custo de forma
adequada.

Novos parmetros para cada rota


Cada regra de roteamento a partir desta verso passa a possuir um conjunto de critrios a serem
preenchidos. Estes critrios podem ser preenchidos ou importados. Os critrios so carregados no
banco de dados e desta forma devem ser informados no formato padro JSON. A Interface do
sistema permite incluir e editar estes valores, mas na maioria dos casos isto se dar mesmo
atravs de importao.

Na aba de configurao possvel especificar por rota se vai ou no ser usado o roteamento por
qualidade. O sistema permite:

Ativar Regra de Qualidade: Ativar ou desativar as regras de qualidade por rota individual.
Modelo de Roteamento por qualidade: Para evitar ter de digitar todas as regras de
qualidade, usamos o sistema de modelos (templates). Ao carregar o template ele carrega
todos os outros dados.

49
Somente Gateways com CLI: Escolher gateways que possuam identificador de chamadas.
Mnimo de amostras: Quantidade de chamadas antes que o sistema passe a atuar. Para ter
estatsticas de forma significativa, um nmero mnimo de amostras precisa estar definido
para o cliente.
Taxa mnima de ASR: Escolher gateways que possuam no mnimo o ASR especificado. Onde
ASR a taxa de atendimento (Chamadas Atendidas/Chamadas Totais)
Taxa mnima de ACD: Escolher gateways que possuam no mnimo o ACD especificado. Onde
ACD o tempo mdio de durao de uma chamada.
Taxa mnima de MOS: Escolher gateways que possuam no mnimo o MOS especificado.
Onde MOS o Mean Opinion Score, medida de qualidade de chamada que vai de 1 5
sendo 5 a melhor qualidade. A medida de qualidade das chamadas medida externamente
e inserida nos gateways.
Taxa mnima de CCR: Escolher gateways que possuam no mnimo o CCR especificado. Onde
CCR a taxa de completamento (Chamadas completadas incluindo ocupadas, no atende e
e canceladas pelo cliente/ Chamadas totais).
Taxa mnima de PDD: Escolher gateways com no mximo o PDD especificado. Onde PDD
quer dizer atraso ps discagem (Post Dial Delay) que o tempo entre a chamada ser
colocada e o sistema enviar o primeiro alerta (180/183) ou atendimento.
Mximo de chamadas simultneas por rota: Nmero mximo de chamadas simultneas
que uma rota pode aceitar. No caso de uma operadora mvel, quantas chamadas o conjunto
de clientes que usam esta rota podem colocar nos gateways.
Ao: As aes possveis naqueles itens que permite aes padronizadas so:
o 1 - Alert: Apenas alerta no log e na interface de eventos
o 2 - Skip: Passa para o prximo gateway
o 4- Penalty Passa para o prximo gateway e gera evento
o 0: Sem nenhuma ao
Penalidade em segundos. O tempo que a rota ficar fora de uso aps ser rejeitada por um
requisito de qualidade.

Modelo de insero de dados


Para simplificar a entrada de dados da qualidade das rotas foi criado uma opo de gerar um
modelo em Roteamento de Chamadas->Modelo de Roteamento por Qualidade.

50
Importando regras para quality routing
As regras de importao permitem que se importe e exporte os registros usando um modelo
especfico. Antes de importar, faa o download do modelo em, Roteamento de Chamadas->
Gerenciamento de Regras->Clique Aqui e Faa o Dwonload do Templare.

Em uma planilha Excel, preencha os dados informando o grupo de roteamento, prefixo, nome da
regra, prioridade, identificao do gateway, se uma lista de gateways(L) ou um gateway (G) e o
nome do template de qualidade. Desta forma durante a importao o sistema ir definir os
parmetros de qualidade presentes no modelo.

Configurao dos gateways


Os parmetros dos gateways a partir desta verso so informados diretamente na interface
grfica. O formato anterior ser migrado durante a instalao. Para usar QROUTING obrigatrio
informar os campos com o novo formato. Abaixo seguem todos os parmetros que podem ser
usados nos gateways.

Suporte a CLI (Calling Line Identification): Se o gateway suporta ou no o uso de


identificadores da chamada (Ex. Chipeiras no suportam CLI, em outras palavras no
suportam a insero do identificador de chamadas definido pelo assinante).
Formato da CLI: Permite a configurao da forma de passagem do identificador de
chamadas para o gateway. Os valores possveis so rfc3325, replacefrom, rpid e by-pass. O
valor rfc3325usa um cabealho do tipo P-Asserted-ID para passar o identificador, o rpid
usa o antigo padro Cisco passando o cabealho Remote-Party-ID e o replacefrom Altera

51
o campo From: do cabealho SIP. O valor bypass no altera o identificador e usa o que
o cliente enviar como cabealho em P-Asserted-ID ou Remote-Party-ID. (pai,rpid,from)

Tipo de CLI: Dar preferncia a identificao descrita no usurio ou gateway. Os valores


possveis so user, gateway e did. O parmetro user mostra o callerid definido no
assinante se houver gateway mostra o callerid do gateway ao invs do assinante e did
mostra o callerid associado a rea local do nmero de A informado na tabela DID. (usr,
gw,did).

Caller ID (CLI): Identificador de chamadas do gateway, caso o usurio no o possua ou a


preferncia esteja como gateway.
Display (CLD - Calling Line Display). Alterar o display no campo From:. Normalmente este
campo possui o nome do cliente ou do usurio do ramal.
Taxa mnima de MOS ( Mean Opinion Score). Informado sobre o gateway. Na dvida use
50 o MOS mximo.
Mximo de Chamadas (MaxCalls). Nmero mximo de chamadas simultneas permitidas
neste gateway.
Dialplan ID: Identificador do plano de discagem para tratamento de chamadas entrantes.
opcional e usado nas rotas de interconexo para tratar alguns tipos de chamadas.
NAT: Forar o uso de NAT para chamadas enviadas para este gateway
Copiar Request-URI para o cabealho TO: Isto usado para suportar gateways que no
aceitam o destino final na Request URI e necessitam que o destino final esteja no campo
TO.

Lista Negra Global Dinmica


O SipPulse agora conta com uma lista negra global dinmica. Os usurios que quiserem usar a lista
podero configurar o seu uso na aba PRO. A lista dinmica global possui os seguintes parmetros.

Ativar Lista Negra Dinmica (bldynactive). Se o usurio ir utilizar e popular e lista negra. No h
opo de usar sem popular.

Tempo de Expirao (bltime). o tempo que a entrada permanecer na lista negra). Aps expirado
o tempo o registro removido do banco de dados.

52
Cdigos de Bloqueio SIP (bldynsip). Quando um cliente receber um cdigo de resposta SIP dentro
desta expresso regular, ele incluir o registro do nmero na lista negra. A lista completa de
cdigos SIP est espalhada em diversas RFCs, uma boa referncia a Wikipedia
https://en.wikipedia.org/wiki/List_of_SIP_response_codes

Exemplo: 404|403|402

Cdigos de Bloqueio Q.850 (bldynq850). Este cdigos permitem que voc use a informao
contida no campo Reason das requisies SIP. So cdigos padro ISDN. Uma lista completa dos
cdigos Q.850 voc pode encontrar em https://www.itu.int/rec/T-REC-Q.850/en.

Exemplo: 1|22|28

Como a lista negra funciona. Os nmeros presentes na lista negra so bloqueados


automaticamente. A lista global, no existe uma lista por usurio. Quando as chamadas so
enviadas, dependendo do cdigo de retorno, a lista criada automaticamente. A lista negra pode
ser editada pelo administrador do sistema e tambm possvel importar via CSV registros na lista.

Abaixo um screenshot do preenchimento destes dados no menu

No exemplo acima, o sistema ir colocar na lista negra quaisquer nmeros retornando com 404 ou
402 ou cdigos Q.850 1 (Unallocated Number) e 2 (No route to specified transito network). Estes
so s exemplos, verifique os cdigos mais apropriados sua operao.

Entrada esttica de dados


A lista negra dinmica recebe dados de forma esttica e dinmica. Se desejar incluir dados
estticos use a aba Roteamento de Chamadas->Lista Negra Dinmica. L voc deve incluir o
nmero e o cdigo SIP ou Q.850 que voc quer inserir. Lembrando que no pode ser 486, 487 e
408.

Bloqueio
O bloqueio da lista dinmica aparecer para o usurio como uma mensagem 473 Dynamic
Blacklist.

53
10. PABX-IP
Configurao de Anncios
Aqui sero adicionados os arquivos de udio para serem utilizados nos anncios. Existem
tem 2 tipos de anuncio, os de sistemas e os de domnios que sero explicados abaixo. Os formatos
suportados so: .gsm, .wav, .mp3, . g729, .slin.

Anncios de Sistema: Os anncios de sistema so anncios gerais do sistema, para


todos os domnios do sistema. Ex: Mensagem de nmero invlido, saldo insuficiente,
etc.;
Anncios de Domnios: Os anncios de domnios so anncios especficos para cada
domnio. Ex: URA especfica para o domnio, etc.;

54
Salas de Conferncia
A Sala de Conferncia, um recurso da plataforma, onde os participantes podem conversar
em conjunto ao mesmo tempo. Uma sala pode ser previamente criada com configuraes
bsicas/avanadas, conforme a seguir:

ATRIBUTO DESCRIO REQ. DEF.


Nmero Nmero da Sala de Conferncia (Campo auto-gerado pelo sistema). SIM Auto
Incio Data de Incio de validade da sala. Caso de no informado, a validade NO N/A
ser indeterminada.
Trmino Data de Trmino de validade da sala. Caso de no informado, a SIM N/A
validade ser indeterminada.
Participantes Nmero mximo de participantes da sala. Caso no informado, o NO N/A
nmero de participantes ser ilimitado.
Senha Senha de acesso a sala de conferncia. Caso no informado, o acesso NO N/A
ser direto.
Opes Opes avanadas na sala de conferncia. NO N/A
Gravao Nome do Arquivo de gravao das chamadas da sala. NO N/A
Formato Formato do arquivo de gravao (.gsm, .wav e .mp3). NO N/A
Senha Admin. Senha do administrador da sala de conferncia. NO N/A
Opes Admin. Opes avanadas do administrador da sala de conferncia. NO N/A

Tela de Configurao de Salas de Conferncia

Unidades de Resposta Audvel (URA)


O recurso de URA disponibiliza menus interativos formados por arquivos de udio que
passar instrues ao solicitante da chamada, e ao final o mesmo escolhe uma das opes dadas,
podendo ligar para algum Assinante, Grupo de Captura, Sala de Conferncia. Para configurar esse
servio so necessrios esses dados:

ATRIBUTO DESCRIO REQ. DEF.


Nome Nome da URA SIM N/A
Mensagem Menu Mensagem de Entrada na URA SIM N/A
Limite de Repeties Quantidade mxima de repeties para selees invlidas. SIM 3
Tempo de Espera Tempo mximo de espera para seleo de um item da URA (seg.). SIM 3
Msg. Seleo Mensagem para selees invlidas. SIM N/A
Invlida
N. Mximo Dgitos Nmero mximo de dgitos para seleo de um item. SIM 1
Call Group Grupo de Captura em que a URA faz parte. NO N/A

55
Atendimento Aut. Flag para ativar o atendimento automtico das chamadas NO False

Tela de Configurao da URA


Agora na opo de IVR foram criadas duas novas opes para o cliente, a opo I e a opo T.
Neste caso o usurio no ir digitar. A opo I ser disparada sempre que o cliente digitar um
nmero invlido e a opo T ser disparada quando o usurio no selecionar nenhuma opo ao
final das repeties.

Filas de Atendimento (DAC)


Filas de Atendimento implementam o recurso de distribuio e gerenciamento de chamadas,
em um grupo de agentes. As filas podem ser personalizadas com mensagens e estratgias de
distribuio especficas.

Abaixo os dados de configurao de uma Fila de Atendimento:

ATRIBUTO DESCRIO REQ. DEF.


Nome Nome da Fila de Atendimento SIM N/A
Contexto Contexto da Fila de Atendimento SIM queue
Estratgia Estratgia de distribuio das chamadas para os agentes: SIM ringall
ringall;
roundrobin;
listrecent;
fewestcall;
random;
rrmemory;
linear;
wrandom.

Atraso Delay entre o atendimento e a conexo (segundos). SIM 1


Tempo de Espera Tempo mximo de espera na fila at o atendimento (segundos). SIM 180
Usurios Quantidade mxima de usurios em espera, caso no informado, ser NO N/A
ilimitado.
Msica Msica de espera na fila. SIM N/A
Tempo de Anncio Tempo de espera do anncio. SIM N/A
Membros Lista de Membros (Agentes) Participantes da Fila. SIM N/A

56
Nome do Membro (Agente);
Interface (Canal de Acesso);
Penalidade;
Tempo de Pausa entre os atendimentos (segundos).

Tela de Configurao da Fila de Atendimento


A nova fila de atendimento j vem pr-preenchida com valores padro. Quando voc digitar o
nmero da fila, por exemplo, 1000, o sistema j criar a uri correspondente. Foram colocadas
explicaes em cada campo (ToolTip), de forma que voc pode ver a descrio detalhada
passando o mouse sobre o campo. Estes campos so os obrigatrios e incluem a URI, a estratgia
o nmero de tentativas, a classe de msica em espera o tempo de expirao. Se permite tocar um
ramal em uso e o nivel de servio. O nvel de servio especifica quantos segundos o SLA para
atendimento ao cliente no painel de controle ser possvel var quantas chamadas foram atendidas
dentro do tempo de servio.

Alguns parmetros opcionais tambm esto disponveis. As descries dos campos esto
disponveis na interface atravs de popups nos campos.

A Fila de atendimento tambm suporta colocar udios em espera para ela como anncios
peridicos, voc o prximo a ser atendido, agradecendo o atendimento e etc.

57
Criando membros da fila
Aps criar a fila, voc pode ou no criar os membros da fila. Os membros tanto podem ser criados
estaticamente ou dinamicamente. O mtodo dinmico mais prtico e funcional, mas se voc
quiser criar os membros estaticamente siga o procedimento abaixo:

Para definir os membros estaticamente, digite o nome do membro, a interface que sempre no
formato Local/extenso@rextensions/n e a penalidade. A penalidade pode ser usada mais tarde
na fila para priorizar os agentes. Os agentes com maior penalidade so selecionados depois. Voc
pode por exemplo criar trs agentes com penalidade 1 e o supervisor com penalidade 2. O
supervisor neste caso s receber chamadas se os trs agentes com penalidade menor estiverem
em uso.

Uma outra forma de criar agentes dinamicamente atravs de Star Codes.

*11 Faz o login do agente na fila de atendimento


*12 Faz o logout da fila de atendimento
*13 faz uma pausa do agente
*14 Remove a pausa do agente.

Monitoria de Fila
Para a monitorao dos agentes foi desenvolvido o Wallboard para que haja a monitorao dos
agentes na fila de atendimento. A monitoria da fila fica no menu de monitorao.

O monitor da chamada mostra:

58
Quantas chamadas esto aguardando na fila
Quantos agentes esto disponveis para atender
Quantas chamadas foram atendidas dentro do nvel de servio
Peso da fila

O sistema ainda descreve os agentes conectados com o seu estado e quantas chamadas foram
atendidas por agente. E mostra ainda as chamadas que esto sendo atendidas com o identificador
da chamada.

Deve ser criado um plano de discagem com uma mscara de discagens para que o atendente entre
na fila.

Ex:

Deve ser criado um plano de discagens para que seja encaminhado o DID (nmero entrante) para
a fila de atendimento.

Para encaminhamento para a fila pode se criar um DID ou uma linha no plano de discagem. A
chamada deve ser encaminhada para a fila com a respectiva URI. Use a expresso transformada
para informar a URI da fila que quer encaminhar.

11. Gravao de Chamadas


Mdulo responsvel por executar a gravao e disponibilizar os arquivos atravs da interface
web.

Configurao do Servio:

Listagem de Chamadas Gravadas no Portal Administrativo:

59
Existe a possibilidade de exibir as gravaes no Portal dos Assinantes, caso o recurso esteja habilitado
no seu perfil.

Listagem das Chamadas no Portal do Assinante:

12. Relatrios
Detalhamento de Chamadas Saintes
Aqui so detalhadas todas as chamadas saintes de determinado usurio em um perodo de
tempo definido pelo administrador. Ele ir gerar uma tabela mostrando a origem, data e hora, destino,
servio, IP da origem, User Agent, durao, tarifa e o total.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A

60
Domnio Domnio de origem. SIM N/A
Accountcode Conta do Assinante. SIM N/A
Servio Tipo de Servio das chamadas executadas: SIM TODOS
TODOS;
PSTN;
LOCAL;
ACOBRAR (STFC).
Nmero Destino Filtro pelo nmero de destino. NO N/A

Tela do Relatrio de Detalhamento de Chamadas Saintes

Detalhamento de Chamadas Entrantes


Em Detalhamento de Chamadas Entrantes, o administrador pode gerar um relatrio e ver
todos os detalhes sobre um assinante que tenha o servio de 0800 ou DID.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Domnio Domnio de origem. SIM N/A
Accountcode Conta do Assinante. SIM N/A
Servio Tipo de Servio das chamadas executadas: SIM TODOS
TODOS;
DID;
0800.
Nmero Destino Filtro pelo nmero de destino. NO N/A

Tela do Relatrio de Detalhamento de Chamadas Entrantes

61
Detalhamento de Chamadas Gateway
Em Detalhamento de Chamadas Gateway, o administrador pode gerar um relatrio de todas
as chamadas executados por um determinado gateway. Nesse relatrio sero mostradas as seguintes
informaes referentes chamada: data, profile, origem, destino, servio, src ip, durao, valor
compra, custo total, valor venda e a venda total.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Filtrar por Estratgia de Filtro do Relatrio: SIM GW
Gateway;
Provedor;
Mltiplos Gateways.
Nmero Destino Filtro pelo nmero de destino. NO N/A

Tela de Detalhamento de Chamadas por Gateway

Consumo por Fornecedores


Aqui sero detalhadas as informaes referentes ao consumo realizado dos provedores. No
resultado sero mostrados os dados referentes ao consumo, agrupados por gateway. As informaes
mostradas sero o GWID do gateway, nome do gateway, endereo IP, RateID, a durao que mostra
o consumo do gateway sobre o provedor juntamente com o seu custo. Em baixo temos o total dos
campos durao e custo.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

62
ATRIBUTO DESCRIO REQ. DEF.
Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Provedor Nome do Provedor SIM N/A

Tela de Detalhamento de Consumo por Fornecedores

Chamadas Perdidas
Aqui sero detalhadas as chamadas no atendidas para um determinado usurio.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Domnio Domnio de Origem SIM N/A
Accountcode Conta de Origem. SIM N/A

Tela de Detalhamento de Chamadas Perdidas

Chamadas Timeout
Em Chamadas Timeout, o administrador poder ver um relatrio das chamadas que ficaram
presas no sistema, que passaram do tempo limite configurado (padro de 2 horas) e tiveram seu tipo
de servio mudado para timeout. As informaes mostradas nesse relatrio so: profile, origem,
data, servio, src ip, user agent, durao, tarifa e o total.

63
Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Domnio Domnio de Origem SIM N/A
Accountcode Conta de Origem. SIM N/A
Nmero de Destino Filtro pelo Nmero de Destino NO N/A

Tela de Detalhamento de Chamadas Presas (Timeout)

Motivo de Desligamento
Em Motivo de Desligamento, o administrador poder ver por qual motivo uma chamada
completada foi terminada. As informaes visualizadas so Data, Destino, Mtodo, Sip Code, Sip
Reason, SRC IP, User Agent e o GwId.

Para gerar esse relatrio o administrador deve fornecer os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Data Inicial Data Inicial da Pesquisa. SIM N/A
Data Final Data Final da Pesquisa. SIM N/A
Domnio Domnio de Origem SIM N/A
Accountcode Conta de Origem. SIM N/A
Nmero de Destino Filtro pelo Nmero de Destino NO N/A

Tela de Detalhamento de Motivos de Desligamento de Chamadas

64
Esse relatrio retorna somente os 1000 primeiros resultados, por se tratar de uma pesquisa
mais onerosa ao sistema, por isso os campos data esto abertos para ser possvel tambm selecionar
o horrio, para restringir a pesquisa somente aos resultados procurados.

Rentabilidade por Revendas


Em Rentabilidade por Revendas, o administrador poder ver qual a sua taxa de rentabilidade
por revenda. S necessrio escolher uma data de incio e uma data de fim, juntamente com um
domnio e uma revenda desse domnio para gerar o relatrio, mostrando os profiles juntamente com
os minutos gastos, seus Dados de Custo e Venda e a margem de rentabilidade obtida. Em baixo temos
o total de todas as partes da tabela.

Rentabilidade por Provedores


Em Rentabilidade por Provedores, o administrador poder ver qual a sua taxa de
rentabilidade em todas as chamadas processadas por um determinado provedor (operadora). S
necessrio escolher uma data de incio e uma data de fim e um domnio para gerar o relatrio,
mostrando o plano de cada Provedor e tambm os Dados de Custo e Venda que tem a Taxa de
Conexo e a Cadncia. Tambm mostra quantos minutos foram utilizados em cada um dos planos, o
valor de custo e de venda e a margem de lucros. Em baixo temos o total de todas as partes da tabela.

65
Rentabilidade por Account Code
Em Rentabilidade por Account Code, o administrador poder ver qual a taxa de
rentabilidade por assinante. S necessrio especificar a data de incio e fim do relatrio, e tambm
o domnio. Ento ser gerado uma tabela com todas as contas associadas aquele domnio onde sero
mostrados o plano do assinante, a taxa de conexo, cadncia, markup, quanto tempo ele utilizou, o
custo gerado, por quanto foi vendido e a porcentagem.

Rentabilidade por Rota


Em Rentabilidade por Rota mostrado o rendimento em cima de cada rota. Para gerar o
relatrio necessrio escolher a data de incio e fim e um domnio. Ento gerada uma tabela
mostrando qual o prefixo da rota, o provedor, quantos minutos ele foi utilizado nesse tempo, o custo
por minuto, custo total, valor de venda por minuto, valor de venda total e a margem de lucros.

66
67
13. Monitorao
Dashboard
No Dashboard sero mostrados todos os componentes do sistema onde tero os dados que
so necessrios para seu funcionamento, ou apenas para questo de estatsticas. Ele tambm mostra
se os componentes esto ativos ou no, para o administrador do sistema no ter que verificar isso
fisicamente, ou atravs de acesso a mquina.

No Dashboard h nmero de quantas chamadas foram executadas em cada gateway do


sistema, porcentagem de quantas chamadas foram respondidas e quantas foram completadas,
quantos assinantes esto registrados em cada domnio, quantos canais esto ativos no media server,
estatsticas do SBC, etc. Essas informaes esto divididas em cinco grandes abas: Viso Geral,
Clientes, Fornecedores, Chamadas Ativas e Registros.

Em Viso Geral onde so visualizadas as informaes gerais do sistema e seus


componentes. Na parte superior mostrada as estatsticas gerais da plataforma no dia para o
acompanhamento do funcionamento da mesma e logo abaixo mostrado os grficos dessas
informaes distribudas ao longo do dia.

Abaixo dessas informaes so exibidas as informaes e estatsticas dos componentes do


sistema, como SIP PROXY, RTP PROXY, SBC, MEDIA SERVER e no final so mostradas as mdias
dos processos que geram as informaes do sistema, como migrar registros, fechar bilhetes, etc,
podendo verificar como est a carga do sistema, se existe algum processo que est demorando em ser
executado.

68
Em Clientes onde so visualizadas as estatsticas dos assinantes que foram ativados a
monitorao no Dashboard. Aqui possvel verificar a quantidade de chamadas ativas por assinante,
total de minutos processados, estatsticas de ASR, CCR, CFR, como est os valores de custo, venda
e a margem obtida, alm de como est o uso da quota para esse assinante no dia.

Em Fornecedores onde so visualizadas as estatsticas dos gateways do sistema, que


tiveram o flag ativar monitorao marcado. As informaes visualizadas so nmero de chamadas
ativas e em processamento, total chamadas processadas, total de minutos, ACD, PDD, ASR, CCR,
CFR. Sobre o nome do gateway existe um link para a pgina de ASR do gateway no dia atual.

Existe a opo de Ativar/Desativar um gateway no boto da coluna ST, que o status do


gateway, verde se ele est ativo e vermelho se no. Ao desativar um gateway, no ser encaminhada
mais nenhuma chamada para ele. A ativao/desativao de um gateway permanente no sistema,
mesmo carregando alteraes os gateways que estavam desativados continuaro nesse estado, salvo
casos de parada do sip proxy, ou seu restart, onde todos os gateways voltaro a ficar ativos. Ainda
nesses casos, ao clicar-se em carregar alteraes, se existia algum gateway desativado antes da queda
ou restart ele voltar a ficar desativado.

Como ltima opo dessa aba, existe a possibilidade de visualizar as informaes em


perodos de tempos diferentes, indo desde os ltimos 15 minutos at o dia todo.

69
Em Chamadas Ativas alm de ser possvel visualizar e pesquisar as ligaes em curso existe
a opo de encerrar uma chamada clicando no boto de Hangup, finalizando a ligao para ambas as
pontas.

Em Registros alm de ser possvel visualizar e pesquisar os registros existe um boto para
desresgistrar um determinado usurio, removendo ele da tabela de registros do sistema. Essa ao
pode levar alguns minutos (1-3) at que realmente o registro seja removido, para agilizar esse
processo pode ser clicado no boto Flush, limpado os registros imediatamente.

O Dashboard ao todo, indiferente da aba selecionada, tem a opo no canto inferior direito
de definir o intervalo de atualizao da tela, que pode ser de 30 em 30 segundos ou at de hora em
hora.

Logs do Sistema
Um dos recursos mais requisitados pelos nossos clientes uma interface para melhor visualizao
das logs do sistema. Esta interface vai ajudar nossos clientes a resolver problemas mais
rapidamente entendendo o que ocorreu com o fluxo de uma ligao. Quase todas as linhas de log
possuem o nmero de A, nmero de B, identificao da chamada e IP de origem facilitando a
busca. Abaixo voc pode ver uma figura com a interface do sistema.

Nvel padro de log


O sistema de logs opera em modo WARNING por default. possvel aumentar o nvel de log para
info para ver mensagens de encaminhamento da chamada. O modo INFO NO FOI CRIADO PARA
SER USADO EM PRODUO, pois consome muito disco, mas pode ser usado para troubleshooting.
Para definir o nvel atual de log entre na aba configuraes e selecione mudar nvel.

70
Voc pode pesquisar os logs por data, nvel, IP de origem, Identificador da Chamada (Call-ID),
Numero de A, Numero de B e mensagem.

Iniciar e Parar Monitoramento


Voc pode iniciar e parar o monitoramento dos logs em tempo real usando o boto Iniciar e Parar
o Monitoramento.

Excluir Selecionados e Excluir Todos


A interface de do log uma interface para visualizao rpida que fica em memria e tem um
limite pr-estabelecido. Toda a noite os logs so limpos. Os logs em disco permanecem, mas s
podem ser acessados da console do sistema operacional em caso de necessidade. Dependendo do
volume possvel estipular uma limpeza no log em memria em mais de um dia. Aps ver o log de
seu interesse, voc pode limpar os logs.

Exportar para CSV


Voc pode tambm exportar os logs para arquivos separados por vrgulas diretamente da
interface.

Busca de Logs
Para buscar um log, basta preencher um dos seguintes itens, Call-ID, Nmero de A, Nmero de B,
IP de origem ou mensagem e pressionar o boto Gerar Relatrio.

Sip Trace
No Sip Trace mostrado todo o caminho de uma chamada at seu destino, desde que o Trace
esteja ativado no assinante. Nesse modo, so mostradas todas as mensagens que so enviadas e
recebidas pelo assinante. Na monitorao ser mostrada a hora que foi enviada/recebida a mensagem,
qual a mensagem que foi enviada/recebida, status, ip de origem, ip do Proxy e ip de destino. Clicando
em dialogo, sero mostradas tambm toda a troca de pacotes entre o assinante destino e o
assinante final.

71
A ferramenta de Sip Trace deve ser utilizada apenas para auditoria ou para eventos
especficos, no devendo ser mantida ativa para todos os clientes e chamadas. Sua utilizao indevida
trar impactos de desempenho operacional podendo tornar a plataforma indisponvel ou causar erros
de bilhetagem.

Caso seu uso ativo de forma permanente seja mandatrio, a infra-estrutura dever prever
espelhamento de porta no switch com uso de ferramenta de captura de dados especfica, salvando as
informaes capturadas em servidor separado.

Siga as recomendaes da equipe tcnica da SipPulse, mesmo quanto ao uso em excees.

ASR dos Gateways


Este relatrio tem como objetivo mostrar a taxa percentual de chamadas processadas com
xito por determinado gateway. Os dados so exibidos atravs de um grfico e uma tabela detalhada,
h um campo opcional para exibir uma lista com os detalhes das chamadas e um campo para filtrar
os resultados pelo destino. A lista com os detalhes das chamadas pode ser exportada para CSV.

As datas iniciais e finais devem ser selecionadas com o horrio para tornar a busca mais
especfica e quando a lista com os detalhamentos de chamadas for exibida, existe a opo na Lista de
ASRs de mostrar somente um Sip Code especfico clicando no cone da lupa.

72
73
ASR dos Clientes
Este relatrio tem como objetivo mostrar a taxa percentual de chamadas realizadas com xito
por um determinado usurio. Os dados so exibidos atravs de um grfico e uma tabela detalhada, h
um campo opcional para exibir uma lista com os detalhes das chamadas e um campo para filtrar os
resultados pelo destino. A lista com os detalhes das chamadas pode ser exportada para CSV.

As datas iniciais e finais devem ser selecionadas com o horrio para tornar a busca mais
especfica e quando a lista com os detalhamentos de chamadas for exibida, existe a opo na Lista de
ASRs de mostrar somente um Sip Code especfico clicando no cone da lupa.

CFR por Gateway


Este relatrio tem como objetivo mostrar a taxa percentual de chamadas no completadas por
um determinado gateway. Os dados so exibidos atravs de um grfico e uma tabela detalhada, h
um campo opcional para exibir uma lista com os detalhes das chamadas e um campo para filtrar os
resultados pelo destino. A lista com os detalhes das chamadas pode ser exportada para CSV.

As datas iniciais e finais devem ser selecionadas com o horrio para tornar a busca mais
especfica e quando a lista com os detalhamentos de chamadas for exibida, existe a opo na Lista de
ASRs de mostrar somente um Sip Code especfico clicando no cone da lupa.

74
Informaes de Transbordos
Nos relatrios de ASR e CFR do sistema possvel visualizar as informaes do transbordo
das chamadas, mostrando todas as suas tentativas. Sendo possvel assim verificar o fluxo da chamada
dentro do sistema, ajudando na analise de problemas.

Para exibir a informao dos transbordos preciso que o flag Exibir Chamadas esteja ativo
para listar as chamadas, na ltima coluna mostrada possvel ver a quantidade de tentativas de cada
chamada e clicando sobre o nmero exibida uma janela com as informaes de todas as tentativas.

75
Zabbix
A SIPPulse utiliza uma ferramenta chamada Zabbix, que monitora servidores em clientes,
oferecendo informaes de operao, relacionadas ao nvel de processamento, uso de memria, uso
de armazenamento, chamadas ativas etc. Neste documento voc aprender a instalar e configurar
todos os recursos envolvidos.

Monit
O Monit um componente interno que funciona como um agente de gerenciamento no servidor.
O Monit monitora em tempo real:

Se todos os processos esto ativos


Se a memria est abaixo de um determinado limite
Se o espao em disco est abaixo de um determinado limite
Se o processamento est abaixo de um determinado limite

O Monit possui aes pr-programadas para reiniciar os processos que possam porventura
estarem travados, enviar e-mails ou alarmes SNMP caso a quantidade de memria, cpu ou disco
estiverem abaixo de um determinado limite.

76
Voip Monitor (Opcional)
Para o monitoramento em tempo real da qualidade das chamadas, usamos o sistema
VoIPMonitor.

Inventrio
Os elementos da soluo possuem suporte SNMP e LLDP-MED que permite disponibilizar
as informaes dos servidores e telefones para o inventrio e auto-descobrimento por plataformas de
gerenciamento de rede. O sistema pode gerar relatrios de todos os elementos ativos e registrados
informando seu IP, MacAddress e Modelo. Esta funcionalidade est disponvel no dashboard.
Elementos como gateways e servidores de mdia so cadastrados e monitorados na plataforma,
atravs do dashboard.

77
14. Agendamento de Tarefas
Aqui possvel agendar tarefas do sistema para serem executadas e verificar o histrico de
tarefas j executadas e seu status. Em Agendar Nova Tarefa feito o agendamento de uma nova tarefa
para ser executada pelo sistema, onde se seleciona numa lista qual tarefa deseja-se agendar e clica-se
em Prximo para ir para a pgina de configurao da prpria tarefa.

Gerao de LCR
O recurso de LCR (Least Cost Routing) uma dessas tarefas que podem ser agendadas, que
gera um novo grupo de rotas a partir de um grupo j cadastrado organizando os gateways em ordem
de custo.

Para agendar uma nova execuo do LCR deve ser selecionada a opo LCR_ROUTE em
Agendamento de Tarefas e clicar em Prximo para ir para a tela de configurao do mesmo. Nessa
tela deve-se selecionar o Grupo de Rotas de Origem que ser copiado e o Novo Grupo de Rotas que
ser criado com as regras ordenadas em ordem de custo, juntamente com a data de inicio de execuo
da tarefa.

78
Re-tarifao
O recurso de Re-tarifao de Bilhetes responsvel por recalcular os bilhetes do sistema.
Esse recurso essencial em situaes onde as tarifas de custo, venda e/ou revenda foram cadastradas
de forma incorreta.

Para bilhetes associados a planos pr-pagos, o sistema no ir processar o ajuste de crdito


nas contas, e essa tarefa pode ser executada pelo administrador, fazendo incluso de crditos de
ajustes (positivos ou negativos).

Dados para Agendamento de Tarefas de Re-tarifao:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Data Inicial Data Inicial dos Bilhetes SIM N/A
Data Final Data Final dos Bilhetes SIM N/A
Incio da Execuo Data e Hora de agendamento da execuo do processo. SIM N/A
Tipo de Re-tarifao Define a estratgia de re-tarifao: SIM Profile
Profile: Seleciona todas as contas associadas ao(s)
profile(s);
Accountcodes: Seleciona a(s) conta(s) de forma individual;
Providers: Seleciona os bilhetes associados ao(s)
fornecedor(es).
Re-tarifar Valores Valores do bilhete que sero re-tarifados: SIM Custo/
Custo / Venda: Recalcula os valores de custo e venda; Venda
Custo: Recalcula somente os valores de custo;
Venda: Recalcula somente os valores de venda;
Obs.: Em casos de revendas, os valores sero recalculados junto a
modalidade Valor de Venda.

Tela de Agendamento de Retarifao

79
Exportao de Relatrios
O recurso de Exportao de Relatrios em Lote responsvel executar a gerao e exportao
de relatrios do sistema em arquivo. Esse recurso essencial em situaes onde existe a necessidade
de se exportar um mesmo relatrio para diversas contas do sistema.

Aps a execuo, os arquivos estaro disponveis na aba downloads do relatrio respectivo.

Dados para Agendamento de Exportao de Relatrios em Lote:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Data Inicial Data Inicial dos Bilhetes SIM N/A
Data Final Data Final dos Bilhetes SIM N/A
Incio da Execuo Data e Hora de agendamento da execuo do processo. SIM N/A
Tipo de Relatrio Define o relatrio que ser exportado: SIM N/A
CHAMADAS SAINTES;
CHAMADAS ENTRANTES;
CHAMADAS PERDIDAS;
CHAMADAS TIMEOUT.
Seleo Por Define o tipo de filtro das contas de origem: SIM Profile
Profile: Seleciona todas as contas associadas ao Profile;
Accountcode: Seleciona as contas de forma individual.

Tela de Agendamento de Exportao de Relatrios

80
15. Revendas
Definio de Revendedores
Na tela inicial, selecionando um Domnio, aparecero as revendas previamente cadastradas.
Ao lado delas tem o boto de excluso e edio. Caso queira criar uma nova revenda, clique em Novo,
ao lado do Domnio.

Ento o administrador precisar preencher os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Nome da Revenda Nome da Revenda. SIM N/A
Responsvel Nome do Responsvel pela Revenda. SIM N/A
E-mail E-mail do responsvel pela Revenda. SIM N/A
Telefone Telefone de Contato. SIM N/A
Celular Telefone Celular de Contato. SIM N/A
Login Login do administrador no portal dos revendedores. SIM N/A
Senha Senha de acesso ao portal dos revendedores. SIM N/A
Lista de Profiles Lista de Profiles associados a revenda. SIM N/A

Tela de Cadastro de Revendas

81
Incluso de Crdito para Revendas
Aqui sero adicionados crditos para as revendas, caso a revenda venda crditos ou servios
pr pagos. Para isso necessrio preencher os seguintes dados:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Revenda Revenda Favorecida. SIM N/A
Valor Valor do Crdito. SIM N/A
Observao Informaes complementares sobre a incluso de crdito. SIM N/A

Tela de Incluso de Crdito para Revendas

Log Incluso de Crdito Revenda


Aqui possvel visualizar o histrico do crdito adicionado a uma revenda. O histrico
visualizado atravs de uma tabela que contm as seguintes informaes: Data da Incluso, Nome da
Revenda, Domnio, Valor, Observaes e Administrador que adicionou o crdito para a revenda.

82
16. Bilhetagem
Aqui ser configurado tudo relacionado bilhetagem assim como seus servios. Tudo o que
se refere a tarifas tambm configurado aqui.

O mdulo de bilhetagem da plataforma processa os bilhetes de todas as chamadas processadas


por qualquer dispositivo autenticado na plataforma.

O sistema tem a capacidade de armazenar um histrico de 180 dias anteriores, podendo


alterar esse perodo, de acordo com a disponibilidade de espao em disco e memria.

Servio Pr-pago
O servio de Pr-pago tem por finalidade tarifar as chamadas dos assinantes pr-pagos em
tempo real. O servio possui um mdulo baseado em eventos que faz a tarifao das chamadas.

Esse mdulo bilheta as chamadas baseando-se no plano de tarifas do assinante e na fila de


eventos pr-pago configurada (vide imagem abaixo).

O servio bilheta as chamadas convencionais para rede pblica (PSTN e Local) e executa
bilhetagem reversa para nmeros 0800 e DID (Direct Inward Dialing).

83
Plano de Tarifas
Em Planos de Tarifas onde so listados todos os planos de tarifas de cada domnio e pode-
se criar novos planos de tarifas conforme a necessidade. Para criar um novo, clique em Novo e
preencha os seguintes campos:

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Nome do Plano Nome do Plano de Tarifas SIM N/A
Tipo do Plano Tipos de Plano: SIM Ps
Ps-Pago;
Pr-Pago.
Bloquear Chamadas Ativa/Inativa o recurso de bloquear as chamadas sem uma tarifa de SIM False
Sem Tarifas venda cadastrada.
RateID Identificador da tabela de tarifas associada ao plano. SIM 1000
Taxa de Conexo Taxa de Conexo que ser aplicada no clculo das chamadas SIM 60
(segundos).
Cadncia Cadncia de tarifao que ser aplicada aps a Taxa de Conexo SIM 60
(segundos).
Delay Inicial Tempo de atraso para contabilizao da durao das chamadas SIM 0
(segundos).
Taxa de Descarte Durao mxima para descarte de chamadas. SIM 0
Franquia Campo informativo utilizado por CRMs integrados a plataforma. NO N/A
Markup Taxa de Markup (sobre-preo) que ser aplicada aos valores das SIM 0%
tarifas associadas ao plano.
Vencimento de Tempo mximo de validade dos crditos (planos pr-pagos). NO N/A
Crditos

Tela de Configurao de Planos de Taridas

84
Estratgia de Fechamento da chamada
Um dos pontos mais controversos dos sistemas de bilhetagem o ponto de encerramento da
chamada. A chamada pode ser encerrada imediatamente aps o recebimento do pedido de BYE
ou na resposta deste pedido. Isto as vezes pode gerar uma diferena de alguns segundos para
cada chamada. No existe um parmetro correto pois isto no tem uma definio normatizada.
Neste caso recomendamos que sua operadora negocie com o cliente a melhor forma. O sistema
tarifa por default ao final da transao no recebimento da resposta do BYE. Este parmetro
selecionado no perfil de tarifao.

Durao da chamada se escolhido fechamento na TRANSAO.

Cliente Operadora

INVITE

200OK

Durao da Chamada
com Fechamento pela
TRANSAO

BYE
200OK

85
Durao da chamada se escolhido fechamento no PEDIDO

Cliente Operadora

INVITE

200OK

Durao da Chamada
com Fechamento pelo
PEDIDO

BYE
200OK

Exemplo Real de Tarifao no Fechamento do Encerramento

Se voc observar no exemplo abaixo, o sistema est tarifando com arredondamento para cima e
BYE no fechamento. Por isso a durao da segunda chamada foi de 16s considerando os 5s do
timeout do pedido de BYE

+--------+---------------------+---------------------+--------------+
| method | time | invtime | microseconds |
+--------+---------------------+---------------------+--------------+
| INVITE | 2016-07-11 10:44:36 | 2016-07-11 10:44:36 | 777248 |
| BYE | 2016-07-11 10:44:44 | 2016-07-11 10:44:44 | 92302 |
| INVITE | 2016-07-11 10:46:07 | 2016-07-11 10:46:07 | 118647 |
| BYE | 2016-07-11 10:46:23 | 2016-07-11 10:46:19 | 100370 |
+--------+---------------------+---------------------+--------------+

+---------------------+----------+
| call_start_time | duration |
+---------------------+----------+
| 2016-07-11 10:44:36 | 8 |
| 2016-07-11 10:46:07 | 16 |
+---------------------+----------+

Agora o mesmo exemplo com estratgia de fechamento no pedido. Agora ao invs do Time,
considerado o invtime (Tempo do PEDIDO de BYE). Note que agora o tempo de tarifao da
segunda chamada de 12s ao invs de 16, pois foi considerado o tempo do pedido e no do
recebimento da resposta (fim de transao).

86
+---------------------+----------+
| call_start_time | duration |
+---------------------+----------+
| 2016-07-11 10:44:36 | 8 |
| 2016-07-11 10:46:07 | 12 |
+---------------------+----------+

Controle de Arredondamento de Chamada


Esta verso possui um recurso que permite um ajuste mais fino da parte de bilhetagem. O sistema
possui agora um controle de arredondamento. O sistema pode agora truncar (comportamento
padro e padro na verso 3), pode arredondar para baixo ou arredondar para cima o resultado.
Isto possvel porque agora o sistema armazena os microssegundos da chamada nos bilhetes.
Estas configuraes podem ser feitas no plano de tarifas dos clientes.

Truncar
Quando se seleciona truncar, o sistema ignora os microsegundos do bilhete e tarifa considerando
apenas os segundos.

Exemplos terico:

Inicio Fim Durao Real Durao Bilhetagem


19:01:49 900 ms 19:01:50 100ms 200 ms 1
19:01:49 100 ms 19:01:50 900 ms 1800ms 1
19:01:49 490 ms 19:01:50 500 ms 1010 ms 1

Dados Reais:

+--------+---------------------+---------------------+--------------+
| method | time | invtime | microseconds |
+--------+---------------------+---------------------+--------------+
| INVITE | 2016-07-11 10:37:13 | 2016-07-11 10:37:13 | 58283 |
| BYE | 2016-07-11 10:37:16 | 2016-07-11 10:37:16 | 780420 |
| INVITE | 2016-07-11 10:37:18 | 2016-07-11 10:37:18 | 737142 |
| BYE | 2016-07-11 10:37:21 | 2016-07-11 10:37:21 | 491000 |
| INVITE | 2016-07-11 10:37:24 | 2016-07-11 10:37:24 | 8418 |
| BYE | 2016-07-11 10:37:28 | 2016-07-11 10:37:28 | 741293 |

87
+--------+---------------------+---------------------+--------------+

+---------------------+----------+
| call_start_time | duration |
+---------------------+----------+
| 2016-07-11 10:37:13 | 3 |
| 2016-07-11 10:37:18 | 3 |
| 2016-07-11 10:37:24 | 4 |
+---------------------+----------+

Arredondar para cima


Quando se seleciona arredondar para cima, o sistema considera os microssegundos e arredonda o
resultado final da subtrao do horrio de fim para o horrio de incio para cima.

Exemplo terico:

Inicio Fim Durao Real Durao Bilhetagem


19:01:49 900 ms 19:01:50 100ms 200 ms 1
19:01:49 100 ms 19:01:50 900 ms 1800ms 2
19:01:49 490 ms 19:01:50 500 ms 1010 ms 2

Dados Reais:

+--------+---------------------+---------------------+--------------+
| method | time | invtime | microseconds |
+--------+---------------------+---------------------+--------------+
| INVITE | 2016-07-11 10:32:14 | 2016-07-11 10:32:14 | 478894 |
| BYE | 2016-07-11 10:32:18 | 2016-07-11 10:32:18 | 769550 |
| INVITE | 2016-07-11 10:32:22 | 2016-07-11 10:32:22 | 366615 |
| BYE | 2016-07-11 10:32:26 | 2016-07-11 10:32:26 | 69645 |
| INVITE | 2016-07-11 10:32:28 | 2016-07-11 10:32:28 | 255671 |
| BYE | 2016-07-11 10:32:33 | 2016-07-11 10:32:33 | 9919 |
+--------+---------------------+---------------------+--------------+

+---------------------+----------+
| call_start_time | duration |
+---------------------+----------+
| 2016-07-11 10:32:14 | 5 |
| 2016-07-11 10:32:22 | 4 |
| 2016-07-11 10:32:28 | 5 |
+---------------------+----------+

Arredondar na mdia
Quando se seleciona arredondar para cima, o sistema considera os microssegundos e arredonda o
resultado final da subtrao do horrio de fim para o horrio de incio para baixo quando abaixo
de 500ms e para cima quando acima de 500ms.

**** CUIDADO, O USO DE ARREDONDAMENTO PELA MDIA PODE AFETAR NEGATIVAMENTE O


SEU FATURAMENTO, A RESPONSABILIDADE DO CLIENTE ***

Inicio Fim Durao Real Durao Bilhetagem

88
19:01:49 900 ms 19:01:50 100ms 200 ms 0
19:01:49 100 ms 19:01:50 900 ms 1800ms 2
19:01:49 490 ms 19:01:50 500 ms 1010 ms 1

Veja os exemplos reais abaixo:


+--------+---------------------+---------------------+--------------+
| method | time | invtime | microseconds |
+--------+---------------------+---------------------+--------------+
| INVITE | 2016-07-11 10:13:04 | 2016-07-11 10:13:04 | 959542 |
| BYE | 2016-07-11 10:13:08 | 2016-07-11 10:13:08 | 447289 |
| INVITE | 2016-07-11 10:13:13 | 2016-07-11 10:13:13 | 258989 |
| BYE | 2016-07-11 10:13:17 | 2016-07-11 10:13:17 | 859606 |
| INVITE | 2016-07-11 10:13:21 | 2016-07-11 10:13:21 | 813934 |
| BYE | 2016-07-11 10:13:25 | 2016-07-11 10:13:25 | 958390 |
+--------+---------------------+---------------------+--------------+

Resultados
+---------------------+----------+
| call_start_time | duration |
+---------------------+----------+
| 2016-07-11 10:13:04 | 3 |
| 2016-07-11 10:13:13 | 5 |
| 2016-07-11 10:13:21 | 4 |
+---------------------+----------+

Tipos de Ligaes
Em Tipos de Ligaes o usurio poder cadastrar nomes para classificar as ligaes em
diferentes tipos, para fazer a qualificao de tarifas. Os Tipos de Ligaes do sistema sero usados
no cadastramento das tarifas de venda, para realizar a qualificao nos bilhetes.

Tarifas de Venda
Em Tarifas de Venda, o administrador define os valores das tarifas de venda para os destinos
em que a operadora vende servios de telefonia.

ATRIBUTO DESCRIO REQ. DEF.


Domnio Domnio de Origem. SIM N/A
Descrio Descrio da Tarifa SIM N/A

89
Prefixo Prefixo da Tarifa, Ex.: 5511 SIM N/A
RateID Identificador da Tabela de Tarifas que o rate faz parte SIM 1000
Valor de Venda Valor de venda da tarifa; SIM 0,00
Taxa de Conexo Taxa de Conexo especfica da tarifa. Quando informada, sobrepe o NO N/A
padro do Plano de Tarifas.
Cadncia Cadncia especfica da tarifa. Quando informada, sobrepe o padro NO N/A
do Plano de Tarifas.
Tipo de Ligao Classificao da Tarifa de Venda. NO N/A

Tela de Cadastro de Tarifas de Venda

Gerenciamento Tarifas de Venda


Aqui possvel gerenciar as tarifas de venda com maior facilidade utilizando recursos para
sua manipulao, como importao, exportao e cpia.

Em Importar Tarifas de Venda possvel importar tarifas de venda a partir de uma planilha
excel, para isso necessrio baixar o template e preenche-lo. Para realizar a importao necessrio
preencher o domnio em que as tarifas sero importadas, depois clicar em Add e selecionar o arquivo
preenchido conforme modelo e clicar em Upload para finalizar a importao.

90
Em Exportao de Tarifas de Venda possvel exportar todas as tarifas de venda de um
rate id para um arquivo, seguindo mesmo padro usado na importao. Assim sendo possvel editar
as tarifas de um rate id inteiro mais facilmente e depois importar novamente para o sistema. Para
realizar a exportao necessrio selecionar o domnio e o rate id que ser exportado e clicar no boto
Exportar para CSV, depois aparecendo o arquivo na lista abaixo para download.

Em Copia de Tarifas de Venda possvel copiar todas as tarifas de venda de um rate id


inteiro para um novo rate id. Para executar a copia necessrio selecionar o domnio e rate id de
origem, que ser as tarifas copiadas, e preencher o domnio e rate id de destino, podendo o domnio
ser ou no o de origem e o rate id de destino obrigatoriamente tem que ser um no utilizado, depois
das informaes preenchidas preciso clicar em Copiar para executar a copia.

91
Tarifas de Compra
Em Tarifas de Compra, o administrador define os valores das tarifas de custo associados a
um provedor. Atravs destes valores o sistema poder contabilizar o custo de todas as chamadas
executadas:

ATRIBUTO DESCRIO REQ. DEF.


Provedor Provedor SIM N/A
Descrio Descrio da Tarifa de Compra SIM N/A
Prefixo Prefixo da Tarifa de Compra, Ex.: 5511 SIM N/A
RateID Identificador da Tabela de Tarifas de Compra SIM N/A
Valor de Compra Valor de Compra SIM 0,00

Tela de Configurao de Tarifas de Compra

Gerenciamento Tarifas de Compra


Aqui possvel gerenciar as tarifas de compra com maior facilidade utilizando recursos
para sua manipulao, como importao, exportao e cpia.

Em Importar Tarifas de Compra possvel importar tarifas de compra a partir de uma


planilha excel, para isso necessrio baixar o template e preenche-lo. Para realizar a importao
necessrio preencher o provedor em que as tarifas sero importadas, depois clicar em Add e selecionar
o arquivo preenchido conforme modelo e clicar em Upload para finalizar a importao.

92
Em Exportao de Tarifas de Compra possvel exportar todas as tarifas de compra de um
rate id para um arquivo, seguindo mesmo padro usado na importao. Assim sendo possvel editar
as tarifas de um rate id inteiro mais facilmente e depois importar novamente para o sistema. Para
realizar a exportao necessrio selecionar o provedor e o rate id que ser exportado e clicar no
boto Exportar para CSV, depois aparecendo o arquivo na lista abaixo para download.

Em Copia de Tarifas de Compra possvel copiar todas as tarifas de compra de um rate id


inteiro para um novo rate id. Para executar a copia necessrio selecionar o provedor e rate id de
origem, que ser as tarifas copiadas, e preencher o provedor e rate id de destino, podendo o provedor
ser ou no o de origem e o rate id de destino obrigatoriamente tem que ser um no utilizado, depois
das informaes preenchidas preciso clicar em Copiar para executar a copia.

Verificar Inconsistncias
A ferramenta Verificar Inconsistncias permite analisar se existem tarifas tanto de venda
quanto de compra duplicadas no sistema. Com esta ferramenta possvel resolver as duplicidades do
sistema, selecionando a tarifa que ser mantida. Para usar a ferramenta devem-se seguir os seguintes
passos:

1. Selecione qual tipo de tarifa ser verificado no campo Verificar, compra ou venda;
2. Conforme o tipo de tarifa, selecione o Domnio ou Provedor que ser verificado;
3. Defina a quantidade de registros exibidos em Linhas por Pginas;
4. Clique no boto Verificar para exibir uma lista com as tarifas duplicadas
encontradas.

93
Na lista retornada de tarifas duplicadas possvel ver a quantidade de ocorrncias repetidas
para uma mesma tarifa juntamente com o seu Prefixo e Rate Id. Para resolver a duplicidade preciso
clicar no boto Resolver Inconsistncia para listar as tarifas duplicadas juntamente com suas
informaes.

Aps uma anlise das tarifas duplicadas e a deciso de qual tarifa ser mantida, deve-se clicar
no boto Clique aqui para manter esse registro da tarifa que ser mantida, assim as demais tarifas
sero apagadas, resolvendo essa inconsistncia. E assim deve ser feito sucessivamente at remover
todas as tarifas duplicadas no sistema.

94
Agrupamento de Contas
Em Agrupamento de Contas, possvel agrupar vrias contas para serem cobradas atravs de
um nico assinante (accountcode).

Por exemplo uma micro empresa que tenha 10 colaboradores em um mesmo departamento,
onde todas as contas devem ser agrupadas em uma nica conta do departamento.

95
17. Segurana
A plataforma SIPPulse um dos sistemas de telefonia mais seguros do mercado. Ele
implementa uma grande quantidade de recursos de segurana de forma a evitar ataques gerados por
terceiros e quebra de privacidade nas ligaes. Os dispositivos de segurana implantados sero
detalhados neste captulo. Abaixo segue um sumrio

1. Acesso com criptografia;


2. Proteo contra SIP Floods;
3. Proteo contra SIP replay Attacks;
4. Proteo contra pacotes mal-formados;
5. Descarte seletivo por assinatura;
6. Proteo contra DNS poisoning e Registration Poisoning;
7. Proteo contra mltiplas falhas de autenticao;
8. Autenticao por IP e Digest MD5;
9. Criptografia de sinalizao com TLS;
10. Criptografia de mdia com SRTP;
11. Integrao com LDAP;
12. Firewall para proteo a nvel de sistema operacional.

Acesso Criptografado
Os acessos ao sistema so todos criptografados tanto via interface de linha de comando SSH
quanto pela interface grfica HTTPS. Sugerimos utilizar uma das portas Ethernet de cada
equipamento para acesso pela VLAN de gerenciamento no permitindo o acesso pelas interfaces
dos telefones e gateways. Tudo isto configurado a nvel do sistema operacional durante a
instalao.

Proteo Contra Inundao de Requisies (SIP Flood)


O sistema utiliza um sistema de preveno de inundao de requisies atravs de um mdulo
interno. Este mdulo mantm uma lista de IPs internos com a quantidade de requisies por
segundo corrente. Este sistema parametrizvel e os seguintes parmetros esto disponveis.

Tempo de Amostragem: (Padro 10s);


Densidade de requisies por tempo de amostragem (Padro 500 ou 50 cps);
Latncia de remoo: Tempo em que o sistema ir permitir novas requisies (Padro:
120).

O sistema de preveno bloqueia por 120s as requisies de um IP suspeito aps mais de 500
requisies em 10s. Opcionalmente o sistema pode gerar um evento de segurana a cada incidente.
Gateways e sistemas autorizados por IP so excludos das verificaes.

Estes parmetros so definidos no arquivo defines.m4 e podem ser alterados mediante


solicitao ao suporte.

96
Proteo contra SIP Packet Replay Attack
Ataques com repetio (replay) de pacotes em SIP e HTTP so comuns. O sistema possui
um parmetro chamado nonce_expire que por padro est configurado para 30s. Nonces so
nmeros gerados uma vez (Number Once Nonce) que so usados como parte da criptografia de
autenticao. Aps a expirao do nonce o sistema vai requerer uma nova autenticao, evitando
assim que a repetio de uma autenticao possa ser usada.

Alm da expirao do nonce mantido tambm um ndice associado com cada nonce.
Apenas a expirao no suficiente por que ela permite que um ataque ocorra dentro de uma janela
de 30s. O ndice garante que o nonce poder ser usado apenas uma vez para autenticar. O tempo de
expirao no pode ser menor que o tempo de resposta para uma autenticao. O mecanismo no
pode ser implantado em clusters com DNS.

Proteo Contra Ataques por Pacotes Mal Formados


O SipPulse possui um sistema exclusivo de deteco de pacotes SIP mal formados. O sistema
detecta as seguintes malformaes alm de erros de leitura. Hoje o sistema verifica diversos itens
das requisies e pode gerar at 27 diferentes mensagens de erro em pacotes malformados.

1 - Mensagem Validada
-1 Sem mensagem SIP
-2 Erro de leitura no cabealho
-3 Sem cabealho Call-ID
-4 Sem Content-Length para transportes que o requerem ( eg. TCP )
-5 - Content-Length invlido
-6 Erro de leitura do corpo do SDP
-7 Sem Cseq
-8 - Sem From
-9 Sem To
-10 Sem Via
-11 Erro de leitura da Request URI
-12 Nome errado de host na R-URI.
-13 Sem Max-Forward
-14 Sem Contact.
-15 Uso de Path em pedido no Register
-16 Sem allow header no 405 reply.
-17 Sem Min-Expire header no 423 reply.
-18 Sem Proxy-Authorize header no 407 reply.
-19 Sem Unsupported header no 420 reply.
-20 Sem WWW-Authorize header no 401 reply.
-21 Sem Content-Type
-22 Erro de leitura no To
-23 Erro de leitura no From
-24 - hostname ruim no To header
-25 - hostname ruim no From header
-26 Erro de leitura no Contact header
-27 Erros indefinidos

97
Descarte Seletivo de Assinaturas Conhecidas
muito comum o uso do download de ferramentas para ataques a plataformas de telefonia. O
sistema detecta assinaturas conhecidas em ataques. Estas assinaturas so confidenciais, mas
daremos alguns exemplos abaixo.

Campo From com as origens 123, 321, 100, 111


Campo User-Agent com sipvicious,friendly-scanner
Magic number no campo VIA invlido

O Sistema automaticamente descarta pacotes com estas assinaturas.

Proteco contra DNS e Registration Poisoning


Estes ataques, tem como alvo os gateways para a rede pblica. A maioria dos usurios mesmo
aps estar autenticada no tem autorizao para fazer ligaes sensveis. Como por exemplo,
chamadas internacionais que passam pelos gateways. No entanto, estes mesmos usurios podem fazer
ligaes para outras empresas atravs de VoIP (Usando DNS) e tambm para outros usurios atravs
da tabela de localizao e registro de usurios. Os mecanismos de segurana contra estes ataques
possuem uma lista negra que criada automaticamente quando da criao do gateway. Esta lista negra
aplicada para qualquer sada via DNS ou tabela de localizao, bloqueando assim acessos no
autorizados. Esta proteo padro nos sistemas do SipPulse e no precisa ser configurada.

Proteo Contra Mltiplas Falhas de Autenticao


Uma das formas de conseguir um acesso no autorizado ao sistema um ataque que se chama
SIP Brute Force. Nestes ataques, o sistema recebe centenas de milhares de requisies de registro
testando diferentes senhas atravs de um dicionrio previamente carregado ou simplesmente
sequenciais. Possumos um mecanismo interno de segurana que aps a falha de autenticao
ocorrida por 20 vezes o sistema bloqueia o IP do atacante por uma hora, impedindo que o ataque por
fora bruta possa ter qualquer resultado positivo. O Sistema automtico e no requer configurao
do usurio. Como o usurio desbloqueado aps 60 minutos, no h necessidade de interveno
manual para o desbloqueio.

Sistema Anti-fraude para Chamadas Internacionais (Opcional)


O FPS um servio criado para prevenir chamadas fraudulentas em sistemas de telefonia.
Ele funciona verificando vrios atributos de uma chamada telefnica e configurado atravs de um
SIP Redirect. O servio cobrado por transao ou mensalidade e est disponvel para qualquer
sistema de telefonia IP avanado que possa fazer a consulta atravs de SIP redirect ou http.

O sistema anti-fraude funciona atravs da captao dos ataques em honeypots e a partir das
deteces dos prprios clientes em um sistema de crowdsourcing.

98
Fraudster

HoneyPots

Blacklist
Database
SIP
Restful
Redirect
Web Services
Services
Web SIP
Server Proxy

Corporate
PBXs
Service
Providers

O sistema antifraude funciona atravs de diversos mecanismos. Os trs primeiros mecnismos so


listas negras mantidas pelo prprio sistema como segue abaixo:

Lista negra por IP


Lista negra de nmeros discados
Lista negra de User-Agents.
O segundo passo a configurao da poltica de segurana na console do sistema TFPS. Aps o
login, o usurio poder configurar a sua poltica de segurana.

99
Configurao da Poltica de Segurana
Aps o login, voc pode configurar a poltica de segurana da sua empresa para a deteco
de ataques por comportamento.

A primeira parte definir e-mails para notificaes e o nome da poltica de configurao.

Em seguida, define-se os horrios no comerciais. Estes horrios so importantes na definio de


chamadas simultneas autorizadas e nmero mximo de chamadas por dia durante os horrios
comercial e no comercial.

Aps a definio dos horrios no comerciais so autorizados os pases de origem e destino


autorizados. Os usurios do sistema s podero ligar para pases autorizados e a partir de pases
especficos.

100
E finalmente possvel excluir ou incluir nmeros de destino no sistema.

Suporte a Criptografia e Chaves Digitais


A plataforma SIPPulse permite a configurao de criptografia e autenticao via TLS com
troca de chaves em 1024 bits e criptografia por AES de 128 e 256 bits. As configuraes dos
certificados esto fora do escopo deste guia do usurio e so feitas durante a instalao do sistema.
Os padres TLSv1 e TLS V1.2 esto disponveis tanto para criptografia como para autenticao.

A criptografia da mdia (udio, Vdeo e Texto) feita por Secure Real Time Protocol e fim
fim. A troca de chave pode ser dar por pre-shared Keys, pelo descritor da sesso (SDES) ou por
Diffi-Helmman no canal RTP (ZRTP). Existe suporte em todos os componentes fornecidos para TLS
e SRTP no modo SDES.

A autenticao tambm poder se dar por MD5 digest que a forma mais comum.

Display de senhas e armazenamento


Durante a digitao de senhas nas interfaces grficas e de linha de comando, as senhas no
aparecem quando digitadas. Nos bilhetes as senhas permitem identificar que usurios cobrar.

101
Suporte para LDAP
O sistema possui suporte para autenticao LDAP tanto para o acesso as interfaces WEB
quanto para autenticao dos telefones. O processo de habilitao do LDAP deve ser configurado
de comum acordo entre o cliente e a SipPulse. Alteraes no schema do diretrio LDAP so
necessrios para adicionar dois atributos SipUserName e SipPassword que vo conter o nome e a
senha dos telefones.

Como este processo bastante consultivo, favor consultar a empresa na contratao de


servios de integrao.

Protees Providas pelo Sistema Operacional


O sistema operacional atravs do firewall configurado previne os seguintes tipos de ataques
de DOS (Denial of Service).

Syn Flood
O Syn flood mitigado atravs da adio que feita durante a instalao das seguintes linhas na
configurao do firewall.

# iptables -A INPUT -m state state INVALID -j DROP


# /sbin/sysctl -w net/netfilter/nf_conntrack_tcp_loose=0

Gratuitious ARP
Os ARPs gratutos so usados em ataques contra telefonia IP que permitem a captura de
pacotes e consequente decodificao de conversaes atravs da rede. Normalmente a preveno a
este tipo de ataque feito nos switches Ethernet da rede atravs de um recurso, chamado DHCP
snooping, tambm chamado de ARP inspection.

A deteco destes ataques comum em plataformas de deteco de intruso.


Opcionalmente em caso de solicitao do cliente poderemos fazer a deteco de ARP gratuito nos
componentes de sistema. O sistema ir gera alertas nos logs do sistema em caso de ataque.

Apr 15 12:45:17 sippulse arpwatch: changed station 172.16.16.64 0:f0:b8:26:82:56 (d0:67:e5:c:9:67)


Apr 15 12:45:19 sippulse arpwatch: changed station 172.16.25.86 0:f0:b8:26:82:56 (0:d0:b7:23:72:45)
Apr 15 12:45:19 sippulse arpwatch: changed station 172.16.25.86 0:f0:b8:26:82:56 (0:d0:b7:23:72:45)
Apr 15 12:45:19 sippulse arpwatch: changed station 172.16.25.86 0:f0:b8:26:82:56 (0:d0:b7:23:72:45)
Apr 15 12:45:19 sippulse arpwatch: changed station 172.16.25.86 0:f0:b8:26:82:56 (0:d0:b7:23:72:45)

Ping Flood
Os pacotes de ICMP so completamente descartados em todos os itens da plataforma.

iptables -A INPUT -p icmp -m icmp --icmp-type address-mask-request -j DROP


iptables -A INPUT -p icmp -m icmp --icmp-type timestamp-request -j DROP

Oversized Packets, Unfragmented, SYN-FIN, SYN-RST, X-mas, nmap FIN,


NULLFlags
O sistema ainda protege de diversos outros ataques atravs de seu firewall.

102
#$ip -A INPUT -f -j DROP
# block oversized unfragmented packets
$ip -t raw -A PREROUTING -p icmp -m length --length 1492:65535 -j DROP
# defend against SYN-FIN, SYN-RST, X-Mas, nmap FIN, NULLflags and ALLflags attacks
$iptables -t raw -A PREROUTING -p tcp --tcp-flags FIN,SYN FIN,SYN -j DROP
$iptables -t raw -A PREROUTING -p tcp --tcp-flags SYN,RST SYN,RST -j DROP
$iptables -t raw -A PREROUTING -p tcp --tcp-flags FIN,SYN,RST,PSH,ACK,URG FIN,PSH,URG -j DROP
$iptables -t raw -A PREROUTING -p tcp --tcp-flags FIN,SYN,RST,PSH,ACK,URG FIN -j DROP
$iptables -t raw -A PREROUTING -p tcp --tcp-flags FIN,SYN,RST,PSH,ACK,URG NONE -j DROP
$iptables -t raw -A PREROUTING -p tcp --tcp-flags FIN,SYN,RST,PSH,ACK,URG
FIN,SYN,RST,PSH,ACK,URG -j DROP

Banimento de Port Scans


O Sistema tambm bane port scans.

# log and ban portscans


$iptables -A INPUT -m recent --name portscan --rcheck --seconds 86400 -j DROP
$iptables -A FORWARD -m recent --name portscan --rcheck --seconds 86400 -j DROP
$iptables -A INPUT -m recent --name portscan --remove
$iptables -A FORWARD -m recent --name portscan --remove
$iptables -A INPUT -p tcp -m tcp --dport 139 -m recent --name portscan --set -j LOG --log-prefix "Portscan:"
$iptables -A INPUT -p tcp -m tcp --dport 139 -m recent --name portscan --set -j DROP
$iptables -A FORWARD -p tcp -m tcp --dport 139 -m recent --name portscan --set -j LOG --log-prefix "Portscan:"
$iptables -A FORWARD -p tcp -m tcp --dport 139 -m recent --name portscan --set -j DROP

Finger of Death
O ataque ao servio Finger uma das formas de se perpetrar uma negao de servio
(DOS). Este ataque mitigado simplesmente bloqueado a porta 79. De qualquer forma o servio
Finger no est disponvel em nenhum dos componentes do sistema.

$iptables -A INPUT -j DROP -i eth0 -p tcp --dport 79 # finger

Gerencia de Redes
O SipPulse um sistema aberto que permite o gerenciamento atravs de diversos
aplicativos e protocolos. Voc pode gerenciar a disponibilidade, performance e falhas atravs:

De SNMP (Simple Network Management Protocol)


Do utilitrio Zabbix usando agentes
MONIT

Abaixo vamos detalhar como selecionar configurar e usar estes componentes de gerenciamento.

103
SNMP
O SNMP uma boa opo quando a empresa j possui e usa uma console de gerenciamento
como por exemplo, HP OpenView, Tivoli ou CA Unicenter. Alm do monitoramento do sistema
operacional que suporte SNMP verses 1, 2 e 3 alm de suporte as MIBs padro como MIB I e MIB
II o sistema possui algumas MIBs e alarmes proprietrios. A instalao e configurao do SNMP
opcional.

As MIBS proprietrias do SipPulse so:

SIPPULSE-MIB,
SIPPULSE-REG-MIB,
SIPPULSE-SIP-COMMON-MIB,
SIPPULSE-SIP-SERVER-MIB

Os escalares que mais interessam para a operao esto em negrito

sippulseSIPProtocolVersion,
sippulseSIPServiceStartTime,
sippulseSIPEntityType,
sippulseSIPSummaryInRequests,
sippulseSIPSummaryOutRequest,
sippulseSIPSummaryInResponses,
sippulseSIPSummaryOutResponses,
sippulseSIPSummaryTotalTransactions,
sippulseSIPCurrentTransactions,
sippulseSIPNumUnsupportedUris,
sippulseSIPNumUnsupportedMethods,
sippulseSIPOtherwiseDiscardedMsgs,
sippulseSIPProxyStatefulness
sippulseSIPProxyRecordRoute,
sippulseSIPProxyAuthMethod,
sippulseSIPNumProxyRequireFailures,
sippulseSIPRegMaxContactExpiryDuration,
sippulseSIPRegMaxUsers,
sippulseSIPRegCurrentUsers,
sippulseSIPRegDfltRegActiveInterval,
sippulseSIPRegAcceptedRegistrations,
sippulseSIPRegRejectedRegistrations,
sippulseMsgQueueDepth,
sippulseCurNumDialogs,
sippulseCurNumDialogsInProgress,
sippulseCurNumDialogsInSetup,
sippulseTotalNumFailedDialogSetups

104
Configurao de Alarmes
possvel configurar alarmes (TRAPS) dentro do sistema. Estes alarmes so configurados na
instalao usando o arquivo defines.m4. O sistema monitora duas condies de alarme:

Nmero de dilogos ativos


Profundidade da fila de entrada

Podem ser definidos limites principais (Major) e secundrios (Minor) para a gerao de
eventos.

Solicite ao suporte tcnico a configurao do SNMP segundo a sua plataforma de


gerenciamento. A uma srie de parmetros que precisam estar sincronizados para o perfeito
funcionamento da soluo como nome das comunidades, parmetros de conexo alarmes e
identificadores dos objetos.

105
18. Auditoria Sistmica
Em Auditoria Sistmica possvel visualizar o histrico de execues de todos os servios
do sistema, como tirar um relatrio, atualizar um assinante, criar um novo profile, etc. possvel
visualizar as informaes de quem executou, em que data e hora, qual foi o servio e mtodo
executados juntamente com tempo que levou para ser processado em milissegundos. Por padro s o
Administrador com perfil MASTER tem acesso a esse relatrio.

19.Backup da Plataforma
A plataforma SIPPulse Disponibiliza a retirada do Backup via SCP ou HTTP (caso nos seja
informado).

Esses arquivos podem ser retirados na pasta em /var/lib/sippulse/backup ou em


/home/suporte/backup. Nesse diretrio temos os backups referente aos 3 dias anteriores das databases
(sippulse, sippulse_reports e sippulse_transito para distros STFC), alm dos arquivos de
configurao do sistema.

Cabe ao administrador de operaes da plataforma fazer uma rotina de download automtico


do arquivo gerado todas as noites e armaneze-os em uma storage ou fita.

A extenso do arquivo gerado um tar.gz nesse formato Pulse-AAAA-MM-DD.tar.gz

Destacamos que esta rotina apenas apresenta os dados em formato que torna eficiente
seu armazenamento e recuperao em caso de falha. Para maior segurana, os dados salvos
devem ser armazenados em locais lgicos e fsicos diferentes daqueles onde se encontra a
operao e onde os dados foram gerados.

106
20. Integrao
A plataforma SIPPulse disponibiliza acesso a vrios servios atravs de WEBServices padro
SOAP (XML over HTTP). Atravs desta interface possvel integrar qualquer sistema utilizando a
maioria das linguagens de programao do mercado.

Alm desse acesso, a plataforma SIPPulse tambm disponibiliza um acesso a banco de dados
para recuperao de informaes j consolidadas em grandes volumes. Disponibilizamos view's dos
CDR's das chamadas e outras informaes.

Abaixo segue as especificaes dos servios disponveis na API de integrao.

DomainWS - Listar Domnios


Esta funo tem por objetivo listar os domnios ativos na plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DomainWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listDomains

Parmetros:

Parmetro Tipo Descrio Requerido

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Domain> Lista dos Domnios em que o administrador possui acesso para gerenciamento.

107
ProfileWS - Listar Profiles por Domnio
Esta funo tem por objetivo listar os profiles associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ProfileWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listProfilesByDomain

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Nome do domnio associado aos profiles. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Profile> Lista dos Profiles associados ao domnio.

SubscriberWS - Ativar Assinantes


Esta funo tem por objetivo ativar um assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateSubscriber

108
Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS - Desativar Assinantes


Esta funo tem por objetivo desativar um assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockSubscriber

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Ativar Notificao de Saldo Baixo


Esta funo tem por objetivo ativar o aviso de saldo baixo para um assinante dentro da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

109
IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateLowCreditNotification

Parmetros:

Parmetro Tipo Descrio Requerido

Username String Username do assinante. SIM

Domain String Domnio do assinante. SIM

lowCreditLimit Double Limite para saldo ser considerado baixo. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS - Desativar Notificao de Saldo Baixo


Esta funo tem por objetivo desativar o aviso de saldo baixo para um assinante dentro da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockLowCreditNotification

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

110
domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS - Ativar Chamadas Privadas


Esta funo tem por objetivo ativar o recurso de chamadas privadas de um assinante dentro
da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activatePrivacyCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS - Desativar Chamadas Privadas


Esta funo tem por objetivo desativar o recurso de chamadas privadas de um assinante
dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

111
Exemplo:

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

Operation Name: blockPrivacyCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Ativar Execuo de Chamadas


Esta funo tem por objetivo ativar a execuo de chamadas de um assinante dentro da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateOutgoingCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

112
SubscriberWS Desativar Execuo de Chamadas
Esta funo tem por objetivo desativar a execuo de chamadas de um assinante dentro da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockOutgoingCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Ativar Recebimento de Chamadas


Esta funo tem por objetivo ativar o recebimento de chamadas de um assinante dentro da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateIncommingCalls

Parmetros:

113
Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Desativar Recebimento de Chamadas


Esta funo tem por objetivo desativar o recebimento de chamadas de um assinante dentro
da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockIncommingCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Bloquear Chamadas a Cobrar


Esta funo tem por objetivo bloquear o recebimento de chamadas a cobrar para um
assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

114
IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockCollectCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Desbloquear Chamadas a Cobrar


Esta funo tem por objetivo desbloquear o recebimento de chamadas a cobrar para um
assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateCollectCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

115
principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM
sistema (descrito mais abaixo).

SubscriberWS Bloquear Chamadas Annimas


Esta funo tem por objetivo bloquear o recebimento de chamadas annimas para um
assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockAnonymousCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Desbloquear Chamadas Annimas


Esta funo tem por objetivo desbloquear o recebimento de chamadas annimas para um
assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateAnonymousCalls

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Ativar Ocultao de Topologia


Esta funo tem por objetivo ativar o recurso de ocultao de topologia para chamadas
realizadas por um assinante.

Nota: Este recurso no suportado para usurios com endereos atrs de NAT.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateTopologyHiding

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

117
SubscriberWS Bloquear Ocultao de Topologia
Esta funo tem por objetivo inativar o recurso de ocultao de topologia para chamadas
realizadas por um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockTopologyHiding

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Ativar Gerao de Estatsticas Dirias


Esta funo tem por objetivo ativar o recurso de gerao de estatsticas dirias de um
assinante. Estas estatsticas so apresentadas no dashboard do portal de administrao.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateDailyStatistics

Parmetros:

118
Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

SubscriberWS Bloquear Gerao de Estatsticas Dirias


Esta funo tem por objetivo bloquear o recurso de gerao de estatsticas dirias de um
assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockDailyStatistics

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

119
SubscriberWS - Adicionar Crditos para Assinantes
Esta funo tem por objetivo adicionar crditos na conta de um assinante

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: addCredit

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

value Double Valor do crdito que ser adicionado na conta do assinante. SIM

obs String Descrio da transao de incluso de crdito SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS - Incluir Novos Assinantes


Esta funo tem por objetivo incluir um assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertSubscriber

120
Parmetros:

Parmetro Tipo Descrio Req.

username String Username do assinante. SIM

domain String Domnio do assinante. (recuperar via servio DomainWS) SIM

password String Senha do assinante. SIM

profile String Perfil do Assinante no sistema. (recuperar via servio ProfileWS) SIM

rateplanId Integer Identificador do plano de tarifas do assinante. Caso no informado, o NO


sistema utilizar o plano associado ao profile.

emailAddress String Email do Assinante. SIM

contractNumber String Nmero de contrato do assinante. NO

firstName String Nome do Assinante. NO

lastName String Sobrenome do assinante. NO

document String Nmero do Documento do Assinante. NO

address String Endereo do Assinante. NO

number String Nmero do Endereo do Assinante. NO

complement String Complemento do Endereo do Assinante. NO

quarter String Bairro do Endereo do Assinante. NO

city String Cidade do Endereo do Assinante. NO

state String Estado do Endereo do Assinante. NO

zip String CEP do Endereo do Assinate. NO

phone String Telefone de Contato do Assinante. NO

mobile String Telefone Celular de Contato do Assinante. NO

121
countryCode String Cdigo do pas do Assinante. Ex. 55 (Brasil) SIM

areaCode String Cdigo de rea do Assinante. Ex. 11 (So Paulo) SIM

callLimit Integer Nmero de Chamadas simultnes que o Assinante poder executar. SIM
Ex. 1

voicemail boolean Flag para ativao do servio de correio de voz. Ex. 1 (Ativo) ou 0 SIM
(Inativo).

voicemailPassword String Senha para o servio de correio de voz. NO

resellerId Integer Identificador da revenda associada ao assinante, caso exista. NO

resellerBillingType Integer Tipo de Bilhetagem que a revenda aplicar na conta do assinante. NO


0: Marckup / 1: Plano de Tarifas. Valor Default 0.

resellerMarckup Double Quando a estratgia resellerBillingType=0, define-se o valor de NO


markup para as tarifas de venda. O markup aplicado ser com base no
valor das tarifas de compra. Valor Default 0.0.
resellerRateplanId Integer Quando a estratgia resellerBillingType=1, define-se o identificador NO
do plano de tarifas que a revenda aplicar nesta conta.

rpid String Nmero de Identificao para chamadas originadas pelo Assinante. NO

callFwd String Endereo sip para o servio siga-me. Ex.: sip:1000@sippulse.com NO

fwdBusy String Endereo sip para o servio siga-me quando ocupado. Ex.: NO
sip:1000@sippulse.com

noAnswer String Endereo sip para o servio siga-me quando no atende. Ex.: NO
sip:1000@sippulse.com

activeIncomingCalls boolean Define se o assinante estar habilitado para receber chamadas. NO


Default true.

activeOutgoingCalls boolean Define se o assinante estar habilitado para executar chamadas. NO


Default true.

blockCollectCalls boolean Define se o bloqueio de recebimento de chamadas ACOBRAR est NO


ativo. Default false. Mecanismo disponvel em distro STFC.

blockAnonymousCalls boolean Define se o bloqueio de recebimento de chamadas ACOBRAR est NO


ativo. Default false.

lowCreditNotification boolean Ativa o recurso de aviso de saldo baixo. Default False. NO


Mecanismo vlido para assinantes que possuem planos PR-PAGO.

lowCreditLimit double Valor mnimo de crdito para ativao do mecanismo de aviso. NO


Default 0.0.

Dados de Retorno:

122
Tipo Descrio

Integer Identificador do novo assinante gerado pelo sistema.

SubscriberWS - Alterao de Assinantes


Esta funo tem por objetivo alterar os dados de um assinante dentro da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateSubscriber

Parmetros:

Parmetro Tipo Descrio Req.

password String Senha do assinante. SIM

profile String Perfil do Assinante no sistema. (recuperar via servio ProfileWS) SIM

rateplanId Integer Identificador do plano de tarifas do assinante. Caso no informado, o NO


sistema utilizar o plano associado ao profile.

emailAddress String Email do Assinante. SIM

contractNumber String Nmero de contrato do assinante. NO

firstName String Nome do Assinante. NO

lastName String Sobrenome do assinante. NO

document String Nmero do Documento do Assinante. NO

address String Endereo do Assinante. NO

number String Nmero do Endereo do Assinante. NO

123
complement String Complemento do Endereo do Assinante. NO

quarter String Bairro do Endereo do Assinante. NO

city String Cidade do Endereo do Assinante. NO

state String Estado do Endereo do Assinante. NO

zip String CEP do Endereo do Assinate. NO

phone String Telefone de Contato do Assinante. NO

mobile String Telefone Celular de Contato do Assinante. NO

countryCode String Cdigo do pas do Assinante. Ex. 55 (Brasil) SIM

areaCode String Cdigo de rea do Assinante. Ex. 11 (So Paulo) SIM

callLimit Integer Nmero de Chamadas simultnes que o Assinante poder executar. SIM
Ex. 1

voicemail boolean Flag para ativao do servio de correio de voz. Ex. 1 (Ativo) ou 0 SIM
(Inativo).

voicemailPassword String Senha para o servio de correio de voz. NO

rpid String Nmero de Identificao para chamadas originadas pelo Assinante. NO

callFwd String Endereo sip para o servio siga-me. Ex.: sip:1000@sippulse.com NO

fwdBusy String Endereo sip para o servio siga-me quando ocupado. Ex.: NO
sip:1000@sippulse.com

noAnswer String Endereo sip para o servio siga-me quando no atende. Ex.: NO
sip:1000@sippulse.com

124
SubscriberWS - Consultar Saldo do Assinante
Esta funo tem por objetivo consultar saldo de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveCredit

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Double Saldo do assinante.

SubscriberWS - Trocar senha de Assinantes


Esta funo tem por objetivo trocar a senha de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: changePassword

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

actualPassword String Senha atual do assinante. SIM

newPassword String Nova senha a ser atribuda ao assinante. SIM

confirmNewPassword String Confirmao da nova senha. SIM

principal UserPrincial Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

SubscriberWS Trocar Profile do Assinante


Esta funo tem por objetivo trocar o profile de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: changeProfile

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

126
newProfileId Integer ID do Profile que ser definido para o assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS Remover Assinante


Esta funo tem por objetivo remover um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeSubscriber

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS Consultar Senha do Assinante


Esta funo tem por objetivo consultar senha de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrievePassword

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

String Senha atual do assinante.

SubscriberWS Recuperar Dados do Assinante


Esta funo tem por objetivo recuperar os dados de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveSubscriber

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do assinante. SIM

128
principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM
do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

SubscriberDTO Dados atuais do assinante.

SubscriberWS Alterao de Dados de Bilhetagem do Assinante


Esta funo tem por objetivo alterar os dados de bilhetagem de um assinante da
plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateSubscriberBillingInfo

Parmetros:

Parmetro Tipo Descrio Requerido

subscriber SubscriberBillingInfoDTO Objeto que contm os dados de bilhetagem (descrito SIM


mais abaixo).

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

SubscriberWS Alterao de Dados Classe V do Assinante


Esta funo tem por objetivo alterar os dados de Classe V de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

129
PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateSubscriberClassV

Parmetros:

Parmetro Tipo Descrio Requerido

subscriber SubscriberClassVDTO Objeto que contm os dados de Classe V (descrito SIM


mais abaixo).

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

SubscriberWS Alterao de Dados de Servios do Assinante


Esta funo tem por objetivo alterar os dados de Servios de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateSubscriberServices

Parmetros:

Parmetro Tipo Descrio Requerido

subscriber SubscriberServicesDTO Objeto que contm os dados de Servios (descrito SIM


mais abaixo).

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

SubscriberWS - Ativar Voicemail do Assinante


Esta funo tem por objetivo ativar o voicemail de um assinante.

130
URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: activateVoicemail

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do usurio. SIM

voicemailPassword Long Senha numrica do voicemail do assinante. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS - Desativar Voicemail do Assinante


Esta funo tem por objetivo desativar o voicemail de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: blockVoicemail

Parmetros:

Parmetro Tipo Descrio Requerido

131
username String Username do assinante. SIM

domain String Domnio do usurio. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS - Adicionar Alias de Assinante


Esta funo tem por objetivo adicionar um alias a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DBAliasesWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertDBAliases

Parmetros:

Parmetro Tipo Descrio Requerido

dbAliases DbAliases Contm os dados do alias de um assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Integer Identificador gerado pelo sistema.

SubscriberWS - Remover Alias de Assinante


Esta funo tem por objetivo remover um alias a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DBAliasesWS?wsdl

132
IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: deleteDBAliases

Parmetros:

Parmetro Tipo Descrio Requerido

dbAliasesId Integer Identificador do registro a ser excludo. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

SubscriberWS Recuperar Quota Diria


Esta funo tem por objetivo recuperar as informaes de quota diria de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveDailyQuota

Parmetros:

Parmetro Tipo Descrio Requerido

username String Username do assinante. SIM

domain String Domnio do Assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

Dados de Retorno:

133
Tipo Descrio

SubscriberDailyQuotaDTO Contm os dados de configurao e consumo atuais da quota diria de um de um


assinante.

SubscriberWS Alterar a Quota Diria


Esta funo tem por objetivo alterar as informaes de quota diria de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/SubscriberWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateDailyQuota

Parmetros:

Parmetro Tipo Descrio Requerido


username String Username do assinante. SIM

domain String Domnio do Assinante SIM

dailyQuota Boolean Flag que indica a ativao ou no do recurso SIM

dailyQuotaType String Tipo de controle de quota diria. Valores possveis: SIM


M: Limita a quota diria em minutos.
V: Limita a quota diria em valores.
dailyQuotaLimit Double Valor limite de uso dirio, com base no tipo definido acima. SIM

dailyQuotaConsumed Double Valor da quota consumido at o momento. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

134
DidWS - Incluso de DID's

Esta funo tem como objetivo incluir um novo DID associado a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertDid

Parmetros:

Parmetro Tipo Descrio Requerido

accountCode String Account Code do assinante que possui o Did. SIM

aliasUsername String Nmero do Did que ser utilizado na rede pblica. Ex: SIM
1130258080.

username String Usurio de destino de entrega da chamada ao Did. SIM

domain String Domnio de destino de entrega da chamada ao Did. SIM

monthlySubscription Double Valor da mensalidade do Did, caso exista. NO

reverseBilling Boolean Flag que ativa a bilhetagem reversa. Utilizado apenas para NO
nmeros 0800.

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Integer Identificador do novo registro gerado pelo sistema.

135
DidWS - Excluso de DID's

Esta funo tem como objetivo excluir um DID associado a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: deleteDid

Parmetros:

Parmetro Tipo Descrio Requerido

didId Integer Identificador do DID que ser excludo. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

DidWS - Listar DID's Associados a um Assinante


Esta funo tem como objetivo listar os DID's associados a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listByAcc

Parmetros:

Parmetro Tipo Descrio Requerido

136
accountCode String Account Code do assinante que possui o Did. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Did> Lista de DID's associados ao assinante.

DidWS - Listar DID's Disponveis


Esta funo tem como objetivo listar os DID's disponveis no sistema.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DidWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listAvailablesNumbers

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Domnio associado aos nmeros disponveis. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Did> Lista de DID's disponveis no sistema.

137
ResellerWS - Incluso de Revendas
Esta funo tem como objetivo incluir uma nova Revenda no sistema.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertReseller

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Domnio da revenda. SIM

name String Nome da Revenda SIM

manager String Nome do responsvel pela Revenda SIM

email String E-mail do responsvel pela Revenda. SIM

phone String Telefone do responsvel pela Revenda. NO

mobile String Telefone Mvel do responsvel pela Revenda. NO

username String Usurio de acesso ao portal de revendas. SIM

password String Senha de acesso ao portal das revendas. SIM

credit Double Valor do Crdito da Revenda (Planos Pr-pagos). Valor Default NO


ZERO.

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

138
Integer Identificador do novo registro gerado pelo sistema.

ResellerWS - Excluso de Revendas


Esta funo tem como objetivo excluir uma Revenda.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: deleteReseller

Parmetros:

Parmetro Tipo Descrio Requerido

resellerId Integer Identificador da Revenda que ser excluda. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

ResellerWS - Listar Revendas


Esta funo tem como objetivo listar as Revendas de um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listByDomain

Parmetros:

139
Parmetro Tipo Descrio Requerido

Domain String Domnio das revendas. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Reseller> Lista de Revendas associados ao domnio.

ResellerWS - Adicionar Crditos para Revendas


Esta funo tem por objetivo adicionar crditos na conta de uma revenda

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: addResellerCredit

Parmetros:

Parmetro Tipo Descrio Requerido

resellerName String Nome da Revenda. SIM

Domain String Domnio da Revenda. SIM

Value Double Valor do crdito que ser adicionado na conta da revenda. SIM

Obs String Descrio da transao de incluso de crdito SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

140
ResellerWS - Saldo da revenda
Esta funo tem por objetivo mostrar saldo de uma revenda

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/ResellerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveResellerCredit

Parmetros:

Parmetro Tipo Descrio Requerido

resellerId Integer Identificador da revenda. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador SIM


do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Double O valor do crdito da revenda.

141
WhitelistWS - Incluso de Whitelist
Esta funo tem como objetivo incluir um novo nmero na whitelist do assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertWhiteList

Parmetros:

Parmetro Tipo Descrio Requerido

username String Identificao do Assinante SIM

domain String Domnio do Assinante SIM

prefix String Nmero que ser cadastrado na whitelist SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Integer Identificador do novo registro gerado pelo sistema.

WhitelistWS - Excluso de WhiteList


Esta funo tem como objetivo excluir um nmero da lista whitelist do assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

142
Exemplo:

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

Operation Name: deleteWhiteList

Parmetros:

Parmetro Tipo Descrio Requerido

whiteListId Integer Identificador do WhiteList que ser excludo. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

WhitelistWS - Listar WhiteList


Esta funo tem como objetivo listar os WhiteList's associados a um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/WhiteListWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listWhiteList

Parmetros:

Parmetro Tipo Descrio Requerido

username String Identificao do assinante. SIM

domain String Domnio do assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

143
List<UserWhiteList> Lista de WhiteList's associados ao assinante.

RatePlanWS - Listar Plano de Tarifas por Domnio


Esta funo tem como objetivo listar o Plano de Tarifas associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listRatePlansByDomain

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Domnio do assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<RatePlan> Lista de RatePlan associados ao domnio.

RatePlanWS - Incluir Plano de Tarifas por Domnio


Esta funo tem como objetivo incluir um Plano de Tarifas associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

144
Exemplo:

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

Operation Name: insertRatePlan

Parmetros:

Parmetro Tipo Descrio Req.

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 SIM
comportamento de POS-PAGO. Default false.

txConnection Integer Taxa de Conexo que ser aplicada para a tarifao das chamadas. SIM
Valores entre 1-60 (em segundos). Default 60.

cadency Integer Cadncia que ser aplicada aps a Taxa de Conexo para a tarifao SIM
das chamadas. Valores entre 1-60 (em segundos). Default 60.

freeMinutes Integer Campo meramente informativo para calculo de franquias. Utilizado NO


por sistemas de CRM. Default 0.

markup double Taxa de Markup que ser aplicada na tabela de tarifas associada ao NO
plano. Default 0.0.

blockCallsWithoutRate boolean Flag que indica se o sistema ir bloquear a execuo de chamadas NO


para destinos sem uma tarifa de venda associada. Default false.

limitToCreditExpires Integer Limite de validade (em dias) para os crditos adicionados a uma NO
conta. Vlido apenas para planos PRE-PAGO. Default 0.

txDelay Integer Taxa de delay (em segundos) para inicio de calculo da NO


durao/abatimento de crditos de uma chamada. Ex. Delay = 3, a
chamada ser contabilizada somente aps o segundo 4. Default 0.
txDiscard Integer Taxa de descarte (em segundos). O sistema ir descartar as NO
chamadas com tempo igual ou inferior a taxa de descarte
configurada. As chamadas acima da taxa de descarte, sero tarifadas
com a durao total. Default 0.
principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM
sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio
RatePlan Retorna o plano de tarifas com o identificador nico gerado pelo sistema.

145
RatePlanWS - Alterar Plano de Tarifas por Domnio
Esta funo tem como objetivo alterar um Plano de Tarifas associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateRatePlan

Parmetros:

Parmetro Tipo Descrio Req.

id Integer Idenfificador unico 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

prepaid boolean Indica se o plano PRE-PAGO. Em caso negativo, o plano ter o SIM
comportamento de POS-PAGO. Default false.

txConnection Integer Taxa de Conexo que ser aplicada para a tarifao das chamadas. SIM
Valores entre 1-60 (em segundos). Default 60.

cadency Integer Cadncia que ser aplicada aps a Taxa de Conexo para a tarifao SIM
das chamadas. Valores entre 1-60 (em segundos). Default 60.

freeMinutes Integer Campo meramente informativo para calculo de franquias. Utilizado NO


por sistemas de CRM. Default 0.

markup double Taxa de Markup que ser aplicada na tabela de tarifas associada ao NO
plano. Default 0.0.

blockCallsWithoutRate boolean Flag que indica se o sistema ir bloquear a execuo de chamadas NO


para destinos sem uma tarifa de venda associada. Default false.

limitToCreditExpires Integer Limite de validade (em dias) para os crditos adicionados a uma NO
conta. Vlido apenas para planos PRE-PAGO. Default 0.

txDelay Integer Taxa de delay (em segundos) para inicio de calculo da NO


durao/abatimento de crditos de uma chamada. Ex. Delay = 3, a
chamada ser contabilizada somente aps o segundo 4. Default 0.

146
txDiscard Integer Taxa de descarte (em segundos). O sistema ir descartar as NO
chamadas com tempo igual ou inferior a taxa de descarte
configurada. As chamadas acima da taxa de descarte, sero tarifadas
com a durao total. Default 0.
principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM
sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

RatePlan Retorna o plano de tarifas atualizado.

RatePlanWS - Remover Plano de Tarifas por Domnio


Esta funo tem como objetivo remover um Plano de Tarifas associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RatePlanWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeRatePlan

Parmetros:

Parmetro Tipo Descrio Req.

id Integer Idenfificador unico do plano de tarifas SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um administrador do SIM


sistema (descrito mais abaixo).

147
RateWS - Listar Tarifas de Venda
Esta funo tem como objetivo listar as Tarifas de Venda de um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listRatesByParams

Parmetros:

Parmetro Tipo Descrio Requerido

Domain String Domnio das tarifas de venda. SIM

Descripion String Filtro pela descrio da tarifa. NO

RateId Integer Filtro pelo RateId da tarifa. NO

Prefix String Filtro pelo prefixo da tarifa. NO

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Rate> Lista de Tarifas de Venda encontradas no domnio.

RateWS Incluso de Tarifas de Venda


Esta funo tem como objetivo incluir novas Tarifas de Venda (em lote) em um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

148
PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: insertRates

Parmetros:

Parmetro Tipo Descrio Requerido

Rate List<RateDTO> Lista com as Tarifas de Venda que sero includas (descrito SIM
mais abaixo).

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

RateWS - Excluso de Tarifas de Venda


Esta funo tem como objetivo excluir uma Tarifa de Venda.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeRate

Parmetros:

Parmetro Tipo Descrio Requerido

RateId Integer Identificador da Tarifa de Venda que ser excluda. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

149
RateWS - Excluso de Tarifas de Venda por RateId
Esta funo tem como objetivo excluir todas as Tarifas de Venda associadas a um RateId.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/RateWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeAllRatesByRateId

Parmetros:

Parmetro Tipo Descrio Requerido

Domain String Domnio das Tarifas de Venda que sero excludas. SIM

RateId Integer RateId das Tarifas de Venda que sero excludas. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Integer Quantidade de Tarifas de Venda que foram excludas.

150
DialplanWS - Listar Plano de Discagem
Esta funo tem como objetivo listar o Plano de Discagem associado a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/DialplanWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listDialplansByDomain

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Domnio do assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Dialplan> Lista de Dialplan associados ao domnio.

AccountGroupWS - Adicionar Account Group


Esta funo tem como objetivo adicionar um Account Group.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: addAccountGroup

151
Parmetros:

Parmetro Tipo Descrio Requerido

accountManager String Account code da conta agrupadora. SIM

managerProfile String Profile da conta agrupadora. SIM

accounts List<String> Lista de Account codes que sero beneficiadas pelo SIM
agrupamento.

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

AccountGroupWS - Recuperar um Account Group


Esta funo tem como objetivo recuperar um Account Group.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveAccountGroup

Parmetros:

Parmetro Tipo Descrio Requerido

accountManager String Account code da conta agrupadora. SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

AccountGroup Contm os dados da conta agrupadora e das contas agrupadas.

152
AccountGroupWS - Remover Account Group
Esta funo tem como objetivo remover um Account Group.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AccountGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeAccountGroup

Parmetros:

Parmetro Tipo Descrio Requerido

accountManager String Account code da conta agrupadora. SIM

managerProfile String Profile da conta agrupadora. SIM

accounts List<String> Lista de Account codes que sero retiradas do agrupamento. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

CustomerWS - Autenticao de Assinantes


Esta funo tem como objetivo autenticar um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/CustomerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: authenticate

Parmetros:

153
Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Domnio do assinante na plataforma SIM

password String Senha de autenticao do assinante SIM

Dados de Retorno:

Tipo Descrio

SubscriberDTO Contm os dados da conta do assinante autenticado.

CustomerWS - Troca de Senha do Assinante


Esta funo tem como objetivo trocar a senha de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/CustomerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: changeCustomerPassword

Parmetros:

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Domnio do assinante na plataforma SIM

actualPassword String Senha atual de autenticao do assinante SIM

newPassword String Nova senha do assinante SIM

154
confirmNewPassword String Confirmao da nova senha do assinante SIM

CustomerWS - Crdito Atual do Assinante


Esta funo tem como objetivo recuperar o crdito atual de um assinante da plataforma.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/CustomerWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: retrieveCustomerCredit

Parmetros:

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

password String Senha de autenticao do assinante SIM

domain String Domnio do assinante na plataforma SIM

Dados de Retorno:

Tipo Descrio

Double valor atual do crdito do assinante

155
UserLocationWS - Listar Registros de um Assinante
Esta funo tem como objetivo listar os registros de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listUserLocations

Parmetros:

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Dominio do assinante SIM

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Location> Lista contendo os registros atuais do assinante.

UserLocationWS - Adicionar Registros Permanentes para um Assinante


Esta funo tem como objetivo adicionar um registro permanente para um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

156
http://sippulse.com:8080/SipPulse/UserLocationWS?wsdl

Operation Name: addUserLocation

Parmetros:

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Dominio do assinante SIM

contact String Endereo do registro do assinante. Ex.: SIM


sip:[username]@[ipaddress]:port

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

UserLocationWS - Remover Registros Permanentes para um Assinante


Esta funo tem como objetivo remover um registro permanente para um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/UserLocationWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeUserLocation

Parmetros:

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Dominio do assinante SIM

contact String Endereo do registro do assinante. Ex.: SIM


sip:[username]@[ipaddress]:port

principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

157
AddressWS Lista as Autenticaes por IP de um Assinante
Esta funo tem como objetivo listar as autenticaes por IP de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listAddresses

Parmetros:

Parmetro Tipo Descrio Requerido

Username String Login do assinante SIM

Domain String Dominio do assinante SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<Address> Lista contendo os dados de autenticao por IP de um assinante.

AddressWS Inserir Autenticaes por IP de um Assinante


Esta funo tem como objetivo inserir autenticaes por IP de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

158
http://sippulse.com:8080/SipPulse/AddressWS?wsdl

Operation Name: insertAddresses

Parmetros:

Parmetro Tipo Descrio Requerido

accountcode String Accountcode do assinante. Ex.: username@domain SIM

contextinfo String [no obrigatrio, gerado pelo sistema] NO

domain String Domnio do assinante SIM

group String [no obrigatrio, gerado pelo sistema] NO

Id Integer [no obrigatrio, gerado pelo sistema no evento de incluso] NO

ipAddress String endereo ip para autorizao SIM

mask Integer mscara que ser aplicada ao endereo ip,normalmente o valor SIM
32.

method String pode ser informado os seguintes valores [iponly, techprefix, SIM
ip+cpt, ip+cli]

pattern String [no obrigatrio, gerado pelo sistema no evento de incluso] NO

port Integer porta padro para autenticao, para liberar todas, informe o SIM
valor 0 (zero).

protocol String pode ser informado os seguintes valores [tcp, udp, tls, any] SIM
normalmente usa-se any.

username String Username do assinante SIM

techprefix String obrigatrio quando usa-se os methods techprefix e ip+cpt. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Address Contem o registro de autenticao por IP gerado no sistema.

159
AddressWS Alterar Autenticaes por IP de um Assinante
Esta funo tem como objetivo alterar autenticaes por IP de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: updateAddresses

Parmetros:

Parmetro Tipo Descrio Requerido

Accountcode String Accountcode do assinante. Ex.: username@domain SIM

Contextinfo String [no obrigatrio, gerado pelo sistema] NO

Domain String Domnio do assinante SIM

Group String [no obrigatrio, gerado pelo sistema] NO

Id Integer Identificador nico do registro, deve ser informado no momento SIM


da alterao

ipAddress String endereo ip para autorizao SIM

Mask Integer mscara que ser aplicada ao endereo ip,normalmente o valor SIM
32.

Method String pode ser informado os seguintes valores [iponly, techprefix, SIM
ip+cpt, ip+cli]

Pattern String [no obrigatrio, gerado pelo sistema no evento de incluso] NO

Port Integer porta padro para autenticao, para liberar todas, informe o SIM
valor 0 (zero).

Protocol String pode ser informado os seguintes valores [tcp, udp, tls, any] SIM
normalmente usa-se any.

Username String Username do assinante SIM

160
Techprefix String obrigatrio quando usa-se os methods techprefix e ip+cpt. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

Address Contem o registro de autenticao por IP atualizado pelo sistema.

AddressWS Excluir Autenticaes por IP de um Assinante


Esta funo tem como objetivo excluir autenticaes por IP de um assinante.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/AddressWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: removeAddresses

Parmetros:

Parmetro Tipo Descrio Requerido

domain String Domnio do registro de atuenticao por ip. SIM

Id Integer Identificador nico do registro. SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

161
HuntGroupWS Listar HuntGroups
Esta funo tem como objetivo listar os huntgroups associados a um domnio.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

Operation Name: listHuntGroups

Parmetros:

Parmetro Tipo Descrio Requerido

Domain String Dominio do assinante SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

List<HuntGroup> Lista contendo os huntgroups associados ao domnio informado.

HuntGroupWS Inserir HuntGroups


Esta funo tem como objetivo inserir um novo huntgroup no sistema.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

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

162
Operation Name: insertHuntGroups

Parmetros:

Parmetro Tipo Descrio Requerido

id Integer [No deve ser informado no momento da incluo, ser gerado NO


automaticamente pelo sistema]

domain String Dominio do assinante SIM

description String Nome do grupo SIM

groupList String Lista de usernames separados por ; (ponto e vrgula) que fazem SIM
parte do grupo
Ex.: joao;maria;jose
method String Tipo de distribuio das chamadas no grupo. SIM
paralell: Entrega as chamadas para todos os membros do grupo
de forma paralela.
serial: Entrega as chamadas para os membros do grupo de
forma seqencial, com base no timeout definido.
uri String [No deve ser informado no momento da incluo, ser gerado NO
automaticamente pelo sistema]

timeout Integer Tempo para execuo da entrega da chamada, com base na SIM
mtodo de entrega definido.

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

HuntGroup Retorna os dados do Huntgroup atualizado pelo sistema.

HuntGroupWS Alterar HuntGroups


Esta funo tem como objetivo alterar um huntgroup no sistema.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

Exemplo:

163
http://sippulse.com:8080/SipPulse/HuntGroupWS?wsdl

Operation Name: updateHuntGroups

Parmetros:

Parmetro Tipo Descrio Requerido

id Integer Dever ser informado no momento da alterao. SIM

domain String Dominio do assinante SIM

description String Nome do grupo SIM

groupList String Lista de usernames separados por ; (ponto e vrgula) que fazem SIM
parte do grupo
Ex.: joao;maria;jose
method String Tipo de distribuio das chamadas no grupo. SIM
paralell: Entrega as chamadas para todos os membros do grupo
de forma paralela.
serial: Entrega as chamadas para os membros do grupo de
forma seqencial, com base no timeout definido.
uri String [No deve ser informado no momento da incluo, ser gerado NO
automaticamente pelo sistema]

timeout Integer Tempo para execuo da entrega da chamada, com base na SIM
mtodo de entrega definido.

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

Dados de Retorno:

Tipo Descrio

HuntGroup Retorna os dados do Huntgroup atualizado pelo sistema.

HuntGroupWS Excluir HuntGroups


Esta funo tem como objetivo excluir um huntgroup no sistema.

URL Descritiva do Servio:

http://<IP_SERVER>:<PORT>/SipPulse/HuntGroupWS?wsdl

IP_SERVER: Endereo do servidor que hospeda o sistema.

PORT: Porta de acesso ao servio. Geralmente utilizamos a porta 8080.

164
Exemplo:

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

Operation Name: removeHuntGroup

Parmetros:

Parmetro Tipo Descrio Requerido

id Integer Dever ser informado no momento da excluso. SIM

domain String Dominio do assinante SIM

Principal UserPrincipal Objeto que contm as credenciais de acesso de um SIM


administrador do sistema (descrito mais abaixo).

UserPrincipal

Este objeto representa as credenciais de um administrador vlido para o sistema.


Todo servio exposto para integrao requisitar esta informao. Com base no principal
informado, o sistema validar suas credenciais, alm de verificar se o mesmo tem acesso de
administrao para o domnio informado.

Atributos

Parmetro Tipo Descrio 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 servio que atualiza as informaes do mesmo.

Atributos

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Domnio do assinante na plataforma SIM

165
contractNumber String Nmero de contrato do assinante NO

firstName String Nome NO

lastName String Sobrenome NO

document String CPF/CNPJ NO

address String Endereo NO

number String Nmero NO

complement String Complemento NO

quarter String Bairro NO

city String Cidade NO

state String Estado NO

zip String CEP NO

phone Long Telefone NO

mobile Long Celular NO

SubscriberClassVDTO

Este objeto representa os dados de Classe V de um assinante do sistema, sendo utilizado no


servio que atualiza as informaes do mesmo.

Atributos

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Domnio do assinante na plataforma SIM

callFwd String Siga-me NO

166
fwdBusy String Siga-me ocupado NO

noAnswer String Siga-me No Atende NO

callGroup Integer Call Group NO

pickupGroup String Pickup Group NO

pinCode String Cdigo PIN do assinante NO

bossSecretary String Servio Chefe/Secretria NO

SubscriberServicesDTO

Este objeto representa os dados referentes aos atributos de servios de um assinante do


sistema, sendo utilizado no servio que atualiza as informaes do mesmo.

Atributos

Parmetro Tipo Descrio Requerido

username String Login do assinante SIM

domain String Domnio do assinante na plataforma SIM

email String E-mail NO

countryCode String Cdigo do Pas NO

areaCode String Cdigo de rea NO

cityCode String Cdigo da Localidade NO

localArea String Sigla da Localidade NO

rpid String Id da Chamada NO

callLimit Integer Chamadas Simultneas NO

cps Int Chamadas por Segundo NO

167
keepAlive Int Keep Alive NO

RateDTO

Este objeto representa uma Tarifa de Venda do sistema.

Atributos

Parmetro Tipo Descrio Requerido

domain String Domnio a qual pertence Tarifa de Venda. SIM

name String Descrio 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 Ligao da Tarifa. NO

168
21. Transaes Aninhadas
O mdulo de integrao SOAP da plataforma SIPPulse oferece o suporte a transaes
aninhadas. Isso serve para que o sistema oferea o recurso de two-phase-commit em transaes
iniciadas por outros sistemas, utilizando o protocolo XA.

Para que isso ocorra, o sistema que inicia a transao dever controlar todos os servios
chamados, conforme exemplo abaixo:

SIPPulse

Application Transaction System A


Client Coordinator

System B

O componente Transaction Coodinator ser o responsvel por iniciar as transaes, e com


base no resultado do processamentos ele ir confirmar (commit) ou abortar (rollback) as operaes.

22. Acesso a Views do Sistema

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

Sugerimos que os acessos a volumes grandes de dados sejam feitos fora dos horrios de
pico para evitar perda de performance no ambiente.

Acessando View vi_cdrs

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

Obtendo os dados do usurio de integrao de acesso a base de dados, ser possvel executar
consultas a essa view e recuperar os bilhetes gerados pelo sistema.

Exemplo de Consulta Filtrando por Assinante, Servio e Perodo:

SELECT * FROM vi_cdrs


WHERE accountcode = '600002@sippulse.com'

169
AND service = 'pstn'
AND call_start_time BETWEEN '2012-10-01 00:00:00' AND '2012-10-05 23:59:59';

O resultado da execuo de uma consulta na vi_cdrs, retornar os campos listados abaixo:

Campos

Campo Tipo Descrio Exemplo

id (PK) bigint Identificador do registro auto_increment

call_start_time datetime Data do incio 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) Domnio 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 dilogo

sip_from_tag varchar(255) Tag gerada para marcar o originador da chamada.

sip_to_tag varchar(255) Tag gerada para marcar o destinatrio da chamada.

duration varchar(255) Tempo da durao da chamada em segundos. 45


127

rate double Tarifa de venda aplicada para a chamada. 0.18


0.197

price double Preo 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 servio da chamada executada. 0800, acobrar, timeout,


local, net, pstn, did.

rateplan_name varchar(64) Nome do plano de tarifas usado para tarifar a PR-BRONZE


chamada. PS-OURO

rateplan_tx_con int(11) Taxa de Conexo do plano de tarifas usado para tarifar 30


n a chamada. 60

rateplan_caden int(11) Cadncia do plano de tarifas usado para tarifar a 1


cy chamada. 6

170
rateplan_marku double Markup do plano de tarifas usado para tarifar a 10
p chamada. 20.5

rateplan_prepai tinyint(1) Indica se o plano de tarifas PR ou PS pago. 0 0


d para ps-pago e 1 para pr-pago. 1

rateplan_rateid int(11) RateId do plano de tarifas usado para tarifar a 20000


chamada. 30000

reseller_id int(11) Identificador da revenda a qual o assinante est NULL


associado. Se o valor estiver NULL, o assinante no 1
est associado a nenhuma revenda.
reseller_name varchar(64) Nome da revenda a qual o assinante est associado. Se NULL
o valor estiver NULL, o assinante no est associado a Revenda ACME
nenhuma revenda.
reseller_ratepla int(11) Identificador do plano de tarifas da revenda usado 2000
n_id para tarifar a chamada. 3000

reseller_ratepla varchar(64) Nome do plano de tarifas da revenda usado para PR-BRONZE


n_name tarifas a chamada. PS-OURO

reseller_marku double Markup do plano de tarifas da revenda usado para 10


p tarifar a chamada. 20.5

reseller_ratepla int(11) RateId do plano de tarifas da revenda usado para 20000


n_rateid tarifar a chamada. 30000

gwid int(10) Identificador do gateway por onde a chamada foi 12001


executada.

gw_address varchar(64) Endereo IP do gateway por onde a chamada foi 201.64.23.11


executada.

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 20000


executou a chamada. 30000

providerid int(11) Identificador do provedor associado ao gateway que 2


executou a chamada.

provider_name varchar(64) Nome do provedor associado ao gateway que OperadoraSul


executou a chamada. OperadoraNorte

provider_tx_co int(11) Taxa de Conexo do provedor associado ao gateway 30


nn que executou a chamada. 60

provider_caden int(11) Cadncia do provedor associado ao gateway que 1


cy executou a chamada. 6

profile varchar(20) Profile ao qual o assinante est associado. DEFAULT

user_agent varchar(64) User Agent usado na execuo da chamada. Blink 0.2.7 (Windows)

src_ip varchar(15) Endereo IP do originador da chamada. 189.4.123.226

171
matched_prefix varchar(20) Prefixo da tarifa de venda usada para a tarifao. 5511

matched_prefix varchar(128) Nome da tarifa de venda usada para a tarifao. SAO PAULO FIXO
_name

reseller_rate double Mesma descrio dos outros campos com nome igual. 0.15
reseller_price double S que esses campos so associados a uma revenda 1.25
reseller_matche varchar(20) quanto o assinante est em uma revenda. 5517
d_prefix varchar(128) RIO DE JANEIRO
reseller_matche
d_prefix_name
cost double Tarifa de custo aplicada para a chamada. 0.23

cost_price double Custo total de compra da chamada. 0.86

Acessando Tabela Acc

O SIPPulse disponibiliza acesso aos bilhetes de chamada no completadas com a causa


detalhada do processamento

Obtendo os dados do usurio de integrao de acesso a base de dados, ser possvel executar
consultas a essa tabela e recuperar os bilhetes gerados pelo sistema.

Exemplo de Consulta Filtrando por Assinante, Servio e Perodo:

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 execuo de uma consulta na tabela acc, retornar os campos listados abaixo:

Campos

Campo Tipo Descrio Exemplo

id (PK) bigint Identificador do registro auto_increment

time datetime Data do incio da chamada. 2012-03-24 09:27:20


yyyy-MM-dd HH:mm:ss

sip_code varchar(3) cdigo de retorno da transao SIP. 408

sip_reason varchar(32) mensagem de retorno da transao SIP. Request Timeout

172
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) Domnio 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 dilogo

from_tag varchar(255) Tag gerada para marcar o originador da chamada.

to_tag varchar(255) Tag gerada para marcar o destinatrio da chamada.

accountcode varchar(128) Accountcode do assinante que executou a chamada. 600002@sippulse.com

service varchar(32) Tipo de servio da chamada executada. 0800, acobrar, timeout,


local, net, pstn, did.

gwid int(10) Identificador do gateway por onde a chamada foi 12001


executada.

profile varchar(20) Profile ao qual o assinante est associado. DEFAULT

user_agent varchat(64) User Agent usado na execuo da chamada. Blink 0.2.7 (Windows)

src_ip varchar(15) Endereo IP do originador da chamada. 189.4.123.226

poippi_origem varchar(10) Ponto de demarcao de origem do entroncamento


(DETRAF). Somente verso STFC.

poippi_destino varchar(10) Ponto de demarcao de destino do entroncamento


(DETRAF). Somente verso STFC.

eot_origem varchar(3) EOT de origem de entroncamento (DETRAF).


Somente verso STFC.

eot_destino varchar(3) EOT de destino de demarcao de entroncamento


(DETRAF). Somente verso STFC.

direction varchar(8) Direo da Chamada. Somente verso STFC. inbound/outbound

descritor varchar(5) Descritor da Chamada. Somente verso STFC.

173

Anda mungkin juga menyukai