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 experiencia de mudar de conversa nem de janela de chatbot, tornando o fluxo mais fluido e amigável.
Lembrando 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
2º passo: se deseja integrar seu bot no WhatsApp, será necessário criar as variáveis para armazenar o "WaContacName" e "PhoneNumber" no início do fluxo bot. Estas variáveis são usadas para coletar o número e o nome diretamente da conta do WhatsApp do cliente quando o bot é acionado.
Os nomes das variáveis devem ser WaContacName e PhoneNumber para que seu fluxo funcione corretamente
❗Informação importante: 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"
3º passo: clique no bloco de integrações "Agent Bot" e arraste para a tela de edição do bot para inseri-lo no fluxo do bot.
Dê um nome para o novo grupo (isso ajuda na identificação).
4º 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 Agente 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 para informações necessárias para que o ToolzzChat 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
Deve ser a primeira ação no fluxo. Coleta accountid e pubSubToken do Toolzz Chat. Armazene essas informações em variáveis para uso posterior.
5º 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.
6º passo: após selecionar a conta do Toolzz Chat e a ação "Criar/buscar contato no Toolzz Chat". Preenchas 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.
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.
7º 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 ToolzzChat”.
"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 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 Agent Bot não integrado com o WhatsApp: no campo "URL do Webhook" no fomulá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.
8º passo: após selecionar a conta do Toolzz Chat e a ação "Definir conversa no Toolzz Chat". Preenchas os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"ContactId" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"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 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.
9º passo: após selecionar a conta do Toolzz Chat e a ação "Enviar histórico de mensagens para o Toolzz Chat". Preenchas os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no ToolzzChat”.
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.
10º passo: 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 ToolzzChat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no ToolzzChat”.
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, aceitará o primeiro da fila e o modal vai fechar e só aparecerá novamente quando uma nova conversa estiver na fila.
Mais indicado para time de vendas comissionada.
11º passo: após selecionar a conta do Toolzz Chat e a ação "Assumir atendimento". Preenchas os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no ToolzzChat”.
Bot Agent ID: para obter o BotAgentId, acesse as configurações do chat > agentes > localize o Bot Agente da sua empresa > clique em editar e obtenha o id dele.
12º passo: 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 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 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.
Enviar mensagem para o Toolzz Chat
Envia uma mensagem para o Toolzz Chat. Pode ser uma mensagem fixa ou uma que você escolhe dinamicamente, com base nas informações importantes recebidas.
13º passo: após selecionar a conta do Toolzz Chat e a ação "Enviar mensagem para o Toolzz Chat". Preenchas os campos obrigatórios
"Message" com a mensagem que deseja enviar. Voce pode selecionar variáveis para enviar valores dinâmicos;
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no ToolzzChat”.
Receber mensagem do Toolzz Chat
Recebe e armazena mensagens de resposta do atendente do Toolzz Chat. Essas mensagens são então exibidas para o usuário e usadas para ajustar o fluxo de atendimento.
Exiba a mensagem ao usuário utilizando um bloco de texto.
Use a variável armazenada do bloco de configuração de conta para o campo "PubSub Token".
14º passo: após selecionar a conta do Toolzz Chat e a ação "Receber mensagem para o Toolzz Chat". Preenchas os campos obrigatórios
"Account ID" com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
PubSub Token com a variável correspondente coletada no bloco “Configurar conta do ToolzzChat”;
"Conversation ID" com a variável correspondente coletada no bloco "Definir conversa no ToolzzChat”.
Clique em “Salvar resultado em variáveis”, depois em "Add". No campo "Selecione uma variável" crie a variável que vai armazenar a resposta do agente.
Gerenciando conversas
Identificar Conversa Resolvida
6º passo: adicione um bloco de "Condição" logo após o bloco "Receber Mensagem do Toolzz Chat" para verificar se a resposta do atendente contém a string "!end".
Se a condição for verdadeira, adicione um bloco de texto para informar ao usuário que o atendimento foi encerrado.
Se a condição for falsa, exiba a mensagem enviada pelo atendente para o usuário.
Troca Contínua de Mensagens
7º passo: se a conversa não estiver resolvida, adicione um bloco de "Pular" para retornar ao bloco de enviar mensagem do usuário para o Toolzz Chat.
❗Informação importante: se estiver usando o bot no WhatsApp, o bloco de coleta de mensagem do atendente não é necessário, pois as mensagens são automaticamente repassadas.
Dica para Uso em Múltiplas Plataformas
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.
❗Informação importante: quando o fluxo não é pelo WhatsApp, a interação entre cliente e atendente será sempre uma mensagem de cada vez. No WhatsApp, as mensagens são automaticamente recebidas e repassadas, mesmo que em sequência.
💡Dica
Conheça mais sobre os blocos de condicionais citados acima no artigo CONDICIONAIS - TOOLZZ BOTS.
Exemplo de um fluxo completo de Agent Bot:
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 conversa para o ToolzzChat".
🚨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: cliquem 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
🚨Antenção! Substitua ${accountId} e ${conversationId} da URL pelas variáveis correspondentes ao ID da conta e ID da conversa, respectivamente.
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 "Header" para expandir e depois clique em "+Add a value".
Preencha o campo "Key" com api_access_token
Preencha o campo "Value" como token do seu perfil no ToolzzChat.
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.
Cliquem no botão "+Add a value" para adicionaor 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 aticaçã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 ToolzzChat e[valor]pela variável que coleta a informação correspondente no Toolzz Bots.
{
"custom_attributes": {
"[chave]": "[valor]"
}
}
❗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 > Atibutos personalizados > coluna "CHAVE" > copie a chave.
Se você não 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 intergrar o Toolzz Bots e o Toolzz Chat.