sususu/xcodecli-shells
Private
Public Access
1
0
Fork 0
Code Activity

fix: 优化飞书机器人配置指南中的格式和内容
All checks were successful
Deploy to Cloudflare Pages / deploy (push) Successful in 41s

Browse Source
This commit is contained in:
sususu98
2026-03-13 12:03:26 +08:00
parent 3895681bfd
commit 2facfde196
1 changed files with 30 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/guide/feishu-bot.md
View File

@@ -13,6 +13,7 @@ title: XCodeClaw 飞书机器人配置指南
XCodeClaw 是一个 AI 学术助手，通过飞书机器人与您交互。您需要在飞书开放平台创建一个机器人应用，并完成权限和事件订阅的配置。 XCodeClaw 是一个 AI 学术助手，通过飞书机器人与您交互。您需要在飞书开放平台创建一个机器人应用，并完成权限和事件订阅的配置。
:::tip 整体流程 :::tip 整体流程
1. 在飞书开放平台创建企业自建应用 1. 在飞书开放平台创建企业自建应用
2. 添加机器人能力 2. 添加机器人能力
3. 导入权限配置 3. 导入权限配置
@@ -20,7 +21,7 @@ XCodeClaw 是一个 AI 学术助手，通过飞书机器人与您交互。您需
5. 等待管理员创建服务实例 5. 等待管理员创建服务实例
6. 配置事件订阅与回调（需要服务实例已运行） 6. 配置事件订阅与回调（需要服务实例已运行）
7. 发布应用 7. 发布应用
::: :::
:::warning 流程顺序很重要 :::warning 流程顺序很重要
事件订阅和回调使用「长连接」模式，即由服务端主动与飞书建立 WebSocket 连接。因此必须先让管理员创建服务实例，待服务启动后再配置长连接，否则连接无法建立。 事件订阅和回调使用「长连接」模式，即由服务端主动与飞书建立 WebSocket 连接。因此必须先让管理员创建服务实例，待服务启动后再配置长连接，否则连接无法建立。
@@ -116,17 +117,17 @@ XCodeClaw 是一个 AI 学术助手，通过飞书机器人与您交互。您需
下表列出了主要权限的用途说明： 下表列出了主要权限的用途说明：
| 权限标识 | 用途 | | 权限标识 | 用途 |
| :--- | :--- | | :--------------------------------- | :----------------------------- |
| `im:message:send_as_bot` | 以机器人身份发送消息 | | `im:message:send_as_bot` | 以机器人身份发送消息 |
| `im:message.p2p_msg:readonly` | 读取私聊消息 | | `im:message.p2p_msg:readonly` | 读取私聊消息 |
| `im:message.group_at_msg:readonly` | 读取群聊中 @机器人 的消息 | | `im:message.group_at_msg:readonly` | 读取群聊中 @机器人 的消息 |
| `im:chat` | 管理群聊（创建/更新群信息） | | `im:chat` | 管理群聊（创建/更新群信息） |
| `im:resource` | 读取和发送文件、图片等资源 | | `im:resource` | 读取和发送文件、图片等资源 |
| `docs:document.content:read` | 读取飞书文档内容 | | `docs:document.content:read` | 读取飞书文档内容 |
| `sheets:spreadsheet` | 读写飞书电子表格 | | `sheets:spreadsheet` | 读写飞书电子表格 |
| `wiki:wiki:readonly` | 读取知识库内容 | | `wiki:wiki:readonly` | 读取知识库内容 |
| `cardkit:card:write` | 发送和更新卡片消息（流式输出） | | `cardkit:card:write` | 发送和更新卡片消息（流式输出） |
## 5. 获取凭证并交给管理员 ## 5. 获取凭证并交给管理员
@@ -173,9 +174,9 @@ App Secret 是应用的密钥，请妥善保管，不要在公开场合泄露。
3. 点击「**添加事件**」，搜索并添加以下事件： 3. 点击「**添加事件**」，搜索并添加以下事件：
| 事件名称 | 事件标识 | | 事件名称 | 事件标识 |
| :--- | :--- | | :----------- | :------------------------------- |
| 接收消息 | `im.message.receive_v1` | | 接收消息 | `im.message.receive_v1` |
| 添加表情回复 | `im.message.reaction.created_v1` | | 添加表情回复 | `im.message.reaction.created_v1` |
| 删除表情回复 | `im.message.reaction.deleted_v1` | | 删除表情回复 | `im.message.reaction.deleted_v1` |
@@ -201,6 +202,8 @@ App Secret 是应用的密钥，请妥善保管，不要在公开场合泄露。
在「**安全设置**」区域，如果看到「**user_access_token**」开关，请将其**开启**。 在「**安全设置**」区域，如果看到「**user_access_token**」开关，请将其**开启**。
如果**没有**看到该开关，说明您的应用已默认启用用户凭证，**无需额外操作**。
![安全设置](../assets/feishu/11-security-token.png) ![安全设置](../assets/feishu/11-security-token.png)
## 8. 发布应用 ## 8. 发布应用
@@ -244,18 +247,18 @@ App Secret 是应用的密钥，请妥善保管，不要在公开场合泄露。
请对照以下清单确认所有配置已完成： 请对照以下清单确认所有配置已完成：
| | 检查项 | 说明 | | | 检查项 | 说明 |
| :---: | :--- | :--- | | :-: | :--------- | :----------------------------------------- |
| ☐ | 创建应用 | 已在飞书开放平台创建企业自建应用 | | ☐ | 创建应用 | 已在飞书开放平台创建企业自建应用 |
| ☐ | 机器人能力 | 已启用机器人能力 | | ☐ | 机器人能力 | 已启用机器人能力 |
| ☐ | 权限导入 | 已通过 JSON 批量导入全部权限 | | ☐ | 权限导入 | 已通过 JSON 批量导入全部权限 |
| ☐ | 获取凭证 | 已复制 App ID 和 App Secret 并发送给管理员 | | ☐ | 获取凭证 | 已复制 App ID 和 App Secret 并发送给管理员 |
| ☐ | 服务开通 | 管理员已确认服务实例启动 | | ☐ | 服务开通 | 管理员已确认服务实例启动 |
| ☐ | 事件订阅 | 已添加 3 个事件，使用长连接模式 | | ☐ | 事件订阅 | 已添加 3 个事件，使用长连接模式 |
| ☐ | 回调配置 | 已配置回调，使用长连接模式 | | ☐ | 回调配置 | 已配置回调，使用长连接模式 |
| ☐ | 安全设置 | 已开启 user_access_token 开关 | | ☐ | 安全设置 | 已开启 user_access_token 开关 |
| ☐ | 发布应用 | 已创建版本并发布上线 | | ☐ | 发布应用 | 已创建版本并发布上线 |
| ☐ | 飞书授权 | 已发送 `/feishu auth` 并完成授权 | | ☐ | 飞书授权 | 已发送 `/feishu auth` 并完成授权 |
## 11. 常见问题 ## 11. 常见问题