使用QQ官方机器人Python SDK和三方框架搭建QQ群聊机器人
文章目录
前言
本文基于 QQ官方Python SDK 和 三方框架aka🐱(进群了解) 搭建QQ群聊机器人,可以实现全局监听群聊。
介绍
QQ官方机器人Python SDK是QQ提供的一个用于搭建QQ机器人的开发工具包。通过使用该SDK,我们可以编写Python代码来实现QQ机器人的各种功能,如在群聊内接收消息、发送消息等。虽然官方机器人已经满足了基本需求,但是给到开发者的权限很少,无法全局监听群聊消息,本文提供将官方和三方机器人融合的python库:QQbot_Python
,实现全局监听的QQ机器人体系。
准备工作
在开始之前,确保你已经具备以下准备工作:
- 已安装Python环境(建议使用Python 3.x版本)
- 拥有一个QQ账号(用于创建三方机器人)
- 获得了官方QQ机器人的APPID和APPSERCET(用于创建官方机器人)
- 安装三方框架aka🐱(用于创建三方机器人)
安装相关SDK
使用pip命令来安装QQ官方机器人Python SDK和三方QQ机器人Python SDK:
pip install qq-botpy QQbot_Python -i https://pypi.org/simple
获取官方QQ机器人的APPID和APPSERCET
在使用SDK之前,我们需要先创建一个QQ官方机器人账号,并获取其账号的APPID和APPSERCET。具体步骤如下:
- 打开 QQ官方机器人管理平台
- 创建一个新的机器人账号,按照 教程 完成相关设置
- 在机器人管理平台中登录刚刚创建的机器人账号,获取其账号的APPID和APPSERCET
配置官方机器人IP白名单
在创建好了QQ机器人账号之后,我们打开 QQ官方机器人管理平台 ,在开发栏中找到开发设置,点击后在界面可以找到IP白名单,在这里你需要配置你的公网IP。如果你是本地开发,你可以使用curl ipconfig.io
或者 公网IP查询网站 来获取你的公网IP(⚠️本地开发时公网IP随时会变化);如果你已经要部署在服务器上面了,一般的云服务器都配置了公网IP。最后,将你获取的公网IP填入QQ官方机器人管理平台并保存即可。
配置三方机器人服务器
你需要安装 三方框架aka🐱(进群下载) ,并且启动正向ws和http监听,ws的端口需要是3001,http的端口需要是3000。
编写机器人代码
接下来,我们开始编写机器人代码。
创建配置文件
在你自己创建的项目的目录下添加配置文件:config.yaml
appid: "" # 填入你在前面步骤获取的APPID
secret: "" # 填入你在前面步骤获取的APPSERCET
机器人监听群聊进行文字回复
首先,分为两种情况:1.你没有配置三方服务器,你将无法享受三方机器人服务。2.你配置了三方机器人并且满足前面提到的要求。
情况一:未配置三方机器人
我们导入botpy库,创建机器人实例,进行群聊事件的监听,示例代码如下:
# -*- coding: utf-8 -*-
import asyncio
import os
import botpy
from botpy import logging
from botpy.ext.cog_yaml import read
from botpy.message import GroupMessage, Message
test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))
_log = logging.get_logger()
class MyClient(botpy.Client):
async def on_ready(self):
_log.info(f"robot 「{
self.robot.name}」 on_ready!")
async def on_group_at_message_create(self, message: GroupMessage):
messageResult = await message._api.post_group_message(
group_openid=message.group_openid,
msg_type=0,
msg_id=message.id,
content=f"收到了消息:{
message.content}")
_log.info(messageResult)
if __name__ == "__main__":
# 通过预设置的类型,设置需要监听的事件通道
# intents = botpy.Intents.none()
# intents.public_messages=True
# 通过kwargs,设置需要监听的事件通道
intents = botpy.Intents(public_messages=True)
client = MyClient(intents=intents)
client.run(appid=test_config["appid"], secret=test_config["secret"]