我们通过搭建你的开发环境, 获得一个 Slack API 的聊天机器人令牌,并用 Pyhon 开发一个简单聊天机器人。
我们所需的工具
我们的聊天机器人我们将它称作为“StarterBot”,它需要 Python 和 Slack API。要运行我们的 Python 代码,我们需要:
- Python 2 或者 Python 3
- pip 和 virtualenv 来处理 Python 应用程序依赖关系
- 一个可以访问 API 的免费 Slack 账号,或者你可以注册一个 Slack Developer Hangout team。
- 通过 Slack 团队建立的官方 Python Slack 客户端代码库
- Slack API 测试令牌
当你在本教程中进行构建时,Slack API 文档 是很有用的。
本教程中所有的代码都放在 slack-starterbot 公共库里,并以 MIT 许可证开源。
搭建我们的环境
已经激活的 starterbot 的 virtualenv的命令提示符
这个官方的 slack 客户端 API 帮助库是由 Slack 建立的,它可以通过 Slack 通道发送和接收消息。通过这个pip
命令安装 slackclient 库:
当 pip
命令完成时,你应该看到类似这样的输出,并返回提示符。
在已经激活的 virtualenv 用 pip 安装 slackclient 的输出
我们也需要为我们的 Slack 项目获得一个访问令牌,以便我们的聊天机器人可以用它来连接到 Slack API。
Slack 实时消息传递(RTM)API
Slack 允许程序通过一个 Web API 来访问他们的消息传递通道。去这个 Slack Web API 页面 注册建立你自己的 Slack 项目。你也可以登录一个你拥有管理权限的已有账号。
给你的聊天机器人起名为“starterbot”然后点击 “Add bot integration” 按钮。
添加一个bot integration 并起名为“starterbot”
这个页面将重新加载,你将看到一个新生成的访问令牌。你还可以将标志改成你自己设计的。例如我给的这个“Full Stack Python”标志。
在页面底部点击“Save Integration”按钮。你的聊天机器人现在已经准备好连接 Slack API。
Python 开发人员的一个常见的做法是以环境变量输出秘密令牌。输出的 Slack 令牌名字为SLACK_BOT_TOKEN
:
好了,我们现在得到了将这个 Slack API 用作聊天机器人的授权。
我们建立聊天机器人还需要更多信息:我们的聊天机器人的 ID。接下来我们将会写一个简短的脚本,从 Slack API 获得该 ID。
获得我们聊天机器人的 ID
这是最后写一些 Python 代码的时候了! 我们编写一个简短的 Python 脚本获得 StarterBot 的 ID 来热身一下。这个 ID 基于 Slack 项目而不同。
我们需要该 ID,当解析从 Slack RTM 上发给 StarterBot 的消息时,它用于对我们的应用验明正身。我们的脚本也会测试我们 SLACK_BOT_TOKEN
环境变量是否设置正确。
建立一个命名为 printbotid.py 的新文件,并且填入下面的代码:
-
import os
-
from slackclient import SlackClient
-
-
BOT_NAME = 'starterbot'
-
-
slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))
-
-
if __name__ == "__main__":
-
api_call = slack_client.api_call("users.list")
-
if api_call.get('ok'):
-
# retrieve all users so we can find our bot
-
users = api_call.get('members')
-
for user in users:
-
if 'name' in user and user.get('name') == BOT_NAME:
-
print("Bot ID for '" + user['name'] + "' is " + user.get('id'))
-
else:
-
print("could not find bot user with the name " + BOT_NAME)