# Integração VoIP - SaperX v2

## Introdução
A integração do sistema com VoIP SaperX v2 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 SaperX v2 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] **SaperX v2**
>A [SaperX](https://saperx.com.br/) é uma empresa brasileira especializada em oferecer soluções de telefonia para empresas de forma simples e intuitiva. Seus serviços, como PABX Virtuais e VoIP, visam facilitar a gestão de telefonia corporativa, tornando-a mais eficiente e econômica

- **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 > SaperX v2

## 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 SaperX v2.

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 **SaperX v2**;
8. Insira as informações fornecidas pela SaperX v2 nos campos:
	- **Ambiente:** Escolha o ambiente da integração. Ao marcar como **Produção**, define o método de integração para operações em ambiente real. Ao marcar como **Homologação**, define o método de integração de testes e validações antes da produção. Para um ambiente em Homologação, é necessário que a SaperX repasse as informações acerca deste método.
	- **Cobrar somente ramais ativos:** Se marcado como **sim**, o sistema realiza a cobrança a partir da rotina de [[geracao do adicional de telefonia - filtros voip|Geração do Adicional de Telefonia - Filtros VoIP]] para ramais com o status **Ativo**. Se marcado como **não**, o sistema não valida o status do ramal para gerar o serviço adicional, ou seja, gera o serviço independente do status do ramal;
	- **Período de Importação CDR**: Define a frequência de importação dos registros de chamadas, podendo ser diária ou mensal;
	- **URL Acesso:** Endereço do serviço ou API para conexão e integração.
    - **Usuário Acesso:** Nome de usuário necessário para autenticação na API ou serviço.
	- **Senha Acesso:** Senha correspondente ao usuário de acesso configurado.
	- **API Key:** Chave de API para autenticação segura no serviço.
    - **API Secret:** Código secreto complementar à chave de API para autenticação.
      
    **Campos preenchidos automaticamente:**
    - **Token Acesso:** Token de acesso gerado automaticamente para autenticação no sistema;
    - **Refresh Token:** utilizado em conjunto com o Token Acesso, que por sua vez, possui um tempo de vida limitado devido à fatores de segurança. O Refresh Token é usado para renovar o acesso ao serviço sem a necessidade de realizar uma nova autenticação.
    
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 SaperX v2.

## Funcionalidades Principais
- Estabelece a comunicação entre o sistema e a plataforma SaperX v2, permitindo o gerenciamento do módulo de telefonia diretamente pelo sistema IXC. Este processo permite a sincronização de configurações entre SaperX v2 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 SaperX v2;
- 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 uso da Range de Números, o sistema apresenta todos os números do período 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 SaperX v2:** **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 - saperx v2|Criação de Ramal SIP - SaperX v2]]
O cadastro do Ramal SIP no sistema consiste na criação de uma linha telefônica, definindo suas características e limitações específicas para uso do cliente. Essa configuração personalizada assegura que a linha telefônica atenda às necessidades do cliente e às políticas de serviço do provedor, otimizando o controle e a gestão do serviço de telefonia VoIP.

Para criar uma linha SIP utilizando a [[integracao voip - saperx v2|Integração VoIP - SaperX v2]], 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 SaperX v2;
5. Preencha os demais campos:
	- **Código da conta:** campo de preenchimento opcional. Pode ser preenchido com 6 dígitos. Caso não seja preenchido manualmente, o sistema preencherá automaticamente com a informação disponível na SaperX;
	- **Tipo linha SIP:** defina se o ramal será uma portabilidade ou não, caso seja portabilidade utilize a opção Portabilidade Entrada;
	- **Senha:** clique no botão **Gerar senha** para gerar uma senha ao Ramal;
	- **Ativo:** filtro para habilitar a ativação do Ramal ou para inativá-lo.

7. Acesse a aba **Configurações adicionais** e no campo **Limite de ligações simultâneas**, defina o limite de quantidade das ligações simultâneas que a linha pode ter;
8. Acesse a aba **Configuração SaperX** e preencha os demais campos apresentados:
	#### **Campos principais:**
	- **Plano id:** clique no botão **Buscar plano** para selecionar o plano de telefonia do ramal. Os planos são cadastrados diretamente na plataforma;
	- **Plano Internacional:** para utilizar um plano de consumo internacional, clique no botão **Buscar plano internacional** e selecione o plano correspondente;
	- **Dia do fechamento da fatura:** define o dia de fechamento da fatura no ramal do cliente;
	- **Plano descrição:** campo preenchido automaticamente ao salvar o cadastro do ramal;
	- **Tipo:** defina o tipo de cobrança no ramal do cliente (pré-pago ou pós-pago);
	- **Plano tipo:** defina a rota do ramal, se será SCM, STFC ou personalizado;
	- **Bina:** defina se a bina será **Ativa** ou **Inativa**;
	- **LC:** indique se o ramal terá permissão para ligações locais;
	- **LDN:** indique se o ramal terá permissão para ligações locais;
	- **LDI**;
	- **Libera ramal VC1;**
	- **Libera ramal VC2**;
	- **Libera ramal VC3**;
	  
8. Acesse a aba **DIDs** para cadastrar um DID ao ramal SIP. Clique no botão **Novo** e preencha o campo:
	- **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;
	- **Cidade:** campo preenchido automaticamente.
	  
9. Clique em **Salvar** para validar a criação do ramal SIP.

>[!SUCCESS] Ativação:
>Após salvar a linha, ela já estará ativa. Os dados são então sincronizados simultaneamente no sistema e na plataforma SaperX v2, portanto, a linha coexiste em ambos os sistemas a partir da comunicação estabelecida pela integração.


### 3. Cadastro da [[tarefa - importar ligacoes voip|Tarefa - Importar ligações VoIP]]
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 SaperX v2. Para realizar este procedimento, siga os passos a seguir:

>[!TIP] **Atenção:** 
>A rotina deve ser configurada **de acordo com a forma de importação definida dentro da integração**.  <br>
>- Caso a importação seja **mensal**, a rotina precisa ser executada apenas 1 vez no mês;  
>- Caso a rotina seja **diária**, a rotina precisa ser executada todos os dias.

1. Acesse o formulário de **[[agenda de tarefas|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 SaperX v2**;
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 SaperX v2 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 SaperX v2 de forma integrada.

## Etiquetas
#Integracoes #IntegracaoVoIP #VOIP #PerfilVoIP #RangeDeNumeros

## Leia Também
- [[integracoes|Integrações]]
- [[integracao voip - saperx v2|Integração VoIP - SaperX v2]]
- [[criacao de ramal sip - saperx v2|Criação de Ramal SIP - SaperX v2]]
- [[tarefa - importar ligacoes voip|Tarefa - Importar ligações VoIP]]
- [[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]]