当前位置： 首页 > article >正文

QQ机器人搭建

article 2024/12/22 16:08:17

使用QQ官方机器人Python SDK和三方框架搭建QQ群聊机器人

文章目录

    • 使用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。具体步骤如下：

  1. 打开 QQ官方机器人管理平台
  2. 创建一个新的机器人账号，按照 教程 完成相关设置
  3. 在机器人管理平台中登录刚刚创建的机器人账号，获取其账号的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"])

运行结果如下：
在这里插入图片描述
关于官方机器人更多的示例代码请参考： 官方完整示例

情况二：配置了三方机器人
我们导入QQbot_Python库，创建机器人实例，进行群聊事件的监听，示例代码如下：

# -*- coding: utf-8 -*-
import os
import QQbot_Python
from QQbot_Python import logging
from QQbot_Python.ext.cog_yaml import read
from QQbot_Python.message import GroupMessage

test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))

_log = logging.get_logger()


class MyClient(QQbot_Python.Client):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.show_heartbeat_info = False
        self.show_system_message = True

    async def on_group_at_message_create(self, message: GroupMessage):
        group_id = message.third_msg.get("group_id")
        user_id = message.third_msg.get("user_id")
        message_id = message.third_msg.get("message_id")
        _log.info(f"收到群{group_id}的@消息，用户{user_id}，消息{message_id}")
        await message.send_text(group_id=group_id,user_id=user_id,text="你好，我是机器人")
            

if __name__ == "__main__":
    intents = QQbot_Python.Intents(public_messages=True)
    client = MyClient(intents=intents)
    client.run(appid=test_config["appid"], secret=test_config["secret"])

运行结果如下：
在这里插入图片描述

机器人监听群聊进行图片回复

目前官方机器人并不支持群聊回复本地图片，具体以官方文档更新为准。但是使用本文的思路，可以实现回复图片功能，需要配置三方。示例代码如下：

# -*- coding: utf-8 -*-
import os
import QQbot_Python
from QQbot_Python import logging
from QQbot_Python.ext.cog_yaml import read
from QQbot_Python.message import GroupMessage

test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))

_log = logging.get_logger()


class MyClient(QQbot_Python.Client):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.show_heartbeat_info = False
        self.show_system_message = True

    async def on_group_at_message_create(self, message: GroupMessage):
        group_id = message.third_msg.get("group_id")
        user_id = message.third_msg.get("user_id")
        message_id = message.third_msg.get("message_id")
        _log.info(f"收到群{group_id}的@消息，用户{user_id}，消息{message_id}")
        if "/发送图片" in message.content:
            await message.reply(content="发送成功！")
            await message.send_image(group_id=group_id,summary="这是图片描述",file_image="1.png")
            

if __name__ == "__main__":
    intents = QQbot_Python.Intents(public_messages=True)
    client = MyClient(intents=intents)
    client.run(appid=test_config["appid"], secret=test_config["secret"])

具体运行如下：
在这里插入图片描述

机器人监听群聊进行文件发送

目前官方机器人并不支持群聊回复本地文件，具体以官方文档更新为准。但是使用本文的思路，可以实现回复图片功能。需要配置三方。示例代码如下：

# -*- coding: utf-8 -*-
import os
import QQbot_Python
from QQbot_Python import logging
from QQbot_Python.ext.cog_yaml import read
from QQbot_Python.message import GroupMessage

test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))

_log = logging.get_logger()


class MyClient(QQbot_Python.Client):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.show_heartbeat_info = False
        self.show_system_message = True

    async def on_group_at_message_create(self, message: GroupMessage):
        group_id = message.third_msg.get("group_id")
        user_id = message.third_msg.get("user_id")
        message_id = message.third_msg.get("message_id")
        _log.info(f"收到群{group_id}的@消息，用户{user_id}，消息{message_id}")
        if "/发送文件" in message.content:
            await message.reply(content="发送成功！")
            await message.send_file(group_id=group_id,file_name="名称可自定义",file_path="botpy.log")
            

if __name__ == "__main__":
    intents = QQbot_Python.Intents(public_messages=True)
    client = MyClient(intents=intents)
    client.run(appid=test_config["appid"], secret=test_config["secret"])

运行结果如下：
在这里插入图片描述

机器人监听群聊进行视频发送

目前官方机器人并不支持群聊回复本地视频，具体以官方文档更新为准。但是使用本文的思路，可以实现回复图片功能。需要配置三方。示例代码如下：

# -*- coding: utf-8 -*-
import os
import QQbot_Python
from QQbot_Python import logging
from QQbot_Python.ext.cog_yaml import read
from QQbot_Python.message import GroupMessage

test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))

_log = logging.get_logger()


class MyClient(QQbot_Python.Client):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.show_heartbeat_info = False
        self.show_system_message = True

    async def on_group_at_message_create(self, message: GroupMessage):
        group_id = message.third_msg.get("group_id")
        user_id = message.third_msg.get("user_id")
        message_id = message.third_msg.get("message_id")
        _log.info(f"收到群{group_id}的@消息，用户{user_id}，消息{message_id}")
        if "/发送视频" in message.content:
            await message.reply(content="发送成功！")
            await message.send_voice(group_id=group_id, file_path="test.mp4",file_name="可以自定义名称")
            

if __name__ == "__main__":
    intents = QQbot_Python.Intents(public_messages=True)
    client = MyClient(intents=intents)
    client.run(appid=test_config["appid"], secret=test_config["secret"])

运行结果如下：
在这里插入图片描述

机器人监听群聊进行语音发送

目前官方机器人并不支持群聊回复语音，具体以官方文档更新为准。但是使用本文的思路，可以实现回复图片功能。发送的语音文件格式只支持silk格式。需要配置三方。示例代码如下：

# -*- coding: utf-8 -*-
import os
import QQbot_Python
from QQbot_Python import logging
from QQbot_Python.ext.cog_yaml import read
from QQbot_Python.message import GroupMessage

test_config = read(os.path.join(os.path.dirname(__file__), "config.yaml"))

_log = logging.get_logger()


class MyClient(QQbot_Python.Client):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.show_heartbeat_info = False
        self.show_system_message = True

    async def on_group_at_message_create(self, message: GroupMessage):
        group_id = message.third_msg.get("group_id")
        user_id = message.third_msg.get("user_id")
        message_id = message.third_msg.get("message_id")
        _log.info(f"收到群{group_id}的@消息，用户{user_id}，消息{message_id}")
        if "/发送语音" in message.content:
            await message.reply(content="发送成功！")
            await message.send_record(group_id=group_id,file_path="my.ntsilk")
            

if __name__ == "__main__":
    intents = QQbot_Python.Intents(public_messages=True)
    client = MyClient(intents=intents)
    client.run(appid=test_config["appid"], secret=test_config["secret"])

运行结果如下：
在这里插入图片描述

除此之外，还有发送引用消息和发送私聊消息功能，在这里就不赘述了。

致谢和更新

本项目采用的都是开源技术

致谢：QQ官方开发者 | 不方便透露姓名的三方

上次更新时间: 9/28/2024, PM

在这里插入图片描述
如果你想继续进行基于本文进行QQ机器人自定义搭建，请转至此篇文章阅读：
➡️ [于 2024/9/25 第2次更新] QQ 腾讯官方机器人搭建（更新中）
👻 交流学习


http://www.kler.cn/a/331460.html

相关文章：

  • 中国新能源汽车公共充电桩数据合集（2002-2023年）
  • WordPress 去除?v= 动态后缀
  • 行政管理痛点解决方案：OA系统助力企业提效减负
  • rfid标签打印开发指导
  • 【python虚拟环境安装】linux centos 下的python虚拟环境配置
  • 方正畅享全媒体新闻采编系统 screen.do SQL注入漏洞复现
  • iframe标签是做什么用的
  • 计算机毕业设计 Java酷听音乐系统的设计与实现 Java实战项目 附源码+文档+视频讲解
  • map部分重点
  • ＜数据集＞工程机械识别数据集＜目标检测＞
  • FBX福币历史重演，ETH可能会在第四季度出现熊市
  • mysql安装及使用·1
  • 计算机毕业设计Python抖音可视化 抖音大数据分析 抖音爬虫 抖音用户行为分析 抖音大数据 Hadoop Spark 数据仓库 推荐系统 机器学习 深度学习
  • [Unity Demo]从零开始制作空洞骑士Hollow Knight第十二集：制作完整地图和地图细节设置以及制作相机系统的跟随玩家和视角锁定功能
  • 在线JSON可视化工具--支持缩放
  • 华为云技术深度解析：以系统性创新加速智能化升级
  • map_set的使用
  • 【Windows】 C++实现 Socket 通讯
  • 行为型模式-策略模式详解
  • 【D3.js in Action 3 精译_025】3.4 让 D3 数据适应屏幕（中）—— 线性比例尺的用法
  • PASCAL VOC 2012数据集 20类物体，这些物体包括人、动物（如猫、狗、鸟等）、交通工具（如车、船、飞机等）以及家具（如椅子、桌子、沙发等）。
  • C++游戏开发深度解析
  • 滚雪球学Oracle[4.2讲]：PL/SQL基础语法
  • 在LabVIEW中如何读取EXCEL
  • Proxmox使用tc给虚拟机限速，实现不对等网速——浪浪云
  • JavaWeb - 8 - 请求响应 分层解耦