# Integração VoIP - SipPulse

## Introdução
A integração do sistema com VoIP SipPulse estabelece uma comunicação eficiente utilizando a tecnologia **Voice over Internet Protocol (VoIP)**. A integração otimiza a infraestrutura de comunicação, reduzindo custos e aumentando a flexibilidade dos serviços de voz. Ao aproveitar as redes de dados existentes para tráfego de voz, a integração VoIP SipPulse oferece uma alternativa eficiente às soluções de telefonia tradicionais, permitindo a gestão de recursos avançados de comunicação e melhor gerenciamento de chamadas diretamente pelo sistema IXC Soft.

>[!TIP] **VoIP SipPulse**
>A [SipPulse](https://sippulse.com/) é uma plataforma que oferece soluções de telecomunicações para empresas, especialmente aquelas que utilizam VoIP (telefonia pela internet). Ela inclui ferramentas para gerenciar e otimizar chamadas telefônicas, além de garantir a segurança e o controle das operações.

- **VoIP:** o termo **Voice over Internet Protocol** define uma tecnologia que permite a transmissão de chamadas de voz pela internet ou por redes de dados baseadas em IP, em vez de utilizar linhas telefônicas tradicionais.

> [!NOTA] **Acesso à Configuração**
> **Caminho:** Configurações > Integrações VOIP > SipPulse

## Entrega de Valor
- **Centralização de Dados e Processos**: Integra a telefonia fixa ao ERP, unificando informações de clientes, serviços e faturamento em um único sistema, facilitando a gestão de dados.
- **Diversificação do Portfólio de Serviços**: Expande as opções de serviços, permitindo que as empresas ofereçam pacotes combinados de internet e telefonia fixa.
- **Faturamento Integrado**: Facilita o faturamento conjunto dos serviços de internet e telefonia fixa, simplificando o processo financeiro e garantindo maior precisão.
- **Análise Abrangente do Negócio**: Oferece uma visão completa do desempenho do negócio, incluindo métricas detalhadas de telefonia e gestão contratual, o que auxilia na tomada de decisões mais informadas.
- **Controle de Uso e Relatórios de Ligações**: Possibilita a emissão de relatórios detalhados sobre as ligações realizadas, proporcionando maior controle e monitoramento do uso do serviço de telefonia.

## Configuração da Integração
### Cadastro da Integração
Neste passo, é efetuado o cadastro da integração. Este processo permite a comunicação e troca de dados entre o sistema e a plataforma SipPulse.

1. No menu principal, navegue até **Configurações**;
2. Selecione **Integrações**;
3. Clique em **Integrações VOIP**;
4. Pressione o botão **Novo**;
5. No campo **Descrição**, insira uma breve descrição para a identificação da plataforma;
6. Marque o campo **Ativo** para definir a integração como **ativa**, e em uso;
7. No campo **Gateway**, selecione a opção **SipPulse**;
8. Insira as informações fornecidas pela SipPulse nos campos:
	- **URL Acesso**: Campo para inserir o endereço da URL necessária para acessar o serviço ou gateway.
	- **Usuário acesso**: Nome de usuário para autenticação no serviço.
	- **Senha acesso**: Senha associada ao nome de usuário para o acesso.
	- **Nome view SipPulse**: Nome da visualização específica para integração com o SipPulse.
	- **Servidor banco**: Endereço do servidor de banco de dados utilizado para armazenar as informações.
	- **Porta banco**: Porta de conexão para o banco de dados.
	- **Nome banco**: Nome do banco de dados.
	- **Usuário banco**: Nome de usuário para autenticação no banco de dados.
	- **Senha banco**: Senha do usuário para autenticação no banco de dados.
	
9. Clique em **Salvar** para validar a criação da integração e concluir o cadastro;

>[!CAUTION] Credenciais:
>Todos os dados de integração são fornecidos pela plataforma SipPulse.

## Funcionalidades Principais
- Estabelece a comunicação entre o sistema e a plataforma SipPulse, permitindo o gerenciamento do módulo de telefonia diretamente pelo sistema IXC. Este processo permite a sincronização de configurações entre SipPulse e o sistema;
- Criação e gerenciamento de ramais SIP;
- Controle de contrato de internet e telefonia pelo IXC;
- Controle de acesso das linhas/Ramais SIP pelo IXC;
- Integração com planos e grupos do SipPulse;
- Definição de limites de crédito por ramal.

## Casos de Uso

### 1. Criação de [[range de numeros cadastrados|Range de Números Cadastrados]]
A range de números pode ser utilizada para realizar o controle dos números fornecidos pela operadora. A partir do cadastro da Range de Números, o sistema apresenta todos os números de um determinado período, dos quais foram disponibilizados pela operadora, e seus respectivos status de uso, se **Disponível** ou se **Em uso**, facilitando a organização de disponibilidade de números aos clientes.

>[!CAUTION] Atenção:
>Caso opte por não trabalhar com Range de Números, não será possível realizar o controle de status de números pelo sistema. 

1. Acesse o formulário de **[[range de numeros cadastrados|Range de Números Cadastrados]]** através do caminho: Sistema > Plataforma VoIP > Configurações > Range de números cadastrados;
2. . Clique sobre o botão **Novo** e preencha os campos conforme apresentados:
	- **Nome:** descrição da range, facilitando sua localização e organização;
	- **DDI + DDD:** defina o DDI e o DDD padrão dos números de telefonia fixa;
	- **Numeração inicial:** insira o número inicial da numeração da range, determinando o início do período;
	- **Numeração final:** insira o número final da numeração da range, determinando o final do período;
	- **Cancelamento automático VSC:** **Campo específico para uso da integração VSC**. Ao utilizar a integração com a plataforma SaperX v2, este parâmetro pode ser desconsiderado.
	  
3. Clique em **Salvar** para validar e finalizar a criação da range.

### 2. [[criacao de ramal sip - sippulse|Criação de Ramal SIP - SipPulse]]
Para realizar o cadastro de um ramal SIP, siga os passos a seguir:

1. Acesse o formulário **[[aba linha sip - contrato do cliente|Aba Linha SIP - Contrato do Cliente]]** através do caminho: Sistema > Cadastros > Contratos > Aba Linha SIP;
2. Na aba Linha SIP, clique no botão **Novo**;
3. Preencha o campo **Plano de Cobrança** caso trabalhe com cobrança por consumo ou cobrança de excedentes;
4. No campo **Integração**, clique na lupa e selecione a integração de VoIP da plataforma SipPulse;
5. Preencha os demais campos:
	- **Bid Type:** Defina se o tipo da linha será terminal ou se será trunk (tronco SIP);
	- **Descrição:** Campo de preenchimento opcional. Insira uma descrição para o ramal;
	- **Código da conta:** Campo de preenchimento opcional. Pode ser utilizado para identificação do ramal na plataforma, inserindo o callingcard de 6 dígitos;
	- **Número para binagem:** Clique no botão **Listar** e insira o número de binagem que deseja fornecer ao cliente;
	- **Ramal:** Campo de preenchimento opcional. Insira o Ramal do número;
	- **Ativo:** Defina o consumo do ramal através deste status. Para o Ramal iniciar o consumo, marque como **Ativo**;
	
6. Acesse a aba **Configuração Summit** e preencha os campos:
	- **Partição assinante:** Ao ter cadastrado as [[particoes summit|Partições Summit]], elas estarão disponíveis neste campo a partir de um botão de seleção. Clique no botão e selecione a partição correspondente ao Ramal que está sendo ativado;
	- **Categoria:** Ao ter cadastrado as [[categorias summit|Categorias Summit]], elas estarão disponíveis neste campo a partir de um botão de seleção. Clique no botão e selecione a categoria correspondente;
	- **Plano:** Clique no botão **Buscar plano** e selecione o plano de consumo deste ramal;
	- **Data ativação:** Insira a data da qual o ramal está sendo ativado;
	- **Vencimento:** Indique a data do mês em que a franquia de consumo é reiniciada (1-25);
	- **Centro custo Summit:** Ao ter cadastrado o [[centro de custo summit|Centro de Custo Summit]], ele estará disponível para ser relacionado ao ramal em sua ativação. Clique na lupa e selecione o dado correspondente;
	- **Limite chamadas:** Insira o limite de chamadas simultâneas;
	- **Licença:** Ao ter cadastrado as [[licencas summit|Licenças Summit]], elas ficarão disponíveis neste parâmetro a partir de um botão de seleção. Clique no botão e selecione a licença correspondente;
	  
	  **Campos de preenchimento automático**
	  - **Terminal:** Retorno da plataforma SipPulse ao ter recebido a requisição de ativação do ramal;
	  - **Credential:** Retorno da plataforma SipPulse ao ter recebido a requisição de ativação do ramal;
	
	
7. Para relacionar DIDs ao Ramal, acesse a aba **DIDs**. Clique no botão **Novo** e preencha os campos:
	- **Número de binagem:** através do campo Número de binagem, define-se o número do cliente. Clique no botão **Listar** para relacionar um número ao cliente;
	- **Prioridade:** Insira a prioridade das chamadas;
	- **Porta:** Insira a porta que receberá as ligações. Ao informar o número 1, será direcionado ao ramal principal, ao informar outro número, será criada uma porta na Summit para que este DID receba as ligações através dela. Caso não seja informado uma porta, o número não receberá ligações.
	
	**Campos preenchidos automaticamente**
	- **Terminal:** Retorno da plataforma SipPulse ao ter recebido a requisição de ativação do ramal;
	- **Credential:** Retorno da plataforma SipPulse ao ter recebido a requisição de ativação do ramal;
	- **Cidade:** campo preenchido automaticamente com a cidade do contrato do cliente.
	
8. **Clique em Salvar** para validar a criação do ramal SIP.

### 3. Cadastro da [[tarefa - importar ligacoes sippulse|Tarefa - Importar Ligações SipPulse]]
Ao trabalhar com a importação de ligações e cobrança de excedentes, é necessário realizar o cadastro da tarefa de importação de ligações para a integração VoIP SipPulse. Para realizar este procedimento, siga os passos a seguir:

1. Acesse o formulário de **Agenda de tarefas** através do caminho: Ferramentas > Ferramentas > Agenda de tarefas;
2. Clique no botão **Novo** para cadastrar a tarefa;
3. No campo **Tarefa**, selecione a opção **Importar ligações VoIP**;
4. Preencha o horário em que a tarefa executará a partir dos campos de Minuto e Hora. No campo **Minuto**, indique o minuto em que a tarefa executará, correlacionando ao campo de hora. No campo **Hora**, indique o horário em que a tarefa executará;
   
> **Exemplo:** para que uma tarefa execute as 7h30, insira o número 7 no campo **Hora** e o número 30 no campo **Minuto**.

5. Na seção **Dia do mês**, insira no campo **Valor** o intervalo que desejar para que o sistema execute a tarefa em dias específicos. Marque a opção **Todos** para a tarefa executar todos os dias do mês (irá respeitar o intervalo de semana caso não deva executar todos os dias);
6. Na seção **Mês**, marque a opção **Todos** para a tarefa executar todos os meses;
7. Na seção **Dia da semana**, insira no campo **Valor** o intervalo que desejar, indicando que a tarefa irá executar em dias específicos. Exemplo: 1-5 (segunda à sexta-feira). Para que o sistema execute a tarefa todos os dias da semana, marque a opção **Todos**;
5. Após preencher os campos, clique em **Salvar** para validar a criação da tarefa.

>[!INFO] **Dia da semana:** 
>Para a importação mensal, o sistema considerará o dia da semana em que o dia do mês selecionado ocorrer. Exemplo: caso selecione o dia 1 do mês e marcar "Todos" para o dia da semana, a tarefa ocorrerá no dia 1 de cada mês, independentemente de ser uma segunda-feira, terça-feira, etc.

Após a configuração da tarefa, ela seguirá executando automaticamente e irá identificar os clientes que possuem ligações a serem importadas e as registra no [[registro de chamadas (cdr)|Registro de Chamadas (CDR)]], no módulo de **Plataforma VoIP**.

### 4. Geração do Serviço Adicional de Telefonia
O sistema permite realizar a geração de um serviço adicional no contrato do cliente ao trabalhar com a cobrança dos valores excedentes de ligações efetuadas fora do plano de telefonia contratado.

>[!TIP] Guia instrutivo:
>Para acessar o material sobre como realizar a geração do adicional de telefonia, acesse: [[geracao do adicional de telefonia - filtros voip|Geração do Adicional de Telefonia - Filtros VoIP]].


## Fluxo de Trabalho
```mermaid
graph TD
    A[Credenciamento da Plataforma] --> B[Cadastro da Integração no Sistema]
    B --> C[Criação de Range de Números]
    C --> D[Criação de Perfil VoIP]
    D --> E[Ativação de Linhas]
    E --> F[Importar Ligações]
    F --> G[Cadastro de Tarefa]
    G --> H[Faturamento]
    H --> I[Controle de Acesso]

```

## Considerações Finais
A integração VOIP SipPulse oferece uma solução robusta para unificar a telefonia IP com o Sistema. Ao configurar corretamente os perfis e ramais, é possível aproveitar todos os recursos de VOIP do SipPulse de forma integrada.

## Etiquetas
#Integracoes #IntegracaoVoIP #VOIP #SummitNetworks 

## Leia Também
- [[integracoes|Integrações]]
- [[integracoes de telefonia fixa - voip|Integrações de Telefonia Fixa - VoIP]]
- [[criacao de ramal sip - sippulse|Criação de Ramal SIP - SipPulse]]
- [[tarefa - importar ligacoes sippulse|Tarefa - Importar Ligações SipPulse]]
- [[aba linha sip - contrato do cliente|Aba Linha SIP - Contrato do Cliente]]
- [[ramal sip|Ramal SIP]]
- [[plano de cobranca - voip|Plano de cobrança - VoIP]]
- [[geracao do adicional de telefonia - filtros voip|Geração do Adicional de Telefonia - Filtros VoIP]]
- [[relatorio voip ligacoes|Relatório VoIP Ligações]]