Cách xây dựng một Slack Bot chào đón bằng Python

Nhập các thư viện cần thiết

Tạo một tệp Python mới và bắt đầu bằng cách nhập các thư viện bạn đã cài đặt trước đó để bạn có thể sử dụng chức năng của chúng trong mã của mình.

 import slack_sdk as slack
import os
from pathlib import Path
from dotenv import load_dotenv
from flask import Flask
from slackeventsapi import SlackEventAdapter 

Mô-đun os của Python đi kèm với ngôn ngữ, vì vậy bạn không cần cài đặt nó. SlackEventAdapter là một lớp từ mô-đun slackeventsapi xử lý các sự kiện từ API Slack.

Thiết lập Bot Slack

Tạo hai biến trong tệp .env. Đặt tên cho một SLACK_BOT_TOKEN và gán cho nó Mã thông báo OAuth của Người dùng Bot. Đặt tên cho cái còn lại là SLACK_SIGNING_SECRET và gán bí mật ký cho nó. Quay lại tệp Python và tạo một đối tượng Flask. Sau đó tải các biến môi trường từ tệp .env bằng hàm load_dotenv từ mô-đun dotenv.

 app = Flask(__name__)
env_path = Path('.') / '.env'
load_dotenv(dotenv_path=env_path)
 

Tạo một cá thể slack_event_adapter. Nó sẽ xử lý các sự kiện từ API Slack, sử dụng biến môi trường SLACK_SIGNING_SECRET để xác thực các yêu cầu.

 slack_event_adapter = SlackEventAdapter(os.environ['SLACK_SIGNING_SECRET'],
                                        '/slack/events', app)
 

/slack/events là điểm cuối mà API Slack sẽ sử dụng để gửi sự kiện.

Tạo một phiên bản WebClient sẽ gửi tin nhắn đến API Slack. Thực hiện lệnh gọi API để truy xuất ID của bot.

 client = slack.WebClient(token=os.environ['SLACK_BOT_TOKEN'])
BOT_ID = client.api_call("auth.test")['user_id'] 

Thiết lập tin nhắn bạn sẽ gửi cho người dùng mới tham gia kênh. Khởi tạo một bộ trống sẽ theo dõi những người dùng được hoan nghênh.

 GREETING_MESSAGE = "Hello {user_name}, welcome to the {channel_name} " 
                   "channel! We're excited to have you here."
welcomed_users = set()
 

Bạn có thể tùy chỉnh lời chào theo ý thích của mình.

Tạo một chức năng để xử lý sự kiện “Thành viên đã tham gia kênh”

Thiết lập một trình lắng nghe sự kiện. Nó sẽ lắng nghe sự kiện member_joined_channel.

 @slack_event_adapter.on('member_joined_channel')
 

Xác định chức năng mà bạn sẽ gọi khi người dùng tham gia kênh. Sử dụng chức năng để trích xuất ID người dùng và ID kênh từ dữ liệu sự kiện. Kiểm tra xem người dùng có phải là người mới đối với kênh hay không. Nếu không, hãy lấy thông tin về người dùng và kênh bằng cách sử dụng lớp WebClient. Tạo một tin nhắn chúc mừng cá nhân. Gửi lời chào đến kênh

 def handle_member_joined_channel(event_data):
    user_id = event_data['event']['user']
    channel_id = event_data['event']['channel']
    
    if user_id not in welcomed_users:
        welcomed_users.add(user_id)
        user_info = client.users_info(user=user_id)
        user_name = user_info['user']['name']
        channel_info = client.conversations_info(channel=channel_id)
        channel_name = channel_info['channel']['name']
        greeting = GREETING_MESSAGE.format(user_name=user_name,
                                          channel_name=channel_name)
        client.chat_postMessage(channel=channel_id, text=greeting)
 

event_data chứa tất cả thông tin về sự kiện mà người dùng đã tham gia kênh.

Khởi động ứng dụng Flask và chạy tập lệnh. Nếu chạy dưới dạng chương trình chính (không được nhập dưới dạng mô-đun), hãy chạy ở chế độ gỡ lỗi và lắng nghe trên cổng 5000.

 if __name__ == "__main__":
    app.run(debug=True, port=5000) 

Chế độ gỡ lỗi tự động tải lại ứng dụng khi bạn thay đổi mã. Không sử dụng chế độ gỡ lỗi trong môi trường sản xuất, chế độ này có thể làm lộ thông tin nhạy cảm và khiến ứng dụng của bạn dễ bị tấn công. Chạy ứng dụng của bạn. Nó sẽ chạy như một máy chủ cục bộ trên cổng 5000.

Kết nối logic với Bot của bạn

Sau khi tạo logic, bây giờ bạn cần kết nối với bot trong không gian làm việc của mình. Điều này sẽ cho phép nó sử dụng logic này để thực hiện các thao tác trong không gian làm việc của bạn. Bắt đầu bằng cách tải xuống và chạy Ngrok. Ngrok sẽ giúp bạn hiển thị máy chủ web cục bộ của mình với internet.

Sau khi chạy nó, hãy sử dụng lệnh sau để ánh xạ địa chỉ máy chủ cục bộ của bạn sang địa chỉ của Ngrok.

 ngrok http 500 

Sao chép địa chỉ Ngrok ánh xạ tới máy chủ cục bộ của bạn.

Điều hướng đến trang web API Slack. Bên dưới Đăng ký sự kiện tính năng, kích hoạt sự kiện. Dưới URL yêu cầu nhập địa chỉ Ngrok theo sau là /slack/sự kiện. Điều này sẽ trỏ đến điểm cuối của bạn.

Sau đó đăng ký sự kiện member_joined_channel. Điều này sẽ thông báo cho bot của bạn mỗi khi người dùng tham gia một kênh. Bấm vào Lưu thay đổi. Slack sẽ tự động thêm phạm vi bạn cần để đăng ký sự kiện này. Mỗi khi bạn thay đổi một phạm vi, bạn sẽ phải cài đặt lại ứng dụng của mình trong không gian làm việc.

Nhấp vào cài đặt lại ứng dụng của bạn.

Kiểm tra Bot của bạn

Chuyển đến không gian làm việc của bạn. Chuyển đến kênh bạn muốn sử dụng bot. Gửi tin nhắn trực tiếp đến bot. Ví dụ @Welcoming Bot. Một lời nhắc thêm bot vào kênh sẽ bật lên. Nhấp vào thêm.

Giờ đây, mỗi khi người dùng mới tham gia kênh, bot sẽ gửi thông báo chào mừng.

Hình ảnh trên cho thấy bot đang chào đón người dùng mới đến với kênh.

Tận dụng tối đa không gian làm việc chùng của bạn

Slack bot không phải là cách duy nhất để mở rộng chức năng của nền tảng nhắn tin Slack. Phương pháp khác là tích hợp các công cụ của bên thứ ba với Slack. Họ cung cấp chức năng bổ sung trong nền tảng.

Làm quen với những tích hợp này vì chúng sẽ tăng năng suất của bạn trong Slack.