No criador de bots, uma variável é um contêiner de dados relacionados com uma conversa, como o nome do cliente ou o ID de pedido de uma loja. Durante uma conversa, um bot de mensagens pode utilizar variáveis de muitas maneiras, incluindo:
- Inserido em mensagens do bot para personalizar respostas de texto, exibir informações dinâmicas e imagens ou ramificar a conversa.
- Para definir o valor de uma variável com base na entrada de um usuário final.
- Em tags que são adicionadas a tickets durante a etapa Transferir para o agente.
Um bot pode incluir até 46 variáveis únicas em todas as respostas. Cada variável única pode ser usada em uma resposta quantas vezes forem necessárias.
Sobre nomes e valores de uma variável
No criador de bots, cada variável tem um nome e um valor. Quando uma etapa é configurada em uma resposta, o nome atua como placeholder do valor. Quando executa a resposta, o bot substitui o nome da variável pelo seu valor. Por exemplo, você pode usar uma variável com o nome E-mail para o endereço de e-mail do cliente.
As variáveis são globais em um bot de conversa. Depois que são criadas, as variáveis ficam disponíveis em todas as respostas subsequentes na conversa com o usuário final por meio de texto livre ou da etapa Link para outra resposta.
Tratamento de variáveis vazias
Uma variável fica vazia se não tiver um valor. Os bots de mensagens ignoram variáveis vazias durante uma conversa.
Por exemplo, uma etapa Enviar mensagem inclui uma mensagem do bot “O status de envio do seu pacote é shipping_status”. Se a variável shipping_status estiver vazia durante uma conversa, o bot enviará “O status de envio do seu pacote é “.
| Mensagem do bot | Visualização do cliente |
|---|---|
|
|
Tratamento de variáveis ausentes
Na etapa Fazer chamada de API, se uma das variáveis salvas estiver ausente na resposta, a ramificação de falha da etapa é acionada. Consulte Uso da etapa Fazer chamada de API no criador de bots.
Sobre tipos de variáveis
Variáveis do cliente
As variáveis do cliente armazenam informações fornecidas por um cliente em uma etapa Peça detalhes. Por exemplo, a etapa pode pedir a um cliente que forneça o nome e o endereço de e-mail.
Ao inserir uma variável em uma etapa usando o ícone Adicionar variável (
), as variáveis do cliente são exibidas em Respostas do cliente.
Variáveis de serviço externo
As variáveis de serviço externo armazenam dados recebidos de um sistema externo durante uma etapa Fazer chamada de API. Por exemplo, a etapa pode fazer uma solicitação REST API para que uma transportadora saiba o status atual de um pacote.
Os administradores criam variáveis de serviço externo quando a etapa Fazer chamada de API é configurada. Como parte da configuração, o administrador pode definir um nome personalizado para cada variável.
Ao inserir uma variável em uma etapa usando o ícone Adicionar variável (), as variáveis de serviço externo são exibidas em Respostas do serviço externo.
Variáveis de metadados de mensagens
Variáveis de metadados de mensagens contêm informações sobre a identidade e o status de autenticação 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.
As variáveis de metadados de mensagens não são ativadas por padrão e estão disponíveis somente para canais do Web Widget e do SDK para dispositivos móveis. Para obter mais informações sobre como ativar e usar variáveis de metadados de mensagens, consulte Uso de metadados de autenticação na resposta de um bot.
Se forem ativadas, as variáveis de metadados de mensagens serão exibidas em Metadados de mensagens quando uma variável é inserida em uma etapa usando o ícone Adicionar variável ().
Variáveis do Sunshine Conversations
As variáveis do Sunshine Conversations podem ser usadas para se conectar às integrações do Sunshine Conversations.
As variáveis disponíveis incluem:
Uso de variáveis em uma resposta
Personalização de mensagens do bot
Envio de dados para sistemas externos
Ao fazer uma chamada REST API para um sistema externo usando a etapa Fazer chamada de API, os administradores podem inserir variáveis no caminho e na cadeia de caracteres de consulta do campo da URL do ponto de extremidade da etapa. Para obter mais informações, consulte Uso da etapa Fazer chamada de API no criador de bots.
Ramificação do fluxo de uma resposta
Definição de valores da variável
Os administradores podem usar a etapa Definir variáveis para criar uma nova variável e atribuir um valor a ela ou selecionar uma variável existente e substituir seu valor com base em ações tomadas por um usuário final na conversa. As variáveis podem ser referenciadas em todas as respostas no bot.
Consulte Noções básicas sobre tipos de etapa de resposta: Definir variáveis para obter detalhes sobre o uso.
Uso de variáveis em tags
Administradores podem usar variáveis nas tags que são adicionadas a um ticket criado como parte da etapa Transferir para o agente. Essas tags podem ser usadas pelos agentes para visualizar, organizar e monitorar tickets, bem como em ações automatizadas como encaminhamento de tickets e outras regras de negócios.
Embora, tecnicamente, sejam parte de uma resposta, as variáveis em tags são sujeitas a algumas regras e restrições às quais outras variáveis não são.
Você pode usar variáveis geradas a partir de chamadas da API e variáveis do sistema. As variáveis disponíveis são exibidas na lista suspensa de seleção:
No entanto, as variáveis que contêm entrada do usuário final não podem ser usadas em tags. Elas serão exibidas na lista suspensa, mas estarão desativadas. Por exemplo, você não pode fazer referência a uma variável usando informações coletadas anteriormente em uma etapa Peça detalhes na conversa.
As regras e recomendações a seguir aplicam-se ao uso de variáveis em tags:
Limite de caracteres
- As tags embutidas no código-fonte são limitadas a 80 caracteres cada.
Caracteres especiais
- Variáveis contendo os caracteres especiais a seguir não podem ser usadas e não aparecerão na lista de variáveis disponíveis: £, `, ´, \, [, ], {, }, (, ), <, >, %, &, ?, +, @, !, *, $, #, = e "
- Espaços ou vírgulas usados em variáveis aparecerão como sublinhado em tags.
Além disso, recomendamos as seguintes práticas recomendadas ao usar variáveis como tags:
- As tags costumam ser usadas para encaminhamento de conversas ou em condições de gatilhos. Se você quer adicionar informações aos tickets para contextualizar o agente, recomendamos usar campos personalizados.
- Limite o número de valores possíveis para uma variável. Valores demais podem causar comportamentos inesperados.
- Mantenha as opções de valores curtas para evitar que fiquem truncadas como tags.
- Evite usar caracteres especiais nos valores.