# Gateway SMS - Khal

## Introdução

>[!TIP] Definição - Gateway SMS Khal SMS:
>Um gateway SMS é um serviço de telecomunicações que facilita o envio e recebimento de mensagens de texto (SMS) entre diversos dispositivos. 
>
>O gateway SMS [Khal SMS](https://site.khalsms.com.br/) é uma plataforma de gerenciamento de comunicação associada a serviços como disparo de SMS. Ela pode ser usada por empresas para automatizar interações com clientes, enviar alertas ou realizar campanhas de marketing.

A funcionalidade de uso de **Gateway SMS** no sistema, integrada ao **Khal SMS**, possibilita aos usuários configurar e enviar mensagens de texto (SMS) para clientes e colaboradores de forma prática e eficiente. Com essa integração, é possível personalizar o conteúdo das mensagens, assegurando uma comunicação direta, precisa e alinhada às necessidades do negócio. Além disso, o sistema permite ajustar mensagens conforme necessário e gerenciar o envio de forma centralizada, otimizando a eficácia e o alcance das campanhas de comunicação via SMS.

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

### Requisitos de Uso
Para utilizar este recurso no sistema, é necessário atender as seguintes condições:
- Conta ativa na plataforma Khal SMS;
- Dados de acesso à API da Khal SMS para a integração.

## 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
A funcionalidade de integração da plataforma **Khal SMS** consiste principalmente no cadastro das credenciais API através do formulário de **Gateways SMS**. Este formulário 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.

## Configuração da Integração
A integração do sistema IXC com a plataforma Khal SMS é realizada através do cadastro do token da API no IXC, permitindo a comunicação entre as plataformas. Após a configuração, o IXC solicita o envio de mensagens para o Khal SMS, que processa as requisições e realiza o envio, desde que as credenciais cadastradas estejam corretas e válidas. Essa integração assegura um fluxo eficiente de troca de dados para envio de SMS.

Para realizar o cadastro da integração no sistema, siga os passos a seguir:

### Passo 1: Cadastro da Integração

1. Acesse o formulário de [[gateway sms|Gateway SMS]] através do caminho: Configurações > Integrações > Gateway SMS;
2. Clique no botão **Novo** para realizar o cadastro da integração;
3. No campo **Gateway**, clique no botão suspenso e selecione a opção **Khal**;
4. Em seguida, preencha os campos exibidos para a configuração da integração:
	- **Descrição:** insira uma descrição sobre o uso da plataforma conforme julgar necessário. Esta informação não é exibida ao cliente, é utilizada somente para controle interno;
	- **Usuário:** insira o usuário de acesso à plataforma Khal;
	- **Senha:** insira a senha de cesso à plataforma Khal;
	- **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 cobranca (crm de cobranca)|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;
	- **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.
	  
5. Clique em **Salvar** para concluir o cadastro da integração.

### Passo 2: Teste de Envio
Após cadastrar a integração no sistema, é essencial realizar um envio de teste para verificar a comunicação entre as plataformas envolvidas. Siga as etapas abaixo para efetuar o teste:

1. Ainda no formulário de [[gateway sms|Gateway SMS]], na seção **Teste de envio SMS**, preencha os campos:
	- **Número de celular do destinatário:** insira o número de celular do destinatário que receberá a mensagem de teste. Este número pode ser o contato de um colaborador responsável na empresa;
	- **Mensagem de teste:** insira um breve texto para ser enviado de teste, para verificar o envio e recebimento da mensagem;
	  
2. Clique no botão **Enviar teste** e aguarde o retorno do sistema.
3. 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.

## Casos de Uso
### [[cadastro de mensagem de sms|Cadastro de Mensagem de SMS]]
Para realizar o cadastro de uma mensagem de SMS, siga os passos a seguir:

1. Acesse o formulário de [[mensagens sms|Mensagens SMS]] através do caminho: Sistema > CRM > Mensagens > Mensagem SMS;
2. Clique no botão **Novo**;
3. Preencha os campos:
	- **Gateway SMS:** clique na lupa e selecione o Gateway SMS responsável por realizar o envio da mensagem;
	- **Remetente:** insira de forma breve o remetente que constará para o cliente;
	- **Descrição:** insira uma descrição para facilitar a identificação de mensagens no sistema. Este campo não é visível ao cliente;
	- **Mensagem:** insira o assunto da mensagem correspondente ao título do SMS que será enviado na mensagem;
	- **Prioridade:** ao utilizar o recurso de [[aba (fila sms) na mensagem sms|Aba (Fila SMS) na Mensagem SMS]], poderá definir a prioridade de envio da mensagem entre as mensagens da fila;
	- **Intervalo de tempo:** indique em minutos o período que a mensagem será enviada quando for acrescentada na fila de SMS;
	- **Marketing:** indique se a mensagem é uma mensagem de marketing para ser utilizado no Inmap Sales.
	  
4. Clique em **Salvar** para validar o cadastro da mensagem de SMS.

>[!SUCCESS] Finalização:
>Após cadastrar a mensagem, ela permanecerá disponível no formulário de **[[mensagens sms|Mensagens SMS]]** para possíveis ajustes e edição, caso necessário. Com a mensagem cadastrada, poderá utilizá-la para realizar os envios manuais e automáticos no sistema.

Uma vez cadastrada, a mensagem pode ser utilizada para diversos tipos de envio, tanto de forma automática quanto manual, direcionada a clientes ou para uso interno da empresa, conforme a necessidade.

>[!EXAMPLE] Veja também:
>- [[envio de boletos por sms pelo financeiro do cliente|Envio de Boletos por SMS pelo Financeiro do Cliente]]
>- [[envio de boletos por sms pelo relatorio de emissao de boletos|Envio de Boletos por SMS pelo Relatório de Emissão de Boletos]]
>- [[envio de pix por sms|Envio de Pix por SMS]]
>- [[rotina de cobranca (crm de cobranca)|Rotina de Cobrança (CRM de Cobrança)]]
>- [[teste de envio sms - mensagens sms|Teste de Envio SMS - Mensagens SMS]]
>- [[log sms|Log SMS]]


## Fluxo de Trabalho

```mermaid
graph TD
    A[Credenciamento com a plataforma] --> B[Recebe as credenciais API]
    B --> C[Acesse o formulário de integração Gateway SMS]
    C --> D[Clique em 'Novo' e defina o gateway como Khal SMS]
    D --> E[Insira as credenciais API e salve]
    E --> F[Preencha o número de destinatário para teste]
    F --> G[Preencha a mensagem de texto para teste]
    G --> H[Clique em 'Enviar teste']
    H --> I{Status do envio}
    I -->|Sucesso| J[Integração está pronta para uso]
    I -->|Falha| K[Revisar dados da integração]
    K --> C
    J --> L[Configurar mensagem e tipos de envio]
    L --> M[Monitorar os envios pelos logs SMS]
```

## 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 #SMS #KhalSMS #Khal

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