npm 包 @slack/rtm-api 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

@slack/rtm-api 是 Slack 的一款 Node.js 包，用于建立与 Slack Real Time Messaging API 的实时连接。通过 @slack/rtm-api，前端开发者可以轻松地实现在 Slack 向用户发送消息、创建机器人应用等功能。

安装

在开始项目前，请确保已安装 Node.js 。在终端中输入以下命令安装 @slack/rtm-api：

npm install @slack/rtm-api --save

连接到 Slack

想要使用 @slack/rtm-api 与 Slack 建立实时连接，我们需要一下几个参数：

SLACK_APP_TOKEN：用于授权应用访问您的 Slack 团队所需的安全令牌
SLACK_BOT_TOKEN：用于创建机器人应用的 token
SLACK_CHANNEL_NAME：要将消息发送到的 Slack 频道名称

在您的项目中，创建一个 Slack 实例，然后使用 SLACK_APP_TOKEN 和 SLACK_BOT_TOKEN 配置它：

const { RTMClient } = require('@slack/rtm-api');

const rtm = new RTMClient(SLACK_BOT_TOKEN);

rtm.start().catch(console.error);

使用以下代码订阅特定的 Slack 频道：

rtm.on('ready', async () => {
  const res = await rtm.joinChannel(SLACK_CHANNEL_NAME);
  console.log(`Joined channel ${SLACK_CHANNEL_NAME}`);
});

发送消息

使用以下代码向 Slack 发送消息：

rtm.send({
  text: 'Hello, World!',
  channel: SLACK_CHANNEL_NAME,
});

在频道中发送消息时，您可以使用以下常用选项：

text：消息文本
attachments：消息中的附件信息，例如图片、链接、按钮等
channel：消息发送到的 Slack 频道名称

根据您的需求，在消息发送时填写不同的选项。

示例代码

下面是一个例子，展示如何使用 @slack/rtm-api 连接到 Slack 并发送消息。

-- -------------------- ---- -------
----- - --------- - - --------------------------

----- --- - --- ---------------------------

----- -------- ------ -
  -- -- --- - --- ----- -----
  ----- ------------

  -- -- ----- --
  ----- --- - ----- ------------------------------------
  ------------------- ------- ------------------------

  -- - ----- ----
  ----------
    ----- ------- --------
    -------- ---------------
  ---
-

-------

总结

在本文中，我们介绍了如何使用 @slack/rtm-api 连接到 Slack 并向频道发送消息。希望这个简单的示例能为您提供关于这个 npm 包的更深入了解，以及如何将其用于实际项目中的指导。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/111103