mirror of
https://github.com/larksuite/cli.git
synced 2026-07-09 02:14:02 +08:00
Revert "docs: tighten vc-agent references - remove redundancy and fix vague wording"
This reverts commit 9845fc40622c65b0811da1c9ae4902434377f33e.
This commit is contained in:
@@ -16,6 +16,9 @@ lark-cli vc +meeting-events --meeting-id 69xxxxxxxxxxxxx28 --format pretty
|
||||
# 指定时间范围
|
||||
lark-cli vc +meeting-events --meeting-id 69xxxxxxxxxxxxx28 --start 2026-04-17T15:00:00+08:00 --end 2026-04-17T16:00:00+08:00 --format pretty
|
||||
|
||||
# pretty 时间线输出
|
||||
lark-cli vc +meeting-events --meeting-id 69xxxxxxxxxxxxx28 --format pretty
|
||||
|
||||
# 自动翻页(最多 10 页)
|
||||
lark-cli vc +meeting-events --meeting-id 69xxxxxxxxxxxxx28 --page-limit 10 --format pretty
|
||||
|
||||
@@ -154,13 +157,13 @@ lark-cli vc +meeting-join --meeting-number 123456789
|
||||
lark-cli vc +meeting-events --meeting-id <meeting.id> --format pretty
|
||||
```
|
||||
|
||||
### 场景 2:提取完整字段做后续处理(程序消费)
|
||||
### 场景 2:会中事件排障 / 会话回放
|
||||
|
||||
```bash
|
||||
# 拿完整原始 payload(open_id、聊天原文、share_doc 等都在 events[].payload 里)
|
||||
# 先看结构化原始数据
|
||||
lark-cli vc +meeting-events --meeting-id <meeting.id> --format json
|
||||
|
||||
# 翻页继续拉
|
||||
# 需要继续翻页时
|
||||
lark-cli vc +meeting-events --meeting-id <meeting.id> --page-limit 5 --format json
|
||||
```
|
||||
|
||||
@@ -190,7 +193,8 @@ lark-cli vc +meeting-events \
|
||||
|
||||
- 这是**会中事件流**查询,不适合拿来搜历史会议记录;搜历史会议请用 `+search`。
|
||||
- 如果你只需要最终纪要、录制、逐字稿,不必查事件列表,直接用 `+notes` / `+recording`。
|
||||
- 查询"谁参加过某会议"请用 `vc meeting get --params '{"meeting_id":"<id>","with_participants":true}'`——这是参会人**快照** API,不依赖 bot 是否参会,对已结束会议也可查;**不要**用 `+meeting-events` 做参会人查询。
|
||||
- 事件列表是否完整,取决于 bot 何时入会、何时离会,以及后端当前可见的会中事件范围。对于已结束会议,通常只在**结束后 5 分钟内**、且 bot **曾经在会中**时还能继续拉到事件。
|
||||
- 查询"谁参加过某会议"请用 `vc meeting get --params '{"meeting_id":"<id>","with_participants":true}'`——这是参会人**快照** API,不依赖 bot 是否参会,对已结束会议也可查;**不要** 用 `+meeting-events` 做参会人查询。
|
||||
|
||||
## 参考
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||
|
||||
通过 9 位会议号让当前身份(user)真实加入一场正在进行的视频会议(bot join)。**写操作**。
|
||||
通过 9 位会议号加入一场正在进行的视频会议(bot join)。这是一次**写操作**,会实际让当前身份加入会议。
|
||||
|
||||
本 skill 对应 shortcut:`lark-cli vc +meeting-join`(调用 `POST /open-apis/vc/v1/bots/join`)。
|
||||
|
||||
@@ -53,9 +53,9 @@ lark-cli vc +meeting-join --meeting-number 123456789 --dry-run
|
||||
- 若会议设置了**等候室 / 入会审批**,bot 可能需要主持人放行后才真正入会。
|
||||
- 若返回 `HTTP 403: no permission`(错误码 `121003`),不要只理解成“账号没权限”。这类报错更常见的原因是:会议参数或会控配置当前不满足入会条件,例如会议号填错、密码未传或错误、会议尚未开始、等候室 / 入会审批未放行、会议禁止外部/特定身份加入等。应先确认这些配置项,再重试。
|
||||
|
||||
### 4. 入会对所有参会人可见
|
||||
### 4. 机器人入会后对其他参会人可见
|
||||
|
||||
机器人入会后立即出现在参会人列表中,对所有参会人可见。误入错会的社交成本高——执行前核实 9 位会议号来源(用户输入或会议链接末尾),不要凭空编造。
|
||||
这是一次真实入会操作,机器人会立即出现在参会人列表中,其他参会人可见,并产生会议日志。误入错会的社交成本高于技术成本——执行前优先确认 9 位会议号的来源(用户输入 / 会议链接末尾),不要臆造。参数格式有疑问时可用 `--dry-run` 预览请求体。
|
||||
|
||||
## 输出结果
|
||||
|
||||
@@ -119,8 +119,8 @@ lark-cli vc +notes --meeting-ids <meeting.id>
|
||||
## 提示
|
||||
|
||||
- 仅在 Agent 需要**真实加入**会议(例如参会机器人、会中助手)时使用;只拉取会议数据不需要入会。
|
||||
- 入会可随时通过 `+meeting-leave` 回退,不是单向操作。
|
||||
- 执行成功后立即记录返回的 `meeting.id`,用于后续 `+meeting-leave` / `+meeting-events`。
|
||||
- 入会会让机器人立即出现在参会列表;若要回退,直接 `+meeting-leave` 即可。参数格式不确定时可选 `--dry-run` 预览,但不是必经步骤。
|
||||
- 执行成功后,立即记录返回的 `meeting.id`,用于后续 `+meeting-leave` / `+meeting-events`。
|
||||
|
||||
## 参考
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||
|
||||
通过 `meeting_id` 让当前身份从视频会议中退出(bot leave)。**写操作**。
|
||||
通过 `meeting_id` 离开当前身份所在的视频会议(bot leave)。这是一次**写操作**,会实际把当前身份从会议中移出。
|
||||
|
||||
本 skill 对应 shortcut:`lark-cli vc +meeting-leave`(调用 `POST /open-apis/vc/v1/bots/leave`)。
|
||||
|
||||
@@ -40,11 +40,11 @@ lark-cli vc +meeting-leave --meeting-id 69xxxxxxxxxxxxx28 --dry-run
|
||||
|
||||
### 3. 当前身份必须在会议中
|
||||
|
||||
必须先通过 `+meeting-join` 在该会议中,否则返回 `not in meeting` 错误。
|
||||
必须先通过 `+meeting-join` 或其他方式在该会议中,否则接口会报错。
|
||||
|
||||
### 4. 离会立即生效,对其他参会人可见
|
||||
|
||||
机器人立刻从参会列表消失。任务完成后再调用;如需重新入会,再跑 `+meeting-join` 即可(非真正"不可逆")。
|
||||
机器人会立刻从参会列表消失;若会议启用了录制/纪要,bot 的参会时段到此截止。确认任务完成再调用;如需要重新入会,再跑 `+meeting-join` 即可(非真正"不可逆")。
|
||||
|
||||
## 输出结果
|
||||
|
||||
@@ -75,7 +75,7 @@ lark-cli vc +meeting-leave --meeting-id <meeting.id>
|
||||
### 场景 2:会后补拉产物
|
||||
|
||||
```bash
|
||||
# 第 1 步:机器人离会(会议本身不受影响,继续进行)
|
||||
# 第 1 步:离会后会议仍在进行或已结束
|
||||
lark-cli vc +meeting-leave --meeting-id <meeting.id>
|
||||
|
||||
# 第 2 步:会议结束后查询录制
|
||||
@@ -96,9 +96,9 @@ lark-cli vc +notes --meeting-ids <meeting.id>
|
||||
|
||||
## 提示
|
||||
|
||||
- `meeting_id` 必须来自 `+meeting-join` 的返回值,不要用 9 位会议号。
|
||||
- 离会会让机器人从参会列表消失,对其他参会人可见;若需要重新入会直接再 `+meeting-join`,不是真正的"不可逆"。参数格式不确定时可选 `--dry-run` 预览。
|
||||
- 与 `+meeting-join` 成对使用:能 join 的身份才能 leave。
|
||||
- 离会非真正"不可逆",需要重新入会直接再跑 `+meeting-join` 即可。
|
||||
- `meeting_id` 必须来自 `+meeting-join` 的返回值,不要用 9 位会议号。
|
||||
|
||||
## 参考
|
||||
|
||||
|
||||
Reference in New Issue
Block a user