# Integração VoIP - VSC

## Introdução

>[!tip] Atenção!
>Este conteúdo está presente na **versão [[clientes beta ixc soft|Beta]]** do sistema.
>A disponibilidade desta integração na **versão Estável** será a partir de Abril de 2025.

---

>[!TIP] **VSC**
>A [VSC](https://www.voipgroup.com/produtos/softswitch-VSC-plataforma-voip-billing-voip-para-operadoras-STFC-e-SCM) (VoIP SoftSwitch) é uma plataforma de software avançada para gerenciamento de redes de telefonia VoIP, oferecendo controle centralizado de chamadas, flexibilidade e escalabilidade.

A integração do sistema com VoIP VSC 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 VSC 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.

- **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 > VSC

## 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 VSC. Esse processo é essencial para disponibilizar recursos como: criação de range de números, ativação de ramal SIP, geração do serviço adicional de telefonia, entre outras. Para realizar o cadastro da integração, siga os passos a seguir:

1. Acesse o formulário [[integracoes de telefonia fixa - voip|Integrações de Telefonia Fixa - VoIP]] através do caminho: Configurações > Integrações > Integrações VoIP;
2. Pressione o botão **Novo** para registrar os dados API da integração;
3. No campo **Descrição**, insira uma breve descrição para a identificação da plataforma;
4. Marque o campo **Ativo** para definir a integração como **ativa**, e em uso;
5. No campo **Gateway**, selecione a opção **VSC**;
6. Insira as informações fornecidas pela VSC nos campos:
	- **Período de Importação CDR**: Define a frequência de importação dos registros de chamadas, podendo ser diária ou mensal;
	- **Gerar adicional de telefonia excedente:**
		- **Por tempo de ligação:** ao trabalhar com a cobrança de excedentes, é possível realizar a cobrança através do valor da franquia em minutos. Para realizar este processo, marque este parâmetro;
		- **Por ligação:** na modalidade por ligação, as chamadas são importadas com os valores previamente definidos na VSC, gerando um serviço adicional exclusivo para os excedentes. Para realizar a cobrança nesta modalidade, marque este parâmetro.
		  
	- **URL de Acesso:** Insira a URL do serviço que será acessado para realizar a integração;
	- **Distri ID:** Informe o identificador único fornecido pela VSC;
	- **Distri Password:** Insira a senha correspondente ao ID fornecido pela VSC;
	- **Usuário de Acesso:** Informe o nome de usuário utilizado para autenticação no sistema;
    - **Senha de Acesso:** Insira a senha correspondente ao usuário informado;
    - **Rota WS Ligações VSC:** insira o caminho da rota do serviço web utilizado para a integração com a VSC.
      
7. 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 VSC.

>[!SUCCESS] Finalização:
>Após concluir o cadastro da integração com a plataforma Interede, é possível avançar para as demais configurações, ajustando-as conforme as necessidades e métodos de trabalho da empresa. Essas configurações permitem uma gestão eficiente dos serviços e recursos fornecidos pela operadora, incluindo funcionalidades importantes como: cadastro de range de números para o controle de números fornecidos pela operadora, cadastro de produto de telefonia fixa, ativação do ramal SIP, geração do adicional de telefonia e importação das ligações. 
><br>
>Essas configurações são essenciais para aproveitar ao máximo os recursos da integração, assegurando um gerenciamento eficiente, centralizado e alinhado às demandas operacionais. Ajuste cada etapa conforme os requisitos específicos de sua operação para otimizar os serviços prestados aos clientes. 


## Casos de Uso

>[!quote] Casos de Uso
>Os casos de uso apresentados neste documento são ferramentas e recursos que se tornam disponíveis a partir do cadastro da integração VoIP. Cada funcionalidade foi projetada para oferecer maior controle, flexibilidade e eficiência na gestão dos serviços de telefonia, permitindo que sua operação atenda às necessidades específicas da empresa e de seus clientes.
><br>
>É importante que você avalie cuidadosamente o seu método de trabalho e os objetivos da sua operação para determinar a melhor forma de utilizar estes recursos. Considere as seguintes diretrizes ao planejar o uso das ferramentas:

### 1. Configuração de [[perfil voip - vsc|Perfil VoIP - VSC]]
O **Perfil VoIP** permite a definição de parâmetros específicos para cada ramal a partir de uma configuração padrão. Essa função tem como objetivo padronizar as **configurações** dos **ramais**, para que, ao realizar a criação do ramal SIP no sistema, seja possível inserir um perfil padrão pré-estabelecido, com as informações pré definidas das configurações do ramal.

Para realizar o cadastro do perfil, siga os passos:

1. Acesse o formulário de [[configuracao para criacao de ramal (perfil voip)|Configuração para Criação de Ramal (Perfil VoIP)]] através do caminho: Sistema > Plataforma VoIP  > Configurações > Configuração para Criação de Ramal;
3. Selecione o botão **Novo**;
4. Preencha o campo de **Nome** para a identificação do perfil;
5. No campo **Gateway**, selecione a opção **VSC**;
6. Preencha os demais campos dinâmicos, descritos a seguir, que são liberados ao selecionar o gateway:
	- **Allow Collect Calls:** marcar caso queira permitir coletar as chamadas;
	- **Remove Country Code:** marcar caso queira remover o código do país (DDI);
	- **IDD Prefix:** insira o prefixo para discagem direta internacional;
    - **NDD Prefix:** insira o prefixo para discagem direta nacional;
    - **Inbound Calls Limit:** neste campo poderá definir a quantidade de chamadas entrantes;
    - **Outbound Calls Limit:** neste campo poderá definir a quantidade de chamadas saintes;
    -  **User code:** campo opcional. Ao clicar no botão **Listar**, pode selecionar um número de binagem previamente cadastrado através da [[range de numeros cadastrados|Range de Números Cadastrados]]. Caso não preencher este campo, será preenchido automaticamente com o ID do ramal na plataforma da VSC;
	- **Billing:** método de faturamento aplicado ao ramal.
	- **Recharge Settings:** configuração de recarga automática: **Sim** ou **Não**;
	- **Dia da Recarga Padrão:** dia fixo para a recarga automática. 
	
7. Após finalizar o preenchimento dos campos que julgar necessário, clique em **Salvar** para validar e finalizar a criação do perfil VoIP.

### 2. 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 VSC:** **Campo específico para uso da integração VSC**. Preencha a quantidade de dias de inativação do número após o cancelamento do contrato.
	  
3. Clique em **Salvar** para validar e finalizar a criação da range.

### 3. [[criacao de ramal sip - vsc|Criação de Ramal SIP - VSC]]
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.
#### Cadastro da [[tarefa - importar batches vsc|Tarefa - Importar Batches VSC]]
A tarefa **Importar Batches VSC** é uma funcionalidade para empresas que utilizam a [[integracao voip - vsc|Integração VoIP - VSC]], de telefonia fixa, no sistema. Esta tarefa permite realizar a importação dos **Batches** (planos) para criação de [[ramal sip|Ramal SIP]] no sistema. Para realizar a configuração da tarefa, siga os passos abaixo:

>[!NOTE] Importante:
> Os batches devem ser criados na plataforma da VSC para que posteriormente sejam importados ao IXC. Em caso de dúvidas relacionadas à geração dos batches na plataforma, entre em contato com o suporte da VSC.

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 Batches VSC**;
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á;
   
>[!quote] **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.
6. Selecione a tarefa e clique no botão **Executar tarefa** para iniciar a importação dos planos para o sistema.
#### Cadastro do Ramal SIP
A partir do cadastro e execução da [[tarefa - importar batches vsc|Tarefa - Importar Batches VSC]], é possível prosseguir com a ativação da linha com os planos importados. Para criar uma linha SIP utilizando a [[integracao voip - vsc|Integração VoIP - VSC]], 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 VSC;
5. Preencha os demais campos:
	- **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;
	- **Perfil VoIP:** selecione um [[perfil voip - vsc|Perfil VoIP - VSC]] previamente configurado, para que a aba **Configuração VSC** seja preenchida automaticamente;
	- **Ativo:** filtro para habilitar a ativação do Ramal ou para inativá-lo.

6. Acesse a aba **Configurações adicionais** e no campo **Use Area Code**, defina se o uso do código de áea é obrigatório para todas as ligações;
7. Acesse a aba **Configuração VSC** e preencha os demais campos apresentados (caso não utilize o [[perfil voip - vsc|Perfil VoIP - VSC]]):
	#### **Campos principais:**
	- **ID Batch:** preenchido automaticamente ao selecionar o plano do ramal;
	- **Batch:** clique no botão **Buscar batch** para selecionar o plano do ramal;
	- **DDI:** insira o código de discagem direta internacional (DDI), isto é, o código utilizado para fazer ligações para outros países;
	- **DDD:** insira o código de discagem direta à distância, isto é, o código para discagem interurbana regional;
	- **Allow Collect Calls:** marcar caso queira permitir coletar as chamadas;
	- **Remove Country Code:** marcar caso queira remover o código do país (DDI);
	- **IDD Prefix:** insira o prefixo para discagem direta internacional;
    - **NDD Prefix:** insira o prefixo para discagem direta nacional;
    - **Inbound Calls Limit:** neste campo poderá definir a quantidade de chamadas entrantes;
    - **Outbound Calls Limit:** neste campo poderá definir a quantidade de chamadas saintes;
    -  **User code:** campo opcional. Ao clicar no botão **Listar**, pode selecionar um número de binagem previamente cadastrado através da [[range de numeros cadastrados|Range de Números Cadastrados]]. Caso não preencher este campo, será preenchido automaticamente com o ID do ramal na plataforma da VSC;
    -  **Billing:** método de faturamento aplicado ao ramal.
	- **Recharge Settings:** configuração de recarga automática: **Sim** ou **Não**;
	- **Dia da Recarga Padrão:** dia fixo para a recarga automática. 
	  
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 VSC, portanto, a linha coexiste em ambos os sistemas a partir da comunicação estabelecida pela integração.


### 4. Cadastro da [[tarefa - importar ligacoes vsc|Tarefa - Importar Ligações VSC]]
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 VSC. 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** 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 VSC**;
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**.

### 5. 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]].

## Funcionalidades Principais
- Estabelece a comunicação entre o sistema e a plataforma VSC, permitindo o gerenciamento do módulo de telefonia diretamente pelo sistema IXC. Este processo permite a sincronização de configurações entre VSC 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 VSC;
- Definição de limites de crédito por ramal.

## 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 VSC 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 VSC de forma integrada.

## Etiquetas
#Integracoes #IntegracaoVoIP #VOIP #VSC

## Leia Também
- [[integracoes|Integrações]]
- [[integracao voip - vsc|Integração VoIP - VSC]]
- [[perfil voip - vsc|Perfil VoIP - VSC]]
- [[criacao de ramal sip - vsc|Criação de Ramal SIP - VSC]]
- [[tarefa - importar ligacoes vsc|Tarefa - Importar Ligações VSC]]
- [[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]]
- [[tarefa - importar batches vsc|Tarefa - Importar Batches VSC]]