Skip to content

示例

SDK 提供了 20+ 完整示例代码,涵盖各种消息类型和业务场景。示例代码存放在项目根目录的 examples/ 目录下。

运行示例

所有示例都需要创建 config.yaml 配置文件:

yaml
appid: "你的AppID"
secret: "你的AppSecret"

然后直接运行对应的 Python 文件:

bash
python examples/demo_at_reply.py

前置条件

  1. QQ 机器人平台 注册机器人并获取 AppID 和 Secret
  2. 根据机器人类型(公域/私域)配置相应的 Intents
  3. 将机器人添加到频道/群聊中

示例索引

频道消息类

示例文件说明
基础回复demo_at_reply.py被 @ 时自动回复
ARK 模板消息demo_at_reply_ark.py发送模板消息
Embed 消息demo_at_reply_embed.py发送富文本 embed 消息
指令系统demo_at_reply_command.py使用 @Commands 装饰器
本地图片demo_at_reply_file_data.py发送本地图片消息
内联键盘demo_at_reply_keyboard.py发送按钮/键盘消息
Markdowndemo_at_reply_markdown.py发送 Markdown 消息
消息引用demo_at_reply_reference.py引用回复消息

私信类

示例文件说明
私信demo_dms_reply.py发送和接收私信

管理类

示例文件说明
撤回消息demo_recall.py撤回已发送消息
公告demo_announce.py公告创建和删除
接口权限demo_api_permission.py权限查询和申请
精华消息demo_pins_message.py精华消息管理
日程demo_schedule.py日程增删改查
表情表态demo_get_reaction_users.py表情表态管理

事件类

示例文件说明
成员事件demo_guild_member_event.py成员进出事件

群聊/C2C 类

示例文件说明
群消息demo_group_reply_text.py群聊消息收发
C2C 消息demo_c2c_reply_text.pyC2C 消息收发
群文件demo_group_reply_file.py群聊富媒体文件
C2C 文件demo_c2c_reply_file.pyC2C 富媒体文件
群管理demo_group_manage_event.py群管理事件
C2C 管理demo_c2c_manage_event.pyC2C 管理事件

特殊功能类

示例文件说明
音视频成员demo_audio_or_live_channel_member.py音视频/直播成员进出
开放论坛demo_open_forum_event.py开放论坛事件