Skip to content

飞书开放平台配置.md

Latest commit

 

History

History
106 lines (68 loc) · 2.11 KB

飞书开放平台配置.md

File metadata and controls

106 lines (68 loc) · 2.11 KB
Raw

飞书开放平台配置

本文档说明如何为 feishu-codex-cli-bridge 配置一个飞书自建应用。

1. 创建自建应用

  1. 打开飞书开放平台。
  2. 创建企业自建应用。
  3. 记录 App ID 和 App Secret。
  4. 不要把 App Secret 提交到 GitHub。

2. 启用机器人

在应用能力里启用机器人能力，并把机器人添加到需要使用的单聊或群聊。

群聊默认需要 @机器人 才会响应。

3. 开启事件订阅

进入「事件与回调」：

  1. 订阅方式选择「使用长连接接收事件」。
  2. 订阅事件：
    • im.message.receive_v1

bridge 使用飞书官方 Node SDK 的 WebSocket 长连接，不需要公网回调 URL。

4. 权限建议

按功能逐步开通权限。

基础聊天：

  • 接收消息事件
  • 获取与发送单聊、群组消息

群聊总结：

  • 获取群组中所有消息
  • 获取与发送单聊、群组消息

图片和文件：

  • 获取消息中的资源文件

云文档读取：

  • 查看新版文档
  • 查看知识库节点信息

云文档写入：

  • 创建及编辑新版文档
  • 文档本身需要把机器人或应用设置为可编辑协作者

5. 本地初始化

npm install
npm run build
npm run dev -- init \
  --app-id cli_xxx \
  --app-secret xxx \
  --cwd /absolute/path/to/workspace

第二个 App 可以使用独立配置：

npm run dev -- init \
  --config ~/.feishu-codex-cli-bridge/app-b.json \
  --app-id cli_xxx \
  --app-secret xxx \
  --cwd /absolute/path/to/workspace

6. 启动

默认配置：

node dist/cli.js run

指定第二个配置：

node dist/cli.js run --config ~/.feishu-codex-cli-bridge/app-b.json

看到 ws client ready 才表示长连接已连上。

7. 常见权限错误

403

通常是权限或文档授权问题：

  • App 权限没有开通或没有发布生效。
  • 文档没有分享给机器人或应用。
  • 文档权限是只读，不是可编辑。
  • wiki 页面背后的 docx 没有可编辑权限。

400 invalid param

通常是请求参数结构问题。当前最容易发生在复杂富文本或表格写入场景。