lark-im

Name: lark-im
Author: larksuite

382kinstalls1.1kforks

How to install lark-im?

larksuite/cli/lark-im

$npx -y skills add larksuite/cli --skill lark-im

Installs into the current project.

Summary

飞书即时通讯：收发消息和管理群聊。发送和回复消息、搜索聊天记录、管理群聊成员、上传下载图片和文件（支持大文件分片下载）、管理表情回复、发送应用内/短信/电话加急、发送和处理交互卡片（Interactive Card）、监听卡片按钮回调（card.action.trigger）。当用户需要发消息、查看或搜索聊天记录、下载聊天中的文件、查看群成员、搜索群、创建群聊或话题群、管理标记数据、管理 Feed 置顶（添加/移除/查询置顶会话）、管理标签数据、处理卡片回调时使用。

Files · 1

View on GitHub

SKILL.md

1	# im (v1)
2
3	CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)，其中包含认证、权限处理
4
5	## Core Concepts
6
7	- Message: A single message in a chat, identified by `message_id` (om_xxx). Supports types: text, post, image, file, audio, video, sticker, interactive (card), share_chat, share_user, merge_forward, etc.
8	- Chat: A group chat or P2P conversation, identified by `chat_id` (oc_xxx).
9	- Thread: A reply thread under a message, identified by `thread_id` (om_xxx or omt_xxx).
10	- Reaction: An emoji reaction on a message.
11	- Flag: A bookmark on a message or thread.
12	- Feed Shortcut: A chat pinned to the current user's feed sidebar, identified by `feed_card_id` (an `oc_xxx` open_chat_id for CHAT type).
13	- Feed Group: A tag that groups feed cards in the feed list, identified by `feed_group_id` (ofg_xxx). Members are feed cards, each identified by `feed_id` + `feed_type`. Two types: `normal` (members managed explicitly) and `rule` (members auto-derived from rules).
14
15	## Resource Relationships
16
17	```
18	Chat (oc_xxx)
19	├── Message (om_xxx)
20	│ ├── Thread (reply thread)
21	│ ├── Reaction (emoji)
22	│ └── Resource (image / file / video / audio)
23	└── Member (user / bot)
24	```
25
26	## Important Notes
27
28	### Identity and Token Mapping
29
30	- `--as user` means user identity and uses `user_access_token`. Calls run as the authorized end user, so permissions depend on both the app scopes and that user's own access to the target chat/message/resource.
31	- `--as bot` means bot identity and uses `tenant_access_token`. Calls run as the app bot, so behavior depends on the bot's membership, app visibility, availability range, and bot-specific scopes.
32	- If an IM API says it supports both `user` and `bot`, the token type changes who the operator is. The same API can succeed with one identity and fail with the other because owner/admin status, chat membership, tenant boundary, or app availability are checked against the current caller.
33
34	### Sender Name Resolution
35
36	When fetching messages (`+chat-messages-list`, `+threads-messages-list`, `+messages-mget`, `+messages-search`), the CLI shows a display name for both user and bot senders:
37
38	- Server-provided name: the read APIs return `sender_name` (plus the full-i18n `sender_i18n_names` map) on each message `sender`; the CLI surfaces it as the sender's `name` for users and bots alike. No name lookup and no extra permission are needed — no contact scope and no `application:bot.basic_info:read`.
39	- Fallback to id: when the server does not provide a name, the sender is shown by its id and the command still exits 0. There is no contact-directory fallback.
40
41	The raw `sender_name` is not duplicated in output (its value is in `name`); the full `sender_i18n_names` map (all locales) is preserved for consumers that need a specific language, alongside an optional `open_bot_id` (`ou_`) for bot senders aligned with the message-receive event channel. System messages (`msg_type: system`) have no sender name — that is normal, not an error.
42
43	### Default message enrichment (reactions / update_time)
44
45	The four message-pulling shortcuts (`+messages-mget`, `+chat-messages-list`, `+messages-search`, `+threads-messages-list`) automatically attach a `reactions` block and (for edited messages) `update_time` to each returned message — no separate `im.reactions.batch_query` call is needed. Pass `--no-reactions` to opt out. For the full contract (output shape, the `im:message.reactions:read` scope requirement, and the "missing field ≠ fetch failure" data rules), read [`references/lark-im-message-enrichment.md`](references/lark-im-message-enrichment.md).
46
47	### Opt-in resource auto-download (`--download-resources`)
48
49	`+chat-messages-list`, `+messages-mget`, and `+threads-messages-list` accept `--download-resources` (off by default — no `resources` block and no extra requests when omitted). When set, eligible message resources (image/file/audio/video/media + post-embedded; stickers excluded) are downloaded into `./lark-im-resources/` and each message gains a `resources` array of `{message_id, key, type, local_path, size_bytes}`. Downloads are deduped by `(message_id, file_key)`, run with bounded concurrency, and isolate single-resource failures (`error: true` + stderr warning). Scope: requires `im:message:readonly` (already declared by the listing commands — no extra scope); works under both user and bot identity. For one-off downloads use [`+messages-resources-download`](references/lark-im-messages-resources-download.md). Full contract: [`references/lark-im-message-enrichment.md`](references/lark-im-message-enri

People who liked this also viewed

6 picks

Type

lark-im

382kinstalls1.1kforks

View on GitHub

How to install lark-im?

larksuite/cli/lark-im

$npx -y skills add larksuite/cli --skill lark-im

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# im (v1)
2
3	CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)，其中包含认证、权限处理
4
5	## Core Concepts
6
7	- Message: A single message in a chat, identified by `message_id` (om_xxx). Supports types: text, post, image, file, audio, video, sticker, interactive (card), share_chat, share_user, merge_forward, etc.
8	- Chat: A group chat or P2P conversation, identified by `chat_id` (oc_xxx).
9	- Thread: A reply thread under a message, identified by `thread_id` (om_xxx or omt_xxx).
10	- Reaction: An emoji reaction on a message.
11	- Flag: A bookmark on a message or thread.
12	- Feed Shortcut: A chat pinned to the current user's feed sidebar, identified by `feed_card_id` (an `oc_xxx` open_chat_id for CHAT type).
13	- Feed Group: A tag that groups feed cards in the feed list, identified by `feed_group_id` (ofg_xxx). Members are feed cards, each identified by `feed_id` + `feed_type`. Two types: `normal` (members managed explicitly) and `rule` (members auto-derived from rules).
14
15	## Resource Relationships
16
17	```
18	Chat (oc_xxx)
19	├── Message (om_xxx)
20	│ ├── Thread (reply thread)
21	│ ├── Reaction (emoji)
22	│ └── Resource (image / file / video / audio)
23	└── Member (user / bot)
24	```
25
26	## Important Notes
27
28	### Identity and Token Mapping
29
30	- `--as user` means user identity and uses `user_access_token`. Calls run as the authorized end user, so permissions depend on both the app scopes and that user's own access to the target chat/message/resource.
31	- `--as bot` means bot identity and uses `tenant_access_token`. Calls run as the app bot, so behavior depends on the bot's membership, app visibility, availability range, and bot-specific scopes.
32	- If an IM API says it supports both `user` and `bot`, the token type changes who the operator is. The same API can succeed with one identity and fail with the other because owner/admin status, chat membership, tenant boundary, or app availability are checked against the current caller.
33
34	### Sender Name Resolution
35
36	When fetching messages (`+chat-messages-list`, `+threads-messages-list`, `+messages-mget`, `+messages-search`), the CLI shows a display name for both user and bot senders:
37
38	- Server-provided name: the read APIs return `sender_name` (plus the full-i18n `sender_i18n_names` map) on each message `sender`; the CLI surfaces it as the sender's `name` for users and bots alike. No name lookup and no extra permission are needed — no contact scope and no `application:bot.basic_info:read`.
39	- Fallback to id: when the server does not provide a name, the sender is shown by its id and the command still exits 0. There is no contact-directory fallback.
40
41	The raw `sender_name` is not duplicated in output (its value is in `name`); the full `sender_i18n_names` map (all locales) is preserved for consumers that need a specific language, alongside an optional `open_bot_id` (`ou_`) for bot senders aligned with the message-receive event channel. System messages (`msg_type: system`) have no sender name — that is normal, not an error.
42
43	### Default message enrichment (reactions / update_time)
44
45	The four message-pulling shortcuts (`+messages-mget`, `+chat-messages-list`, `+messages-search`, `+threads-messages-list`) automatically attach a `reactions` block and (for edited messages) `update_time` to each returned message — no separate `im.reactions.batch_query` call is needed. Pass `--no-reactions` to opt out. For the full contract (output shape, the `im:message.reactions:read` scope requirement, and the "missing field ≠ fetch failure" data rules), read [`references/lark-im-message-enrichment.md`](references/lark-im-message-enrichment.md).
46
47	### Opt-in resource auto-download (`--download-resources`)
48
49	`+chat-messages-list`, `+messages-mget`, and `+threads-messages-list` accept `--download-resources` (off by default — no `resources` block and no extra requests when omitted). When set, eligible message resources (image/file/audio/video/media + post-embedded; stickers excluded) are downloaded into `./lark-im-resources/` and each message gains a `resources` array of `{message_id, key, type, local_path, size_bytes}`. Downloads are deduped by `(message_id, file_key)`, run with bounded concurrency, and isolate single-resource failures (`error: true` + stderr warning). Scope: requires `im:message:readonly` (already declared by the listing commands — no extra scope); works under both user and bot identity. For one-off downloads use [`+messages-resources-download`](references/lark-im-messages-resources-download.md). Full contract: [`references/lark-im-message-enrichment.md`](references/lark-im-message-enri

People who liked this also viewed

6 picks

Type