Variáveis de Template Omnichannel (Opa! Suite)
Introdução
A Integração Omnichannel com o Opa! Suite no IXC Provedor permite o envio de mensagens automáticas utilizando templates personalizados. Esses templates podem incluir variáveis (placeholders) que são substituídas por informações reais no momento do disparo. Essa funcionalidade reduz erros manuais, agiliza o atendimento e garante consistência nas comunicações enviadas ao cliente.
Caminhos:
- Sistema > CRM > Mensagens > Mensagens omnichannel
- Configurações > Integrações > Integrações assinatura digital > Notificações > Mensagem Omnichannel para assinatura do cliente/testemunha do cliente
Requisitos de Uso
Para utilizar esta funcionalidade, é necessário atender os seguintes requisitos:
- Possuir uma integração ativa e funcional entre o IXC Provedor e Opa! Suite para envio de mensagens;
- Possuir um template previamente configurado no Opa! Suite. Para mais informações, acesse: templates de mensagem - Opa! Suite
Estrutura das Variáveis
As variáveis utilizadas para envios feitos através da integração com o Opa! Suite seguem a estrutura #nome_da_variavel# e somente são preenchidas quando o método de envio possui tratamento para elas.
#nome_da_variavel#
Exemplo dentro de um template:
Olá #cliente_nome#, identificamos um boleto pendente no valor de #areceber_valor# com vencimento em #areceber_data_vencimento#.
Como Usar uma Variável Omnichannel
Para configurar um template Omnichannel no IXC Provedor com uso de variáveis, o template deve estar previamente criado e parametrizado no Opa! Suite, e a integração Omnichannel já deve estar habilitada no IXC Provedor. Somente após esses passos o uso de variáveis no IXC estará disponível.
Requisitos para uso das variáveis:
- É necessário haver um template de mensagem configurado no Opa! Suite;
- As variáveis precisam estar configuradas no template do Opa! Suite;
- A quantidade das variáveis no IXC Provedor devem corresponder exatamente às do template no Opa! Suite;
- Ao informar mais de uma variável no IXC Provedor, elas devem ser separadas por vírgula no campo de cadastro do template.
Quando um template é criado no Opa! Suite e cadastrado no IXC Provedor para uso via Omnichannel, ele aparece no IXC em modo leitura, como uma prévia do conteúdo original. As variáveis são apresentadas exatamente como foram configuradas no Opa! Suite.
Exemplo de template no Opa! Suite:Caminho: Sistema > CRM > Mensagens > Mensagens Omnichannel > Texto do template
Olá, ! Segue o link do contrato para análise e assinatura: .É só clicar no link, verificar se está tudo conforme o contratado e efetuar a assinatura.Qualquer dúvida, estou à disposição!
Como definir quais variáveis vou utilizar? Exemplo de correspondência:
- Primeira variável:
#cliente_razao#→ preenche o nome ou razão social do cliente. - Segunda variável:
#link_assinatura_digital#→ preenche o link de assinatura gerado pelo IXC Assina.
Ao aplicar as variáveis desta forma, você terá uma mensagem final como esta:
Olá, João Silva! Segue o link do contrato para análise e assinatura: https://sandbox.app.assina.ixcsoft.com.br/assinar/12345678a-b12-c3d4-567e-f8aghij90k1l.É só clicar no link, verificar se está tudo conforme o contratado e efetuar a assinatura.Qualquer dúvida, estou à disposição!
A seguir, confira quais variáveis correspondem a cada método de envio:
Variáveis de Cadastro e Financeiras
| Variável | Conceito | Caminho | Exemplo aplicado (dados de homologação) |
|---|---|---|---|
#areceber_data_emissao# | Data de emissão do boleto. | Contas a receber > Data da emissão | 30/05/2025 |
#areceber_data_vencimento# | Data de vencimento do boleto. | Contas a receber > Data do vencimento | 03/12/2025 |
#areceber_numero# | Informação respectiva ao ID do boleto no IXC. | Contas a receber > ID | 24 |
#areceber_valor# | Informação respectiva ao valor do boleto. | Contas a receber > Valor | 49,90 |
#cliente_cnpj_cpf# | Informação respectiva ao CPF/CNPJ do cliente, definido no campo CNPJ/CPF no cadastro do Cliente. | Sistema > Cadastros > Clientes > CNPJ/CPF | 066.544.880-59 (dado fictício) |
#cliente_contrato_id# | ID do contrato do cliente. | Sistema > Cadastros > Contratos > ID | 1254 |
#cliente_email# | Informação respectiva ao e-mail do cliente, definido no campo E-mail principal no cadastro do Cliente. | Sistema > Cadastros > Clientes > aba Contato > E-mail principal | email@dominio.com.br |
#cliente_fantasia# | Informação respectiva ao nome fantasia do cliente, definido no campo Nome Fantasia no cadastro do Cliente. | Sistema > Cadastros > Clientes > Nome fantasia | Informação preenchida normalmente para clientes do tipo Pessoa Jurídica. |
#cliente_hotsite_email# | Informação correspondente ao e-mail de acesso à Central do Assinante do cliente. | Sistema > Cadastros > Clientes > Contato > (Central do assinante) Login | email@dominio.com.br |
#cliente_hotsite_senha# | Informação correspondente à senha de acesso à Central do Assinante do cliente. | Sistema > Cadastros > Clientes > Contato > (Central do assinante) Senha | senhacentraldoassinante |
#cliente_razao# | Informação respectiva à razão social, definido no campo Razão social/nome no cadastro do Cliente. | Sistema > Cadastros > Clientes > Razão social/Nome (nome completo) | João Silva |
#contrato_descricao# | Descrição do plano associado ao contrato. | Sistema > Cadastros > Contratos > Descrição | Plano de Internet - 10MB |
#filial_descricao# | Nome fantasia da filial. | Configurações > Empresa > Filiais > Filial > Nome fantasia | Central de Ajuda IXC Provedor |
#filial_email# | E-mail da filial. | Configurações > Empresa > Filiais > Filial > E-mail | emailempresa@dominio.com.br |
#filial_fantasia# | Nome fantasia da filial. | Configurações > Empresa > Filiais > Filial > Nome fantasia | Central de Ajuda IXC Provedor |
#filial_razao# | Razão social da filial. | Configurações > Empresa > Filiais > Filial > Razão social | Central de Ajuda LTDA |
#filial_site# | Site da filial. | Configurações > Empresa > Filiais > Filial > Site | central-de-ajuda.com.br |
#filial_telefone# | Telefone da filial. | Configurações > Empresa > Filiais > Filial > Contato | https://wiki-erp.ixcsoft.com.br/ |
#pix_copia_cola# | Código PIX do boleto quando disponível. | Sistema > Receber > Contas a receber > Informações > TxID | 00020126600014BR.GOV.BCB.PIX01365d2f1b0a-12cd-4f11-9aa1-82e9fa11c7f152040000530398654040.015802BR5925EMPRESA EXEMPLO LTDA6009SAO PAULO62070503***6304ABCD |
#valor_recebido# | Informação respectiva ao valor recebido quando o boleto é pago. Busca o campo Valor Recebido no boleto do cliente. | Sistema > Receber > Contas a receber > Informações > Valor recebido | Se 0,00, indica não pago. Se indicar valor, imprime o valor recebido que estiver definido no campo Valor recebido, exemplo: 49,90 |
Variáveis para Assinatura Digital
| Variável | Conceito | Caminho | Exemplo aplicado (dados de homologação) |
|---|---|---|---|
#cliente_cnpj_cpf# | Informação respectiva ao CPF/CNPJ do cliente, definido no campo CNPJ/CPF no cadastro do Cliente. | Sistema > Cadastros > Clientes > CNPJ/CPF | 066.544.880-59 (dado fictício) |
#cliente_contrato_id# | ID do contrato do cliente. | Sistema > Cadastros > Contratos > ID | 1254 |
#cliente_email# | Informação respectiva ao e-mail do cliente, definido no campo E-mail principal no cadastro do Cliente. | Sistema > Cadastros > Clientes > aba Contato > E-mail principal | email@dominio.com.br |
#cliente_fantasia# | Informação respectiva ao nome fantasia do cliente, definido no campo Nome Fantasia no cadastro do Cliente. | Sistema > Cadastros > Clientes > Nome fantasia | Informação preenchida normalmente para clientes do tipo Pessoa Jurídica. |
#cliente_nome_testemunha# | Corresponde à testemunha do signatário. | Sistema > Cadastros > Contratos > Avalista/Assinatura digital > Testemunha | José Santos |
#contrato_descricao# | Descrição do plano associado ao contrato. | Sistema > Cadastros > Contratos > Descrição | Plano de Internet - 10MB |
#filial_descricao# | Nome fantasia da filial. | Configurações > Empresa > Filiais > Filial > Nome fantasia | Central de Ajuda IXC Provedor |
#filial_email# | E-mail da filial. | Configurações > Empresa > Filiais > Filial > E-mail | emailempresa@dominio.com.br |
#filial_fantasia# | Nome fantasia da filial. | Configurações > Empresa > Filiais > Filial > Nome fantasia | Central de Ajuda IXC Provedor |
#filial_razao# | Razão social da filial. | Configurações > Empresa > Filiais > Filial > Razão social | Central de Ajuda LTDA |
#filial_site# | Site da filial. | Configurações > Empresa > Filiais > Filial > Site | central-de-ajuda.com.br |
#filial_telefone# | Telefone da filial. | Configurações > Empresa > Filiais > Filial > Contato | https://wiki-erp.ixcsoft.com.br/ |
#link_assinatura_digital# | Link gerado para assinatura digital do cliente ou testemunha, dependendo da configuração na integração com IXC Assina v2. | Sistema > Cadastros > Contratos > Histórico assinatura digital > | https://sandbox.app.assina.ixcsoft.com.br/assinar/12345678a-b12-c3d4-567e-f8aghij90k1l |
Casos de Uso
Para o envio de templates omnichannel aos clientes, quatro métodos podem ser utilizados:
Considerações Finais
As variáveis de template são essenciais para personalizar e automatizar mensagens enviadas pela integração com Omnichannel. Manter um documento único de referência evita erros e garante que todas as equipes trabalhem com as mesmas informações. O uso adequado das variáveis reduz falhas, melhora a entrega e cria uma comunicação mais clara e eficiente entre a empresa e o cliente.