Sobre
Para configurar o Agente Bot é preciso construir um fluxo de bot e inseri-lo nele, além de escolher a ação que o bloco vai realizar e configurá-la. Com o Agente Bot o usuário não passará pela experiência de mudar de conversa nem de janela de chatbot, tornando o fluxo mais fluido e amigável. Uma vantagem de usar esse fluxo no WhatsApp é que você precisará de apenas um único número.
É importante ressaltar que a caixa de entrada no Toolzz Chat deve ser sempre do tipo API.
Criando a variável "envId"
1º passo: em um bloco de variável conectado no fluxo ativo, crie a variável obrigatória para armazenar o Environment ID, com o nome de envId, para que seu fluxo funcione corretamente. Isso permite que o histórico de conversa entre o usuário e o bot seja enviado para o agente no Toolzz Chat.
Criando variáveis adicionais para WhatsApp
Se desejar integrar seu bot no WhatsApp, será necessário cria variáveis no início do fluxo para armazenar o nome do contato e o número de WhatsApp. Estas variáveis capturam essas informações diretamente da conta do cliente no WhatsApp, sem que ele precise fornecê-las ao acionar o bot.
A variável deve ser nomeada como waContactName, com o campo "Valor" configurado como "Contact name". Da mesma forma, para a variável waPhoneNumber, o "Valor" deve ser "Phone number".
🚨Atenção!
Os nomes das variáveis devem estar exatamente como escrito acima para que seu fluxo funcione corretamente. Além disso, se essas variáveis forem usadas em plataformas diferentes do WhatsApp, elas ficarão em branco, mas não causarão erros.
Configurando o bloco "Agent Bot"
2º passo: clique no bloco de integrações "Agent Bot", segure e arraste para a tela de construção de fluxo do bot.
Dê um nome para o novo grupo (isso ajuda na identificação).
3º passo: clique em "Configure" e depois em "Select Toolzz Chat Account".
Caso ainda não tenha realizado uma conexão com o Toolzz Chat, você precisará criar uma. Clique em "Create new", preencha o nome da sua conta no Toolzz Chat e insira sua chave API.
Encontre a chave API do Toolzz Chat através do caminho: foto de perfil, localizada no canto inferior esquerdo da tela > Configurações do perfil > role a página até encontrar a opção Token de Acesso > copie o código.
Configurando as ações do Agent Bot
Após fazer a conexão inicial com o Toolzz Chat, você precisará adicionar blocos de Agent Bot ao longo do fluxo para executar diferentes ações do bot.
❗Informações Importantes
A cada novo bloco de Agent Bot adicionado ao fluxo é preciso selecionar a conta do Toolzz Chat que foi conectada anteriormente;
Em todo bloco de Agent Bot é preciso escolher a ação que ele vai executar através do botão "Select an action". As ações podem variar conforme as necessidades do fluxo;
Cada ação do Agent Bot terá campos de configurações diferentes. Algumas possuem campos específicos com informações necessárias para que o Toolzz Chat pesquise e localize os dados relevantes a serem coletados. Os campos obrigatórios estão marcados com asterisco “*” na cor vermelha.
Sempre use a opção "Salvar resultado em uma variável" para armazenar as informações coletadas. Esse passo é fundamental, pois as variáveis salvas serão utilizadas para executar as ações de outros blocos do AgentBot no fluxo.
Configurar conta do Toolzz Chat
Essa deve ser a primeira ação no fluxo: coletar o accountid e o pubSubToken do Toolzz Chat. Armazene essas informações em variáveis para uso futuro.
4º passo: após selecionar a conta do Toolzz Chat e a ação "Configurar conta do Toolzz Chat", clique em “Salvar resultado em variáveis” e depois em "Add" para incluir campos de variáveis.
Em um campo de variável selecione “Accountid” e em outro “Pubsubtoken” para armazenar essas informações do Toolzz Chat. Nos campos "Selecione uma variável" correspondentes, armazene essas informações em variáveis para uso posterior.
Criar/buscar contato no Toolzz Chat
Cria ou encontra um contato no Toolzz Chat. Se o contato já existir, ele será localizado; se não, será criado. Recebe informações importantes sobre o contato para outras etapas.
🚨Atenção!
Antes de configurar esta ação, você precisa ter coletado o e-mail do usuário e salvado esta informação em uma variável.
5º passo: após selecionar a conta do Toolzz Chat e a ação "Criar/buscar contato no Toolzz Chat". Preencha os campos obrigatórios
"Account ID" com a variável "accountid" coletada no bloco “Configurar conta do ToolzzChat”.
"Variável do email do contato" com a variável de e-mail do usuário coletada anteriormente.
"Variavel do número do contato" com a variável de telefone que deve ser coletada anteriormente no fluxo.
Clique em “Salvar resultado em variáveis”. Em um campo selecione “contactId” e no outro “contactName” para armazenar essas informações. Nos campos "Selecione uma variável" correspondentes, armazene essas informações em variáveis para uso posterior.
Definir inbox
Define a caixa de entrada onde as conversas serão armazenadas. Isso ajuda a organizar as mensagens recebidas e a garantir que os dados sejam utilizados nas etapas seguintes.
6º passo: após selecionar a conta do Toolzz Chat e a ação "Definir inbox". Preencha os campos obrigatórios
"Account ID" com a variável "accountid" coletada no bloco “Configurar conta do Toolzz Chat”.
"Nome da Inbox" deve corresponder exatamente ao nome da caixa de entrada cadastrada no Toolzz Chat.
Clique em “Salvar resultado em variáveis”. Selecione “inboxId” e no campo "Selecione uma variável" armazene essa informação em uma variável para uso posterior.
❗Informações importantes
A caixa de entrada deve ser do tipo API. Para criar e configurar uma caixa de entrada API, consulte o artigo COMO CRIAR E CONFIGURAR CAIXA DE ENTRADA API NO TOOLZZ CHAT.
Se quiser usar o Agent Bot integrado com o WhatsApp:
após embedar o bot no WhatsApp uma "Credencial de Webhook" será gerada para este número de WhatsApp que está sendo usado. Essa credencial deve ser inserida no formulário de criação de caixa de entrada de API, no Toolzz Chat, no campo "URL do Webhook". Encontre essa URL acessando
Configurações e membros no menu superior > Credenciais > Webhook URL.
Para sabe como incorporar seu bot no WhatsApp acesse o artigo COMO PERSONALIZAR URL DE COMPARTILHAMENTO E INCORPORAR O BOT.
Se o Agent Bot não for integrado com o WhatsApp: no campo "URL do Webhook" no formulário de criação de caixa de entrada e API, no Toolzz Chat, deve ser colocada a URL de compartilhamento. Saiba como encontrá-la clicando aqui.
Definir conversa no Toolzz Chat
Cria uma nova conversa no Toolzz Chat usando as informações do contato e da caixa de entrada. Recebe dados importantes para futuras ações no fluxo.
7º passo: após selecionar a conta do Toolzz Chat e a ação "Definir conversa no Toolzz Chat". Preencha os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do Toolzz Chat”;
"ContactId" com a variável correspondente coletada no bloco “Configurar conta do Toolzz Chat”;
"Inbox ID" com a variável correspondente coletada no bloco “Definir inbox”.
Clique em “Salvar resultado em variáveis”. Selecione “conversationID” e no campo "Selecione uma variável" armazene essa informação em uma variável para uso posterior.
Enviar histórico de mensagens para o Toolzz Chat (opcional)
Envia o histórico das mensagens do bot para a conversa no Toolzz Chat. Isso ajuda o atendente a ver o que já foi conversado e usar essas informações para continuar o atendimento.
Após selecionar a conta do Toolzz Chat e a ação "Enviar histórico de mensagens para o Toolzz Chat". Preencha os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do Toolzz Chat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no Toolzz Chat”.
Clique em “Nome da variável”, depois em "Add". Selecione uma variável para enviar o resultado como histórico de conversa. Se quiser enviar mais variáveis, basta adicionar mais campos.
❗Informações importantes:
O bloco "Enviar histórico" deve sempre vir após o bloco "Definir conversa";
Nunca deixe uma variável vazia;
Sempre que usar o bloco de variáveis, inclua ao menos uma variável para envio;
Quando nenhuma variável é inserida, o histórico ficará em branco, logo não será enviado nada para o Chat.
Enviar protocolo para o Toolzz Chat (opcional)
Envia um número de protocolo para a conversa no Toolzz Chat. Esse número ajuda a identificar a conversa facilmente e é importante para o gerenciamento da conversa.
Crie um atributo de conversa personalizado no Toolzz Chat com o nome "Protocolo" e a chave "protocolo" para alimentar o campo automaticamente.
Após selecionar a conta do Toolzz Chat e a ação "Enviar protocolo para o Toolzz Chat". Preenchas os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do Toolzz Chat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no Toolzz Chat”.
Clique em “Salvar protocolo em variáveis”. No campo "Selecione uma variável" salve o resultado em uma variável.
❗Informação importante: se estiver usando o bloco "Assumir Atendimento", o bloco de "Enviar protocolo" deve vir depois, nunca antes.
Assumir atendimento (opcional)
Permite que um atendente do Toolzz Chat assuma o controle da conversa passada pelo bot. Isso é útil para equipes de vendas que precisam usar as informações recebidas para continuar o atendimento. As conversas são passadas pelo bot através de um modal em tela.
❗Informações importantes
O agente poderá assumir as conversas a partir de uma fila, sem a opção de escolher qual atendimento vai aceitar. Ao clicar em “confirmar” para assumir um atendimento, ele aceitará o primeiro da fila, e o modal será fechado, reaparecendo apenas quando uma nova conversa estiver na fila.
Mais indicado para time de vendas comissionada.
Após selecionar a conta do Toolzz Chat e a ação "Assumir atendimento". Preencha os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do Toolzz Chat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no Toolzz Chat”.
"Bot Agent ID" com o id do agente.
Para obter o "Bot Agent ID", acesse as configurações do Toolzz Chat > agentes > localize o Bot Agente da sua empresa > clique em editar e obtenha o id dele.
Habilite a função "Requer assistência humana" e preencha ao menos um filtro para indicar para quem o modal deve ser exibido:
Nome do Time;
Nome da Marca;
Nome da Caixa de Entrada;
Tipo de Agente (tipo de perfil atribuído ao usuário).
🚨Atenção! Os nomes dos filtros devem ser exatamente iguais aos nomes correspondentes no Toolzz Chat. Caso contrário, o modal não será disparado.
Salve o resultado em uma variável. Esta variável deve ter o nome exato da informação coletada, ou seja, crie uma variável chamada “requireHumanAssistance” para armazenar essa informação.
Dica para Uso em Múltiplas Plataformas
8º passo: para utilizar o mesmo fluxo tanto no WhatsApp, quanto em outras plataformas, adicione uma condicional para identificar se o atendimento é via WhatsApp e ajuste o fluxo conforme necessário.
💡Dica
Conheça mais sobre os blocos de condicionais citado acima no artigo CONDICIONAIS - TOOLZZ BOTS.
Configurações para Web
Insira o bloco de integrações "Agent Bot".
Clique para configurar e, primeiro, selecione um Token;
Depois, escolha a ação "Modo Chat";
Preencha os campos "Account ID", "Conversation ID" com as variáveis correspondentes coletadas anteriormente;
Em "PubSub Token" selecione a variável criada no bloco "Configurar conta" para armazenar esta informação;
Selecione sua API Key configurada no bloco "Configurar conta".
Configurações WhatsApp
Insira o bloco de input de "Texto" e no campo "Salve a resposta em uma variável" escolha uma variável já existe ou crie uma nova.
Insira o bloco de integrações "Agent Bot".
Clique para configurar e, primeiro, selecione sua conta Toolzz Chat já configurada;
Depois, escolha a ação "Enviar mensagem para o Toolzz Chat";
No campo "Message" selecione a mesma variável inserida no bloco de texto anterior;
Preencha os campos "Account ID" e "Conversation ID" com as variáveis correspondentes coletadas anteriormente.
Adicione o bloco de condicional "Pular”. No campo "Select a group" selecione o nome do grupo (bloco de texto + agent bot) criado anteriormente para que a troca de mensagens seja continua.
No final, o fluxo para múltiplas plataformas ficará assim:
Preenchimento automático de atributos de conversa no Toolzz Bots
Para criar um fluxo no bot que envie valores de variáveis para alimentar atributos personalizados da conversa no Toolzz Chat, siga os passos abaixo.
1º passo: insira o bloco "HTTP request" após o bloco "Enviar mensagem para o Toolzz Chat".
🚨Atenção! É essencial que este bloco seja inserido após a criação da conversa, pois o conversationId já deve ter sido coletado.
2º passo: clique em "Configure".
No campo "Paste URL" insira a URL do endpoint da API, substituindo ${accountId} e ${conversationId} da URL pelas variáveis correspondentes ao ID da conta e ID da conversa, respectivamente:
https://chat.toolzz.ai/api/v1/accounts/${accountId}/conversations/${conversationId}/custom_attributes
💡Dica
Passe o mouse sobre as configurações do bloco e clique no ícone de duas setas opostas para expandi-lo, facilitando a substituição das variáveis na URL.
3º passo: termine a configuração do bloco.
Ative as configurações avançadas clicando na chave de ativação "Advanced configuration";
Em "Method" selecione a opção POST.
Clique em "Headers" para expandir e depois clique em "+Add a value".
Preencha o campo "Key" com api_access_token
Preencha o campo "Value" com o token do seu perfil no Toolzz Chat.
Cliquem no botão "+Add a value" para adicionar mais uma entrada no header.
Preencha o campo "Key" com Content-Type
Preencha o campo "Value" com application/json
Clique em "Body" para expandir a opção.
Clique na chave de ativação da opção "Custom body".
No campo de texto, insira o modelo de JSON abaixo, substituindo
[chave]pela chave do atributo personalizado criado no Toolzz Chat e[valor]pela variável que coleta a informação correspondente no Toolzz Bots.
{
"custom_attributes": {
"[chave]": "[valor]"
}
}
Encontre a chave API do Toolzz Chat através do caminho: foto de perfil, localizada no canto inferior esquerdo da tela > Configurações do perfil > role a página até encontrar a opção Token de Acesso > copie o código.
❗Informação importante: onde encontrar a [chave] do atributo no Toolzz Chat
Encontre a chave do atributo do Toolzz Chat através do caminho: menu lateral > Configurações > Atributos personalizados > coluna "CHAVE" > copie a chave.
Se você ainda não sabe como criar um atributo personalizado, consulte o artigo COMO CRIAR E GERENCIAR ATRIBUTOS PERSONALIZADOS NO TOOLZZ CHAT.
Pronto! Agora você já sabe como usar o Agent Bot para integrar o Toolzz Bots e o Toolzz Chat.