示例
SDK 提供了 20+ 完整示例代码,涵盖各种消息类型和业务场景。示例代码存放在项目根目录的 examples/ 目录下。
运行示例
所有示例都需要创建 config.yaml 配置文件:
yaml
appid: "你的AppID"
secret: "你的AppSecret"然后直接运行对应的 Python 文件:
bash
python examples/demo_at_reply.py前置条件
示例索引
频道消息类
| 示例 | 文件 | 说明 |
|---|---|---|
| 基础回复 | 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 | 发送按钮/键盘消息 |
| Markdown | demo_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.py | C2C 消息收发 |
| 群文件 | demo_group_reply_file.py | 群聊富媒体文件 |
| C2C 文件 | demo_c2c_reply_file.py | C2C 富媒体文件 |
| 群管理 | demo_group_manage_event.py | 群管理事件 |
| C2C 管理 | demo_c2c_manage_event.py | C2C 管理事件 |
特殊功能类
| 示例 | 文件 | 说明 |
|---|---|---|
| 音视频成员 | demo_audio_or_live_channel_member.py | 音视频/直播成员进出 |
| 开放论坛 | demo_open_forum_event.py | 开放论坛事件 |