SGP
Conectar a SM Click ao SGP.
Envio automático de cobranças pelo WhatsApp. Voltada a provedores de internet e empresas que usam o SGP como sistema de gestão.
O que é o SGP
O SGP é um sistema de gestão para provedores de internet e empresas parecidas: cadastro de clientes, contratos e cobranças.
Para que serve a integração
A integração consulta as cobranças do SGP na rotina que você define e envia ao cliente, pelo WhatsApp, a mensagem de lembrete: antes do vencimento, no dia ou depois, quando a cobrança está em atraso. A equipe não precisa avisar um a um, e menos cobranças ficam esquecidas.
Requisitos
Uma instância ativa na SM Click, para enviar as mensagens. A instância está disponível no plano Gamma ou pode ser adquirida separadamente no gerenciamento da assinatura.
As credenciais de acesso ao SGP:
- Token de Acesso — token de autenticação da API do SGP, obtido com o suporte do SGP ou na área de configurações/integrações do sistema
- App — código identificador do aplicativo configurado no SGP
- Host — endereço do servidor SGP, por exemplo
sgp.suaempresa.com.br
Como configurar
No painel, acesse Integrações → Nativas e escolha o SGP. Informe as credenciais acima e defina as regras de envio.
Para indicar a instância que fará o envio:
- Acesse a página Home da SM Click.
- Localize a instância que será utilizada na integração.
- Clique em Copiar token.
- Cole o token no campo Instância que enviará a mensagem.
Envio por API Oficial
Quando a instância utilizar a API Oficial, informe também no campo ID do Template o ID de um template criado previamente. Nesse caso, não preencha o campo Mensagem: o conteúdo do envio já está configurado no template.
Criação de Template para Integração
Para enviar cobranças do SGP por uma instância de API Oficial, crie um template seguindo o processo padrão. Recomendamos a categoria Utilidade, o tipo Mensagem e um nome que identifique o uso na integração. O cabeçalho e o rodapé são opcionais.
No corpo, use variáveis no formato {{1}}, {{2}} e assim por diante. No exemplo de
cada variável, informe o nome da tag correspondente do SGP, sem as chaves. Por exemplo,
para Olá {{1}}, informe nome como exemplo da primeira variável.
No campo de exemplo de cada variável, informe somente o nome do placeholder, sem as
chaves: valor, dataVencimento, demonstrativo, linkBoleto, linkPdf, chavePix,
linhaDigitavel, nome, celular e email.
Para o botão da cobrança, adicione um botão Acessar Site, use a URL
https://{dominio}.sgp.tsmx.com.br/boleto/{{1}}, informe 7611-PV4IV52LDS/ como
exemplo da variável da URL e escolha um texto como Acessar Boleto. Salve o template
e informe seu ID na integração, deixando o campo Mensagem vazio.
Regras de envio
Você configura quantos dias antes ou depois do vencimento a mensagem sai, além dos dias da semana e do horário.
Como funciona o campo de dias
Em cada regra, o campo Dias a partir de hoje diz em relação ao vencimento quando a mensagem sai. O número é contado a partir de hoje: -1 é um dia antes do vencimento, 0 é o próprio dia e 1 é um dia depois.
| Valor | Quando a mensagem sai | Exemplo (hoje é dia 10) |
|---|---|---|
| -1 | 1 dia antes do vencimento | Cobranças que vencem no dia 11 |
| 0 | No dia do vencimento | Cobranças que vencem hoje, dia 10 |
| 1 | 1 dia depois do vencimento (cobrança em atraso) | Cobranças que venceram ontem, dia 9 |
Para avisar com mais antecedência ou cobrar mais tarde, use outros números: -3 avisa três dias antes e 5 cobra cinco dias depois. Cada regra tem o seu próprio texto, então dá para combinar, por exemplo, um aviso de véspera (-1), um lembrete do dia (0) e uma cobrança de atraso (1), cada um com a mensagem que faz sentido naquele momento.
As mensagens só saem nos dias da semana e no horário que você marcou na rotina. Se a rotina não roda no domingo, uma cobrança que vence no domingo e usa a regra 0 não é enviada.
A recomendação é disparar em dias úteis, de segunda a sexta, entre 8h e 17h. Cobrança que chega de madrugada ou no domingo irrita, e irritação vira denúncia — que prejudica seu número.
Variáveis da mensagem
Em mensagens comuns, quando a instância não utiliza a API Oficial, você pode incluir as variáveis com as chaves no texto da mensagem. Na API Oficial, utilize o template configurado acima.
| Variável | O que traz |
|---|---|
{valor} | O valor, em reais, da cobrança |
{dataVencimento} | O dia do vencimento da cobrança, no padrão DD/MM/YYYY |
{demonstrativo} | A referência/demonstrativo da cobrança |
{linkBoleto} | A URL de cobrança no SGP |
{linkPdf} | O link direto para o PDF do boleto |
{chavePix} | O código PIX copia e cola para pagamento (será enviado como mensagem separada) |
{linhaDigitavel} | A linha digitável do boleto (será enviada como mensagem separada) |
{nome} | O nome do cliente cadastrado no SGP |
{celular} | O número do celular do cliente cadastrado no SGP |
{email} | O e-mail do cliente cadastrado no SGP |
Uma mensagem com variáveis parece pessoal, e não um disparo automático. Com as variáveis desta integração, algo como:
Olá {nome}, sobre {valor} em {dataVencimento}. Aqui está o link: {linkBoleto}
Sem elas, sobra o texto genérico que o cliente ignora.
Se parar de funcionar
O motivo mais comum é credencial expirada. Veja recarregar tokens.
Se o problema for a mensagem não chegar ao cliente, o retorno costuma vir da Meta — consulte erros mais comuns.
Atualizado em