Como usar as variáveis de sistema

Sobre a função

As variáveis de sistema são elementos que permitem personalizar e aprimorar o atendimento do bot, adaptando a interação conforme a jornada do usuário. Ao utilizar esse recurso, as variáveis de sistema coletam informações durante a interação do consumidor com o seu bot, como o número de telefone ou a hora do contato, e adapta a experiência de atendimento.

Veja como fazer

As variáveis de sistema pode ser utilizadas em um bloco Decisor, Pergunta ou Texto, por exemplo. Ao longo deste artigo, vamos mostrar a você como utilizá-las em seus fluxos de conteúdos.

$$hi_current_date

Descrição: Fornece a data exata em que o usuário está interagindo com o bot.
Exemplo de uso: Use para personalizar mensagens de acordo com o data exata do contato.

$$hi_current_hour

Descrição: Fornece a hora exata da interação, permitindo que o bot adapte suas respostas com base no horário.
Exemplo de uso: Use para adaptar saudações (ou até mesmo registrar o horário de contato).

$$hi_consumer_question

Descrição: Registra o texto digitado pelo usuário ou o título do último conteúdo acessado. O bot usa essa informação para personalizar a continuidade da conversa.
Exemplo de uso: Ao usar essa variável, o bot passa a responder diretamente à última interação do usuário. Imagine o cenário onde você quer adicionar o link do seu WhatsApp na bio do Instagram. Para isso, você usa o gerador de links de WhatsApp e adiciona uma mensagem personalizada:

Exemplo prático
	Você pode usar a variável $$hi_consumer_question em seu fluxo e adicionar uma condição para que, quando o consumidor envie a mensagem que você personalizou através do gerador de links (ou uma mensagem similar, depende de como você quer tratar a resposta), ele seja direcionado a um fluxo específico, fazendo com que o bot responda diretamente à última interação.
	Fluxo no qual o consumidor será direcionado quando enviar a mensagem.
	Visão do consumidor final.

$$hi_protocol

Descrição: Gera um número de protocolo para que o usuário possa rastrear suas interações.
Exemplo de uso: Fornecer o protocolo ao final da interação para acompanhamento posterior. Nesse caso, esse protocolo gerado será adicionado às informações de atendimento do consumidor. Dessa forma, o agente de atendimento é quem terá acesso a esse protocolo, por se tratar de um dado específico e interno do seu bot.

$$username

Descrição: Usa o nome fornecido pelo consumidor no WhatsApp.
Exemplo de uso: Recomendada para criar uma experiência mais pessoal. Para isso, você pode usar um bloco Texto e usar a variável em uma saudação, alerta, informação ou algo do tipo. Veja:

Exemplo prático
	Variável aplicada no fluxo por meio de um bloco Texto que está dentro de um bloco Decisor para checagem de horário.
	Visão do consumidor final.

$$nome_usuario

Descrição: Utiliza o nome completo que o consumidor forneceu no WhatsApp ou o nome completo digitado na pesquisa inicial do bot.
Exemplo de uso: Quando o seu bot perguntar: "Como você quer que eu te chame?", a resposta do consumidor vai ser armazenada nessa variável, podendo ser utilizada a qualquer momento.

Exemplo prático
	Variável aplicada no fluxo por meio de um bloco Pergunta que está dentro de um bloco Decisor.
	Visão do consumidor final.

$$hi_current_day_of_week

Descrição: Indica o dia da semana, permitindo que o bot adapte sua interação conforme o dia.
Exemplo de uso: Nesse caso, as mensagens enviadas em dias úteis podem ser diferentes das enviadas nos finais de semana. O retorno é 0 para domingo, 1 para segunda e assim sucessivamente, até 6 para sábado.

Exemplo prático
	Observe a condição que diz que a mensagem "Diferente de domingo" terá um tratamento diferente dos demais dias da semana. Dessa forma, você pode configurar uma mensagem específica para quando for domingo, aconselhando a abertura de um ticket, por exemplo.
	Conteúdo do "Menu Comercial".
	Visão do consumidor final.

$$hi_consumer_recontact

Descrição: Identifica se o atendimento atual é um recontato dentro das últimas 24 horas (ele retorna com true
se for um recontato e false se não for um recontato).
Exemplo de uso: Imagine o cenário em que o seu cliente entrou em contato pela manhã, logo às 9h. Entretanto, às 15h, ele retormou o contato. Essa variável irá detectar esse recontato feito (sempre monitorando as últimas 24 horas). Nesse caso, ao invés do seu cliente passar novamente pelo fluxo de saudação, ele pode, por exemplo, ser direcionado diretamente para o Chat, uma vez que, se ele está contanto sua empresa novamente, talvez seja porque o problema/solicitação não foi devidamente resolvida.
É possível usá-la em um bloco decisor com a condição de que, se a variável $$hi_consumer_recontact for igual a true, então, o seu consumidor deve ser direcionado a um fluxo que faça transbordo para o Chat, ou até mesmo a um fluxo diferente ao de saudação.

$$hi_consumer_recontact_count

Descrição: Informa a quantidade de vezes (1, 2, 3, etc) que o usuário retornou o contato dentro das últimas 24h.
Exemplo de uso: A variável permite que o bot ajuste sua abordagem, oferecendo um atendimento mais direcionado para consumidores que retornam frequentemente. Além de identificar o recontato, a contagem permite que você analise a eficácia do seu bot e adicionar uma regra como, por exemplo: se o consumidor fizer 3 recontatos, então, direcione diretamente para o Chat.

$$whatsappid

Descrição: Armazena o número de telefone do usuário, incluindo DDI e DDD.
Exemplo de uso: Verificações de segurança ou integrações com outros sistemas.

_priorityagentsusernames

Descrição: Garante que o consumidor seja direcionado ao agente (Hi Chat) que fez o contato ativo inicial, mantendo a continuidade do atendimento.
Exemplo de uso: Manter o cliente vinculado ao agente que iniciou a interação, similar à funcionalidade Carteirização do próprio Chat.

Variáveis de Template (HSM)

As variáveis de HSM permitem personalizar as mensagens ativas disparas em massa enviadas pelo seu WhatsApp API.

$$ElementName e $$RepliedMessage

Descrição: Essas duas variáveis são complementares, então, para que seja efetivo, é recomendado usá-las em conjunto.

• A $$elementName funciona como um identificador do modelo de mensagem ativa já aprovado pela Meta. Com ela, é possível personalizar jornadas ou diferenciar departamentos.
• Já a variável $$repliedMessage captura o texto exibido no botão de resposta escolhido pelo usuário. Ou seja, quando um disparo de mensagem (HSM) é realizado, a mensagem chega ao destinatário, que seleciona uma resposta. Nesse momento, a variável armazena o texto da resposta, e, através de uma integração (API), o sistema processa e trata essa resposta de forma eficiente. Sem sobreposição ou conflitos de informações, essa variável é ideal para gerenciar grandes volumes de respostas simultâneas, garantindo precisão no tratamento de cada interação.

Exemplo prático
	Exemplo de disparo de mensagem feito a sua base de alunos que encontram-se inadimplentes. Considere que o nome desse template (HSM) é alunos_inadimplentes_setembro
	Observe as condições, onde a variável $$elementName refere-se ao nome do template enquanto a variável $$RepliedMessage está vinculada ao botão. Com essas condições restringindo a um template específico, é possível que você tenha vários botões com o mesmo texto, isso porque o que garante precisão é o nome do template ($$ElementName). Configure o direcionamento conforme desejado.

$$WhatsAppRepliedMessageId

Descrição: Identifica a mensagem de resposta enviada ao disparar o template (tratamento em API).
Exemplo de uso: Permite a integração da resposta via API sem conflito de informações. Veja o exemplo ilustrativo:

$$var_(1,2,3...)

Descrição: Retorna o valor da variável na mensagem, seguindo a ordem aprovada pela Meta (exceto se houver uma variável no cabeçalho).
Exemplo de uso: Em um modelo de mensagem no WhatsApp, as variáveis podem ser usadas para personalizar o conteúdo enviado aos usuários. Com a $$var_1 (2,3…), o bot consegue recuperar essas informações de forma organizada e sequencial.
Basta especificar a variável que deseja ter seu valor retornado, exemplo $$var_2 ou $$var_5, etc.

headerdocumenturl

Descrição: Armazena a URL de um documento que será anexado ao cabeçalho de um template de mensagem ativa.
Exemplo de uso: Em um cenário de suporte, a empresa pode enviar um manual de instruções em PDF para o cliente: "Segue o manual de instruções que você solicitou: [link do documento]."

headerdocumentcaption

Descrição: Permite adicionar uma legenda ao documento anexado no cabeçalho da mensagem.
Exemplo de uso: Para o manual enviado, a legenda poderia ser: "Manual do Produto X - Edição 2024."

headervideourl

Descrição: Armazena a URL de um vídeo que será anexado ao cabeçalho de um template de mensagem ativa.
Exemplo de uso: Um vídeo demonstrativo pode ser enviado em uma campanha de marketing: "Confira o vídeo explicativo sobre o nosso novo produto: [link do vídeo]."

headerImageUrl

Descrição: Armazena a URL de uma imagem que será anexada ao cabeçalho do template de mensagem ativa.
Exemplo de uso: A empresa pode enviar a imagem de um novo produto como parte de uma promoção: "Conheça o nosso novo lançamento!" seguido da imagem do produto anexada.
Essas variáveis tornam as mensagens mais interativas e personalizadas, proporcionando uma experiência mais completa ao cliente.

Perguntas frequentes

A quem esses dados são fornecidos?
Ao seu próprio bot. Imagine que o seu chatbot é um sistema que, ao receber as informações armazenadas em uma variável, é capaz de direcionar o seu consumidor a um fluxo diferente, aumentando a personalização a cada interação com a sua marca.