const app=new App ({ token: process.env.SLACK_BOT_TOKEN, SignSecret: process.env.SLACK_SIGNING_SECRET, socketMode: true,//habilita o seguinte para usar o modo socket appToken: process.env.APP_TOKEN
});

Com isso concluído, todas as solicitações para o seu servidor de desenvolvimento agora acontecerão via WebSockets e não HTTP.

Comandos Slash

Agora que concedemos ao nosso aplicativo algumas permissões e configuramos um servidor e um URL público, a próxima etapa é permitir que ele escute Comandos Slash . No Slack, você pode acionar uma ação enviando um comando como uma mensagem. Por exemplo, um Slash Command pode ser /knowledge para mostrar todo o conteúdo em nossa base de conhecimento.

Para ativar os comandos Slash, clique na opção de menu Comandos Slash na barra lateral esquerda. Em seguida, clique no botão Criar Novo Comando . Preencha o formulário utilizando a imagem abaixo como guia. O URL de solicitação deve ser o URL personalizado gerado automaticamente pelo ngrok para seu aplicativo.

Clique no botão salvar localizado na parte inferior direita da tela. O Slack solicitará que você reinstale o aplicativo em sua área de trabalho para que as alterações tenham efeito. Siga essas instruções e seu comando /knowledge deve agora ser criado!

Testando o comando /knowledge

Agora, podemos testar o comando /knowledge de dentro do Slack. Primeiro, vamos criar um ouvinte para ouvir eventos que incluem o comando /knowledge . Em seu arquivo app.js , adicione o seguinte código:

 const {App}=require ("@ slack/bolt");
require ("dotenv"). config ();
//Inicializa seu aplicativo com seu token de bot e segredo de assinatura
const app=new App ({ token: process.env.SLACK_BOT_TOKEN, SignSecret: process.env.SLACK_SIGNING_SECRET,
}); app.command ("/knowledge", async ({command, ack, say})=> { tentar { aguardar ack (); diga ("Yaaay! esse comando funciona!"); } catch (erro) { console.log ("err") console.error (erro); }
}); (assíncrono ()=> { porta const=3000 //Inicie seu aplicativo aguarde app.start (process.env.PORT || port); console.log (`⚡ O aplicativo Slack Bolt está sendo executado na porta $ {port}!`);
}) ();

Vamos testar nosso código! No aplicativo Slack, você deve ver o aplicativo ask-ztc-bot logo abaixo da seção Seus aplicativos . Clique aqui para enviar mensagens ao bot. Digite /conhecimento e pressione Enter. Você deve receber uma mensagem dizendo “Yaaay! esse comando funciona! ”.

Mensagens no Slack

Também podemos mencionar ou @ o bot e incluir um texto adicional a ser enviado ao bot como uma mensagem.
No Slack, mencionar um aplicativo é um tipo de evento . Também podemos ouvir outros eventos , como quando novos usuários entram em um canal, um novo canal é criado, etc. Para nosso bot/aplicativo para ouvir eventos, precisamos configurar assinaturas de eventos.

Inscrições de eventos

Para habilitar eventos, navegue até Recursos> Assinaturas de eventos no painel do aplicativo Slack. Ative o botão Ativar eventos .

Para que o Slack notifique nosso aplicativo sobre eventos, precisaremos fornecer um URL público que o Slack possa verificar. Copie

 app.message ("hey", assíncrono ({command, say})=> { tentar { diga ("Yaaay! esse comando funciona!"); } catch (erro) { console.log ("err") console.error (erro); }
});

//corresponde a qualquer string que contenha a string hey
app.message (/hey/, async ({command, say})=> { tentar { diga ("Yaaay! esse comando funciona!"); } catch (erro) { console.log ("err") console.error (erro); }
});

Primeiro, criaremos um minibanco de dados para armazenar as perguntas e respostas mais frequentes. Nosso banco de dados será um arquivo JSON simples em nosso servidor. Você pode considerar um DBMS como MongoDB se seus requisitos de dados se tornarem grandes e complexos.

No diretório raiz do seu projeto, crie um arquivo db.json e adicione os seguintes dados:

 { "dados":[ { "palavra-chave":"produtos", "question":"Quantos produtos diferentes vendemos na ZTC?", "resposta":"A ZTC tem atualmente 3 produtos no mercado. Chá de hibisco com um toque de limão/abacaxi ou gengibre." }, { "palavra-chave":"produtos", "question":"Quais lojas online vendem nossos produtos?", "resposta":"Amazon, Macy's e Shoprite." }, { "palavra-chave":"pessoas", "question":"Quantas pessoas trabalham na ZTC?", "answer":"A ZTC emprega atualmente 250 pessoas de 21 países diferentes." }, { "palavra-chave":"redefinir senha", "question":"Como faço para redefinir minha senha?", "answer":"Para redefinir a senha do e-mail de sua empresa, ligue para Ola no ramal 8099." } ]
}

Criamos um conjunto de quatro perguntas com suas respostas e as agrupamos em determinadas palavras-chave para fácil referência.

Respondendo a comandos

Com nosso banco de dados JSON configurado, precisamos de uma maneira de ler os dados nele. Usaremos o módulo interno fs do Node.js para ler o arquivo db.json . No nível superior do seu arquivo app.js , adicione o seguinte bloco de código:

//requer o módulo fs que é integrado ao Node.js
const fs=require ('fs')
//obtenha os dados brutos do arquivo db.json
let raw=fs.readFileSync ('db.json');
//analisa os bytes brutos do arquivo como JSON
let faqs=JSON.parse (bruto);

Agora, podemos escrever o código para responder ao comando /knowledge . Este comando exibirá todas as perguntas e respostas em nosso banco de dados para o usuário:

 app.command ("/knowledge", async ({command, ack, say})=> { tentar { aguardar ack (); deixe mensagem={blocos: []}; faqs.data.map ((faq)=> { message.blocks.push ( { tipo:"seção", texto: { digite:"mrkdwn", texto:"* Pergunta *", }, }, { tipo:"seção", texto: { digite:"mrkdwn", texto: faq.question, }, }, { tipo:"seção", texto: { digite:"mrkdwn", texto:"* Resposta *", }, }, { tipo:"seção", texto: { digite:"mrkdwn", texto: faq.answer, }, } ); }); dizer (mensagem); } catch (erro) { console.log ("errar"); console.error (erro); }
});

Estamos usando blocos (fornecidos pela API Slack Bolt) e marcação para formatar as mensagens que exibiremos aos usuários. Para personalizar ainda mais as mensagens do seu bot quando forem enviadas ao usuário, o Slack fornece um Block Kit Builder that you can use to get your desired template.

You can test this out by typing the command /knowledge in the private conversation with the ask-ztc-bot.

As you can see, it correctly lists all the FAQs in our knowledge base.

Next, we’ll use a simple regular expression to detect if a user has included the keyword products in their question. If they have, we’ll show them FAQs with the keyword products:

app.message(/products/, async ({ command, say })=> { try { let message={ blocks: [] }; const productsFAQs=faqs.data.filter((faq)=> faq.keyword==="products"); productsFAQs.map((faq)=> { message.blocks.push( { type:"section", text: { type:"mrkdwn", text:"*Question ❓*", }, }, { type:"section", text: { type:"mrkdwn", text: faq.question, }, }, { type:"section", text: { type:"mrkdwn", text:"*Answer ✔*", }, }, { type:"section", text: { type:"mrkdwn", text: faq.answer, }, } ); }); say(message); } catch (error) { console.log("err"); console.error(error); }
});

To test this out, send a message to the bot that includes the word products, and the bot will respond with all the information that has to do with the products keyword.

Updating the knowledge base

Finally, we want to give users the ability to add their own data to the knowledge base.

Create a new Slash Command called /update. This command will be called by users to add new data to our knowledge base.

We’ve made a slight change to this command. In the usage hint, we’ve specified that users should separate the different fields using the pipe | character. This way, we can take the input string sent by a user and split it using the pipe character.

Note: If you plan to add your Slackbot to a channel and think that there might be other apps with similar commands to yours, it may be worth creating one command, e.g., /ask-ztc, and having users append an additional string to the command. For example, use /ask-ztc knowledge to display all the FAQs in the knowledge base.

Here’s the code that handles the /update slash command. We update the db.json file by first reading the data in the file and appending the new data sent by the user to it:

app.command("/update", async ({ command, ack, say })=> { try { await ack(); const data=command.text.split("|"); const newFAQ={ keyword: data[0].trim(), question: data[1].trim(), answer: data[2].trim(), }; //save data to db.json fs.readFile("db.json", function (err, data) { const json=JSON.parse(data); json.data.push(newFAQ); fs.writeFile("db.json", JSON.stringify(json), function (err) { if (err) throw err; console.log("Successfully saved to db.json!"); }); }); say(`You've added a new FAQ with the keyword *${newFAQ.keyword}.*`); } catch (error) { console.log("err"); console.error(error); }
});

Let’s test this out!

We’ll call the /update command with the following text: “people | Who should I contact if I’m having issues with my Internet? | Call the IT Department on Ext.9090”.

The /update endpoint will respond with the message:

Now, when we call our /knowledge command, we should see our newly added FAQ as part of the FAQs returned from our database.

And there you have it!

You’ve successfully created a Slackbot that can respond to commands and mentions. It can also accept new data from users and store it in the database.

The source code for this example is available on my GitHub.

Deploying

You can deploy your app to a platform like Heroku in the same way you would deploy a regular Node.js application. Don’t forget to change the URL in the event subscription section to the new one provided by Heroku.

You can visit the Bolt API documentation for your reference.

The post Build a Slackbot in Node.js with Slack’s Bolt API  appeared first on LogRocket Blog.

Source link