# Integração VoIP - Interede

## Introdução

>[!TIP] **Interede**
>A Interede é uma plataforma de software avançada desenvolvida para o gerenciamento de redes de telefonia VoIP. O sistema oferece controle centralizado de chamadas, flexibilidade operacional e escalabilidade, permitindo uma gestão eficiente das comunicações telefônicas.

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

## 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 Interede. 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. No campo **Gateway**, selecione a opção **Interede**;
5. Marque o campo **Ativo** para definir a integração como **ativa**, e em uso;
6. Insira as informações fornecidas pela Interede 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;
	- **URL de Acesso:** Insira a URL do serviço que será acessado para realizar a integração;
	- **Dia de corte:** Insira um dia fixo do qual será utilizado como parâmetro para a importação de ligações. Caso este campo estiver vazio, o sistema considera a data atual;
	- **API Key:** Insira a chave API fornecida pela plataforma Interede para estabelecer a comunicação com a plataforma;
	- **Token acesso:** Insira o token de acesso fornecido pela plataforma;
	- **ID Revenda:** ID do provedor cadastrado na plataforma da Interede;
	- **ID Perfil:** ID do perfil financeiro cadastrado na plataforma Interede;
	- **ID Vendedor:** ID do vendedor cadastrado na plataforma Interede;
	- **ID da Moeda:** ID da modela utilizada na plataforma (real, dolar, entre outras);
	- **ID plano:** Insira o ID do plano utilizado na plataforma.
      
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 Interede.

>[!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. 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 Interede:** **Campo específico para uso da integração Interede**. 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.

### 2. [[criacao de ramal sip - interede|Criação de Ramal SIP - Interede]]
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 - interede|Integração VoIP - Interede]], 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 Interede;
5. Preencha os demais campos:
	- **Descrição:** campo de preenchimento opcional, permite inserir uma breve descrição para o ramal;
	- **Número para binagem:** clique no botão **Listar** para selecionar um número de binagem da [[range de numeros cadastrados|Range de Números Cadastrados]] ou insira manualmente;
	- **Senha:** clique no botão **Gerar senha** para gerar uma senha ao Ramal;
	- **ID plano:** insira o ID do plano de telefonia cadastrado na Interede correspondente o plano que o ramal terá acesso para o consumo;
	- **ID Origem:** insira o ID da origem cadastrado na Interede correspondente o plano que o ramal terá acesso para o consumo;
	- **ID Vínculo:** insira o ID de vínculo cadastrado na Interede correspondente o plano que o ramal terá acesso para o consumo;
	- **Ativo:** filtro para habilitar a ativação do Ramal ou para inativá-lo.
	  
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 Interede, 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 Interede. 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 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á;
   
>[!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.

>[!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]].

### Troca de Linha para Contrato do Mesmo Cliente
A plataforma permite realizar ajustes de contratos diferentes em uma linha SIP, desde que os contratos pertençam ao **mesmo cliente**. Para efetuar essa alteração, siga as etapas abaixo:

1. Acesse o formulário de [[ramal sip x clientes|Ramal SIP - Clientes]] pelo seguinte caminho: **Sistema > Plataforma VoIP > Ramais > Ramal SIP - Clientes**;
2. Selecione o ramal SIP que deseja ajustar e clique em **Editar**;
3. No campo **Contrato**, clique na lupa e escolha o segundo contrato do mesmo cliente associado à linha selecionada;
4. Após vincular o contrato ao campo correspondente, clique em **Salvar** para confirmar as alterações.

## Funcionalidades Principais
- Estabelece a comunicação entre o sistema e a plataforma Interede, permitindo o gerenciamento do módulo de telefonia diretamente pelo sistema IXC. Este processo permite a sincronização de configurações entre Interede 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 Interede;
- 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 Interede 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 Interede de forma integrada.

## Etiquetas
#Integracoes #IntegracoesVoIP #IntegracaoVoIPInterede #VOIP #Interede

## Leia Também
- [[integracoes|Integrações]]
- [[integracao voip - interede|Integração VoIP - Interede]]
- [[guias tutoriais/integracoes gerais/tutorial voip/cadastro de ramais - integracoes/criacao de ramal sip - interede|public/Guias Tutoriais/Integrações Gerais/Tutorial VoIP/Cadastro de Ramais - Integrações/Criação de Ramal SIP - Interede]]
- [[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]]