# Gateway SMS (Beta)

## 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] **Definição - Gateway SMS:**
>Um **gateway SMS** é um serviço de telecomunicações que facilita o envio e recebimento de mensagens de texto (SMS) entre diversos dispositivos. Atua como intermediário entre redes móveis, permitindo que organizações integrem comunicações SMS em suas operações. As principais características deste serviço incluem envio em massa, integração com outros sistemas, programação de envios, personalização de mensagens e geração de relatórios. Os gateways SMS são utilizados para notificações, marketing e comunicações internas, oferecendo alcance global e medidas de segurança. Esta tecnologia é fundamental para empresas que buscam comunicação eficiente e direcionada com clientes e equipes.

A funcionalidade de uso de **Gateway SMS** no sistema possibilita aos usuários configurar e enviar mensagens de texto (SMS) para clientes e colaboradores através de diversos provedores de SMS. Esta integração permite a personalização eficiente do conteúdo das mensagens, assegurando uma comunicação direta e precisa. Os usuários podem selecionar o gateway mais adequado, customizar as mensagens conforme necessário e gerenciar o envio de forma centralizada, otimizando assim a eficácia da comunicação via SMS.

> [!Nota] **Acesso ao Formulário:**
> **Caminho:**  Configurações > Integrações > Gateways SMS

### Requisitos de Uso
Para utilizar a integração de **Gateway SMS** no sistema, é necessário realizar o credenciamento em uma das plataformas compatíveis com o IXC. As plataformas disponíveis incluem:

>[!EXAMPLE] Gateways SMS compatíveis:
>- [[gateway sms - centralvox|Gateway SMS - Centralvox]]
>- [[gateway sms - clickatell|Gateway SMS - Clickatell]]
>- [[gateway sms - dinstar|Gateway SMS - Dinstar]]
>- [[menu configuracoes/integracoes/gateways sms/gateway sms - disparo pro|Gateway SMS - Disparo Pro]]
>- [[gateway sms - eai|Gateway SMS - EAI]]
>- [[gateway sms - easy send sms|Gateway SMS - Easy Send SMS]] 
>- [[gateway sms - goip|Gateway SMS - Gammu]]
>- [[gateway sms - goip|Gateway SMS - Goip]]
>- [[gateway sms - hotmobile|Gateway SMS - Hotmobile]]
>- [[gateway sms - infobip|Gateway SMS - Infobip]]
>- [[gateway sms - interede|Gateway SMS - Interede]]
>- [[gateway sms - khal sms|Gateway SMS - Khal SMS]]
>- [[gateway sms - khal painel 2|Gateway SMS - Khal Painel 2]]
>- [[gateway sms - lulisms|Gateway SMS - LuliSms]]
>- [[gateway sms - mikrotik|Gateway SMS - Mikrotik]]
>- [[gateway sms - openvox|Gateway SMS - OpenVox]]
>- [[public/menu configuracoes/integracoes/gateways sms/gateway sms - playsms/index|Gateway SMS - PlaySMS]]
>- [[gateway sms - send2u|Gateway SMS - Send2U]]
>- [[gateway sms - super1way|Gateway SMS - Super1Way]]
>- [[gateway sms - torpedus|Gateway SMS - Torpedus]]
>- [[gateway sms - tww|Gateway SMS - TWW]]
>- [[gateway sms - uservoz|Gateway SMS - UserVoz]]
>- [[gateway sms - uservoz 2|Gateway SMS - Uservoz 2]]
>- [[gateway sms - vero|Gateway SMS - Vero]]
>- [[gateway sms - witime|Gateway SMS - Witime]]
>- [[menu configuracoes/integracoes/gateways sms/gateway sms - zenvia|Gateway SMS - Zenvia]]

## Entrega de Valor
- **Comunicação Instantânea**: Permite o envio rápido de informações importantes aos clientes;
- **Alcance Amplo**: As mensagens SMS têm alta taxa de abertura, garantindo que a informação chegue ao destinatário;
- **Automação de Processos**: Permite a automação de envio de mensagens e reduz a necessidade de intervenção manual no envio de notificações recorrentes.
- **Flexibilidade**: Permite personalização de mensagens para diferentes segmentos de clientes.

## Estrutura do Formulário
O formulário de **Gateways SMS** está estruturado em uma grid, que reúne as informações de todos os Gateways cadastrados. Esta grid está organizada em linhas e colunas e cada registro individual corresponde ao mesmo formulário que armazena os detalhes da integração. O formulário está estruturado em uma aba principal: **Gateway SMS**.

### Aba Gateway SMS
A aba Gateway SMS apresenta os campos essenciais para configurar a integração do provedor no sistema. Esta funcionalidade atua como intermediária para o envio de SMS. As configurações incluem a seleção do gateway específico e campos para inserção dos dados de autenticação necessários. Estes parâmetros visam estabelecer uma comunicação segura com o gateway, permitindo o disparo de mensagens SMS diretamente através do sistema."

#### Campos Principais

| Campo                                 | Descrição                                                                                                                                                                                                               |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ID**                                | Identificador único para o registro, gerado automaticamente pelo sistema.                                                                                                                                               |
| **Gateway**                           | Menu suspenso que exibe os provedores de SMS compatíveis com o sistema. Esta seleção permite ao usuário escolher o gateway específico para integração.                                                                  |
| **Descrição**                         | Define uma descrição breve ao cadastro do gateway para identificações internas.                                                                                                                                         |
| **Adicionar mensagens à fila**        | Permite utilizar a ferramenta de [[aba (fila sms) na mensagem sms - master abril 2025\|fila de SMS]] para disparos através do [[relatorio de clientes]] e [[rotina de cobranca (crm de cobranca)\|Rotina de Cobrança]]. |
| **Utiliza shortcode**                 | Permite habilitar aredução de caracteres em mensagens. No sistema shortcode somente é permitido enviar até 140 carecteres na mensagem.                                                                                  |
| **Remover caracteres especiais**      | Permite remover ou manter habilitado o uso de caracteres especiais no envio de mensagens de SMS.                                                                                                                        |
| **Quant. máxima de caracteres**       | Define a quantidade máxima de caractere que compõe uma [[mensagens sms\|mensagem de SMS]].                                                                                                                              |
| **Número de celular do destinatário** | Campo pertencente à seção de envios de teste. Permite a inserção de um número de celular de um destinatário do qual receberá uma mensagem de teste.                                                                     |
| **Mensagem de teste**                 | Campo pertencente à seção de envios de teste. Permite a inserção de um breve conteúdo à ser enviado a fim de testar a comunicação da integração.                                                                        |

>[!CAUTION] **Atenção:**  
O suporte ao envio de caracteres especiais é relativo e varia de acordo com o tratamento aplicado por cada plataforma. O parâmetro **"Remover caracteres especiais"** permite que seja feito um ajuste manual, dependendo do gateway utilizado. No entanto, o sistema sempre respeita as regras e o tratamento definidos pelo gateway.
>
>Isso significa que, **se o gateway de SMS não tiver suporte para o envio de caracteres especiais, o sistema não permitirá que esses caracteres sejam enviados.**

#### Campos Dinâmicos
Os campos de preenchimento de informações são dinâmicos, isto é, são apresentados de acordo com o preenchimento do tipo de Gateway no campo **Gateway**. Alguns exemplos de campos são:
- Usuário;
- Senha;
- ID API;
- IP;
- URL;
- Token;
- Tipo de serviço.

>[!WARNING] Atenção:
>Os campos variam de acordo com cada integração de Gateway SMS, portanto, verifique o material de integração individual para cada plataforma.

### Aba Log
A aba **Log** exibe o histórico completo das mensagens SMS enviadas pelo sistema por meio do gateway cadastrado. Nessa seção, os usuários podem visualizar informações detalhadas sobre cada envio, como o status da mensagem (sucesso ou falha), o horário de envio e outros dados relevantes para o monitoramento e gestão das transações. Está diretamente ligada ao formulário [[log sms|Log SMS]].

#### Campos Principais

| Campo                 | Descrição                                                                                     |
| --------------------- | --------------------------------------------------------------------------------------------- |
| **ID**                | Registro de identificação do log, gerado automaticamente pelo sistema                         |
| **Status**            | Estado atual da mensagem (enviado com sucesso ou falha)                                       |
| **Data/Hora**         | Momento exato do envio da mensagem, apresentando a data e hora no formato DD/MM/AAAA hh:mm:ss |
| **Cliente**           | Apresenta a razão social do cliente destinatário                                              |
| **Assunto**           | Texto da mensagem enviada                                                                     |
| **Gateway**           | Apresenta o nome do Gateway de SMS integrado do qual realizou o envio                         |
| **Descrição gateway** | Apresenta a descrição definida no cadastro do Gateway                                         |
| **Responsável**       | Usuário ou sistema que realizou o envio                                                       |
| **Telefone celular**  | Número de telefone do receptor                                                                |

## Casos de Uso

### Cadastro de um Gateway SMS

>[!INFO] **Dados API:**
Para realizar o cadastro de um Gateway SMS, é necessário possuir os dados necessários para a autenticação em mãos. Estes dados são fornecidos pela plataforma credenciada. 

1. Acesse o formulário de [[gateway sms|Gateway SMS]] através do caminho: menu Configurações > Integrações > Gateways SMS;
2. Em seguida, clique em **Novo**;
3. No campo **Gateway**, indique a plataforma de Gateway SMS que utilizará;
4. No campo **Descrição**, insira uma breve descrição sobre a utilização do Gateway, a fim de sinalizar à outros colaboradores sua utilidade, conforme julgar necessário. Este campo é de preenchimento opcional;
5. Preencha os campos de autenticação conforme repassado pela plataforma credenciada (exemplo: Usuário, Senha, Token, URL, entre outros);
6. Preencha os demais campos sobre a utilização do gateway SMS no sistema:
	- **Adicionar mensagens à fila:** ao marcar este campo como **sim**, o sistema permite habilitar a ferramenta de [[aba (fila sms) na mensagem sms|Aba (Fila SMS) na Mensagem SMS]] para envios através da [[Rotina de Cobrança (CRM de Cobrança)];
	- **Utiliza shortcode:** permite habilitar a redução de caracteres em mensagens de SMS. No sistema shortcode, somente é permitido enviar até 140 caracteres na mensagem;
	- **Remover caracteres especiais:** se marcado como "sim", o sistema permitirá remover os caracteres especiais do corpo das mensagens enviadas. Caso marcado como "não", a mensagem assume a formatação conforme a limitação da plataforma;
	- **Quant. máxima de caracteres:** estabelece a quantidade máxima de caractere que compõe uma [[mensagens sms|Mensagens SMS]]. É necessário validar a disponibilidade de quantidade de caracteres do provedor de SMS para inserir esta informação neste parâmetro.
	  
7. Em seguida, clique em **Salvar** para concluir o cadastro da integração;
8. Realize um envio de teste para certificar-se de que a integração está funcional, preencha os campos:
	- **Número de celular do destinatário:** insira o número de telefone do responsável que deve receber a mensagem de teste;
	- **Mensagem de teste:** insira um conteúdo breve para confirmar o envio da mensagem.
	  
9. Clique no botão **Enviar teste** e aguarde o retorno do sistema;
10. O sistema exibirá um relatório indicando o status do envio (sucesso ou falha). 

>[!CAUTION] Atenção:
>Se o status do envio for **falha**, revise as informações cadastradas e, se necessário, consulte a plataforma para validar os dados de integração.

>[!SUCCESS] Sucesso:
>Caso o retorno do sistema seja de sucesso, a integração está concluída e pronta para ser utilizada.

## Funcionalidades Principais

## Cadastro do Gateway
- Permite realizar o cadastro da integração com o Gateway credenciado.
### Envio de SMS Teste
- Permite que o usuário realize um envio de SMS para teste utilizando os dados preenchidos.
### Fila de SMS
- Permite a configuração do uso da ferramenta [[aba (fila sms) na mensagem sms|Aba (Fila SMS) na Mensagem SMS]] para utilizar em envios através da [[rotina de cobranca (crm de cobranca)|Rotina de Cobrança (CRM de Cobrança)]].
### Integração com [[log sms|Log SMS]]
- Relacionamento com sistema de logs para rastrear o histórico de envios de SMS.
### Cadastro de [[mensagens sms|Mensagens SMS]]
- A partir do cadastro da integração, viabiliza o cadastro de mensagens de SMS e promove o envio através de diferentes métodos.


## Fluxo de Trabalho

```mermaid
graph TD
    A[Início] --> B[Acesse o menu configurações]
    B --> C[Selecione a opção gateways SMS]
    C --> D[Clique em 'Novo' para configurar um novo gateway SMS]
    D --> E[Preencha os campos dinâmicos de acordo com o gateway]
    E --> F[Clique em 'Salvar']
    F --> G[Configure mensagens de SMS]
    G --> H[Efetue o envio conforme necessário]
    H --> I[Monitore os envios]
    I --> J{Necessita ajustes?}
    J -->|Sim| G
    J -->|Não| H
```

## Considerações Finais
O uso de um **gateway SMS** integrado ao sistema  é uma solução estratégica para otimizar a comunicação com clientes. Ele permite o envio automatizado de notificações importantes, como lembretes de pagamento, avisos de manutenção e confirmações de serviços, melhorando a eficiência operacional e a experiência do cliente. Além disso, facilita ações de marketing, garantindo maior alcance e personalização. A integração com o sistema centraliza essas funcionalidades, reduzindo a necessidade de múltiplas plataformas. Contudo, é essencial gerenciar os envios com responsabilidade para evitar excessos e garantir conformidade com regulamentações, como a LGPD.

## Etiquetas
#Integracoes #IntegracoesDeGatewaySMS #GatewaySMS #SMS

## Leia Também
- [[integracoes|Integrações]]
- [[mensagens sms|Mensagens SMS]]
- [[cadastro de mensagem de sms|Cadastro de Mensagem de SMS]]
- [[rotina de cobranca (crm de cobranca)|Rotina de Cobrança (CRM de Cobrança)]]
- [[parametros de cobranca|Parâmetros de Cobrança]]
- [[aba sms enviados - cliente|Aba SMS enviados - Cliente]]
- [[aba (fila sms) na mensagem sms|Aba (Fila SMS) na Mensagem SMS]]
- [[envio de sms avulso pelo cadastro do cliente|Envio de SMS Avulso pelo Cadastro do Cliente]]
- [[recuperacao de senha da central do assinante via sms|Recuperação de senha da Central do Assinante via SMS]]
- [[notificacao de confirmacao de recebimento por sms|Notificação de Confirmação de Recebimento por SMS]]
- [[log sms|Log SMS]]