As variáveis do criador de bots permitem que você personalize as respostas de um bot de mensagens com base nos dados relacionados a uma conversa. Variáveis de metadados de mensagens são um tipo de variável usada no criador de bots que contém informações sobre a identidade e o status de autenticação atuais do cliente.
As variáveis de metadados de mensagens obtêm seus valores de Tokens da web JSON (JWTs) usados para a autenticação de mensagens. Durante uma conversa, um bot de mensagens pode usar esses dados para personalizar respostas, exibir informações específicas do cliente ou ramificar o fluxo de uma conversa.
Para obter uma visão geral mais ampla das variáveis do bot e como você pode usá-las em respostas, consulte Uso de variáveis para personalizar respostas do bot.
Ativação de variáveis de metadados de mensagens
As variáveis de metadados de mensagens não estão ativadas por padrão. Para ativá-las, um administrador deve criar uma chave de assinatura usada para gerar JWTs para autenticar as mensagens. As variáveis de autenticação de mensagens e os metadados de mensagens estão disponíveis somente para canais do Web Widget e do SDK para dispositivos móveis.
Para obter mais informações sobre como configurar a autenticação de mensagens, consulte Autenticação dos usuários finais em mensagens no Web Widget e no SDK para dispositivos móveis.
Variáveis de metadados de mensagens com suporte
| Nome das variáveis de metadados de mensagens | Descrição |
|---|---|
| E-mail fornecido | Endereço de e-mail do cliente. Esse endereço é extraído do JWT usado para autenticar as mensagens. |
| Nome fornecido | O nome do cliente. É extraído do JWT usado para autenticar as mensagens. |
| ID externa autenticada | Cadeia de caracteres alfanumérica exclusiva de identificação do cliente. Essa ID é extraída do JWT usado para autenticar as mensagens. |
| Status autenticado | Se for verdadeira, o cliente é autenticado. Caso contrário, é falsa. Essa variável sempre será verdadeira ou falsa, nunca será vazia. Ao usar a variável Status autenticado em uma etapa Ramificar por condição, é aceito somente o operador É. |
Uso das variáveis Nome fornecido e E-mail fornecido
Considere o seguinte quando for usar as variáveis Nome fornecido e E-mail fornecido:
- Os bots de mensagens ignoram automaticamente a coleção das variáveis Nome e E-mail de clientes autenticados em uma etapa Peça detalhes. No caso de clientes autenticados, essas variáveis ficam vazias e são ignoradas em etapas posteriores da conversa. Em vez disso, use as variáveis Nome fornecido e E-mail fornecido.
Coleção de variáveis Nome e E-mail ignoradas na etapa Peça detalhes Variáveis Nome fornecido e E-mail fornecido 
- Os JWTs usados na autenticação das mensagens não necessitam de um nome nem de um endereço de e-mail de um cliente. Se a sua organização não incluir um nome nem um endereço de e-mail em seus JWTs, as respectivas variáveis Nome fornecido e E-mail fornecido ficarão vazias e serão ignoradas durante uma conversa.
Nesses casos, recomendamos que você atualize seus JWTs incluindo um nome e um endereço de e-mail.
- As variáveis Nome fornecido e E-mail fornecido de clientes não autenticados ficam vazias. Evite o uso dessas variáveis em etapas de resposta para clientes não autenticados.
Uso de variáveis de metadados de mensagens com clientes não autenticados
Se um cliente não é autenticado, o valor da variável Status autenticado é falso. Outras variáveis de metadados de mensagens ficarão vazias para clientes não autenticados e serão ignoradas durante uma conversa.
Práticas recomendadas para o uso de variáveis de metadados de mensagens
Ao criar uma resposta que usa variáveis de metadados de mensagens, tenha em mente as seguintes práticas recomendadas:
- Se você não incluir o nome e o endereço de e-mail do cliente nos JWTs usados na autenticação das mensagens, não use as variáveis Nome fornecido nem E-mail fornecido.
- Para criar um fluxo de resposta que esteja disponível para clientes com e sem autenticação, use a etapa Ramificar por condição para verificar as variáveis de Status autenticado do cliente. Inclua apenas variáveis de metadados de mensagens em ramificações cujo Status autenticado seja verdadeiro.
- Se você estiver criando uma resposta que esteja disponível apenas para clientes autenticados e os JWTs da sua organização incluírem nome e endereço de e-mail, use as variáveis Nome fornecido e E-mail fornecido no nome e no endereço de e-mail do cliente. Nesses casos, não é necessário coletar essa informação novamente usando uma etapa Peça detalhes.