As variáveis foram projetadas para armazenar informações relacionadas a uma conversa. Essas informações podem ser originadas pelo interlocutor, por uma API externa ou pelo canal do usuário em uso.
Detalhes sobre variáveis
Criação e gerenciamento: As variáveis do Flow Builder podem ser criadas e editadas na página de gerenciamento de variáveis.
Escopo global: As variáveis do Flow Builder têm escopo global dentro de um chatbot. Depois que uma variável é criada ou importada (por clonagem) para um chatbot, ela fica disponível para uso em qualquer Use Case desse chatbot.
Integração com o Advanced Builder: As variáveis coletadas usando o Flow Builder podem ser utilizadas no Advanced Builder, inclusive impressas em uma resposta, usadas em condições ou enviadas por meio de uma conexão de API. Se uma variável do Flow Builder e uma variável do Advanced Builder tiverem o mesmo nome, o sistema dará prioridade à variável do Flow Builder.
Uso em uma única direção: As variáveis coletadas com o Advanced Builder não podem ser usadas no Flow Builder.
Exclusão: As variáveis do Flow Builder podem ser excluídas desde que não estejam em uso em um fluxo (as variáveis do sistema não podem ser excluídas).
Categorias de variáveis
As variáveis do Flow Builder são categorizadas em três tipos:
1. Variáveis personalizadas
Cor: Roxo na plataforma ViaSay.
Criação: Podem ser declaradas na página de gerenciamento de variáveis ou nas etapas de entrada do usuário, upload de arquivo e API.
Atualização do valor: Os valores podem ser atualizados nas etapas de entrada do usuário, upload de arquivo e API.
2. Variáveis do canal do usuário
Cor: Amarelo na plataforma ViaSay.
Criação: Podem ser declaradas somente na página de gerenciamento de variáveis.
Atualização do valor: Os valores só podem ser atualizados pelo lado do canal do usuário (por exemplo, no script de integração do widget ou pelo WhatsApp Push). O Flow Builder não pode modificar o valor de user_channel_variables.
Exemplo: se o status de um usuário mudar durante uma conversa (por exemplo, se ele fizer login), o site poderá enviar variáveis adicionais pelo canal do usuário para oferecer uma experiência mais personalizada.
Restrições de nomenclatura: Não são permitidas letras maiúsculas, espaços ou símbolos (exceto sublinhados). A convenção de nomenclatura recomendada é lower_snake_case.
Consistência: A nomenclatura no script de integração do widget ou no WhatsApp Push deve corresponder exatamente à nomenclatura na plataforma.
👍 As variáveis do canal do usuário são ideais para criar cenários mais rápidos e personalizados para os usuários ou para acessar recursos de API (por exemplo, passar parâmetros como user_id ou tokens do seu site para o chatbot).
Consulte esta página para saber como funciona.
3. Variáveis do sistema
Cor: Vermelho na plataforma ViaSay.
Restrições: Não podem ser editadas (renomeadas ou excluídas).
Criação e atualização: Podem ser declaradas e atualizadas somente pelas equipes da ViaSay.
Lista completa de variáveis do sistema
Nome | Descrição | Exemplos de formato do valor |
|---|---|---|
bot_language | Idioma usado pelo chatbot em uma determinada conversa. | "fr_FR"; "en_US" |
chatter_browser_language | Idioma configurado como preferencial no navegador do interlocutor. | "fr_FR"; "en_US" |
user_channel_type | Tipo de canal pelo qual o interlocutor está se comunicando. | "widget"; "whatsapp"; "facebook_messenger"; "message_trigger_interface" |
user_channel_uuid | ID do canal do usuário pelo qual o interlocutor está falando. | "0a3e08d1-1111-48fb-84b6-e22d011573a9" |
chatter_start_url | URL da página do site onde a conversa começou. | |
fb_messenger_first_name | Nome do interlocutor no contexto do Facebook Messenger. | "Mickey" |
fb_messenger_last_name | Sobrenome do interlocutor no contexto do Facebook Messenger. | "Mouse" |
fb_messenger_id | ID de usuário do interlocutor no contexto do Facebook Messenger. | "5778711235598645" |
fb_messenger_ref | Parâmetros de URL compartilhados pelo Facebook Messenger. | Objeto JSON convertido em string: "{\"key\":\"value\"}" |
last_user_message | A mensagem mais recente do usuário. | "Can I connect from my iPhone?" |
last_bot_message | A mensagem mais recente do bot | "Yes — you can log in from your iPhone by tapping 'Sign In' on the home screen." |
conversation_history | Uma única string concatenada das últimas 10 mensagens (do agente e do usuário) para uma retenção de contexto mais rica. | "agent: Hello! user: Hi, I have a question. agent: Sure, what is it? user: ..." (até 10 trocas) |
*As variáveis de memória são convertidas em strings para chamadas de API.
💡 Encontrando o "user_channel_uuid"
Na plataforma ViaSay, navegue até Integrate > Channels > User Channels e selecione o canal. Você encontrará o
user_channel_uuidno URL, por exemplo, https://chatbot.ViaSay.com/channels/user_channel_uuid.