Pular para o conteúdo principal

Integração SGP

A integração com SGP conecta o FlashChat ao ERP para consultar dados de clientes, contratos, faturas e informações técnicas usadas em fluxos de atendimento.

informação

SGP é uma integração ERP. Para detalhes de autenticação, ACL e contrato HTTP, consulte a API FlashChat.

Principais cenários

A integração SGP pode ser usada para:

  • Consultar cliente por documento ou telefone.
  • Listar contratos vinculados ao cliente.
  • Consultar faturas abertas.
  • Enviar linha digitável, PDF de boleto e código Pix.
  • Enviar fatura interativa via template Meta, quando disponível.
  • Executar desbloqueio de confiança.
  • Exibir dados técnicos de conexão, radius e ONU/ONT quando habilitados.

Envio pelo endpoint da API

O SGP pode chamar o endpoint do canal FlashChat:

POST /api/chat/sms/add/{webhook_token}

As credenciais devem ser enviadas com client_id e client_secret, preferencialmente via headers.

client_id: flash_xxxxxxxxx
client_secret: secret_xxxxxxxxx

Payload SGP como JSON string

Em alguns cenários, o SGP envia o contrato no campo message como uma string JSON.

Exemplo:

{
"contact": "558288094777",
"message": "{\"type\":\"invoice_template\",\"template\":{\"name\":\"invoice_request_user\",\"language\":\"pt_BR\"},\"invoice\":{\"customer_name\":\"Cliente Nome\",\"due_date\":\"31/05/2026\",\"amount\":\"93.79\",\"contract_id\":\"2577\",\"pdf_url\":\"https://demo.sgp.net.br/boleto/100634-TNZLQ8GDBF/\",\"digitable_line\":\"75691.30001 01071.528002 03998.500015 9 14700000009379\",\"pix_code\":\"000201010212...\",\"pix_merchant_name\":\"Fibramais Telecom\",\"pix_key\":\"00.000.000/0001-00\",\"pix_key_type\":\"CNPJ\"}}"
}

O FlashChat detecta o type dentro do JSON e usa o contrato correto. Se o conteúdo parecer um contrato de template, mas o JSON estiver inválido, a API retorna erro 400 e não envia como mensagem simples.

Faturas

Para envio de fatura, os campos mais comuns são:

CampoUso
customer_nameNome do cliente
due_dateVencimento da fatura
amountValor da cobrança
contract_idContrato relacionado
pdf_urlURL pública do boleto/PDF
digitable_lineLinha digitável
pix_codeCopia e cola Pix
dica

URLs de boleto, PDF, imagem ou documento precisam ser públicas e acessíveis pelo canal de envio.

Templates de mensagem

Mensagens vindas do SGP podem usar Templates Jinja para montar conteúdo com dados do cliente, contrato e fatura.

Exemplo:

Olá {{ cliente.nome }}, encontramos uma fatura em aberto.
{{ quebra_de_linha }}
Vencimento: {{ fatura.vencimento }}
{{ quebra_de_linha }}
Linha Digitável: {{ fatura.linhadigitavel }}
{{ quebra_de_linha }}
{file={{ fatura.link }}}

Variáveis relacionadas

Alguns comportamentos da integração podem depender de Variáveis de Sistema, como mensagens de desbloqueio, intervalos de envio e flags técnicas.

Exemplos:

  • MSG_SERVICO_DESBLOQUEADO
  • MSG_SERVICO_PROMESSA_QTD_EXCEDIDA
  • INTERVALO_MENSAGENS_GERAL
  • INTERVALO_MENSAGENS_SMS
  • TR_69_ENABLE

Segurança recomendada

Para integrações SGP em produção:

  • Use credenciais API exclusivas para o SGP.
  • Restrinja por IP/CIDR quando possível.
  • Evite permitir domínios amplos sem necessidade.
  • Mantenha client_secret fora de logs, prints e documentos compartilhados.
  • Valide se o proxy preserva o IP real da origem.

Checklist de implantação

  • Criar credenciais API no FlashChat.
  • Liberar IP/CIDR de origem do SGP.
  • Confirmar o webhook_token do canal correto.
  • Testar mensagem simples.
  • Testar envio de fatura com linha digitável.
  • Testar envio de PDF por URL pública.
  • Testar template Meta, se usado.
  • Conferir logs de APIRequestHistory em caso de bloqueio por ACL.