@lark-apaas/coding-miaoda-sandbox-skills 0.1.0-dev.ec88bb5 → 0.1.0-dev.f3f0e48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (207) hide show
  1. package/miaoda/ai-data-processing/SKILL.md +4 -1
  2. package/miaoda/animation-skill/SKILL.md +348 -0
  3. package/miaoda/authz-cli/SKILL.md +1 -0
  4. package/miaoda/charts-skill/SKILL.md +264 -0
  5. package/miaoda/creative-to-fullstack/SKILL.md +64 -0
  6. package/miaoda/data-analysis/SKILL.md +151 -0
  7. package/miaoda/data-analysis/references/json-output-specification.md +277 -0
  8. package/miaoda/data-analysis/references/post-analysis-guide.md +77 -0
  9. package/miaoda/data-analysis/references/python-analysis-reference.md +272 -0
  10. package/miaoda/data-analysis/references/tmp-file-management-guide.md +100 -0
  11. package/miaoda/debug-investigation/SKILL.md +35 -23
  12. package/miaoda/extract-json-schema/SKILL.md +147 -0
  13. package/miaoda/feishu/SKILL.md +4 -4
  14. package/miaoda/forms-skill/SKILL.md +46 -4
  15. package/miaoda/lark-apps/SKILL.md +37 -0
  16. package/miaoda/lark-apps/references/openapi-key.md +80 -0
  17. package/miaoda/lark-apps-authz/SKILL.md +292 -0
  18. package/miaoda/lark-apps-authz/references/permission-points.md +39 -0
  19. package/miaoda/lark-apps-authz/references/role.md +122 -0
  20. package/miaoda/lark-apps-db/SKILL.md +227 -0
  21. package/miaoda/lark-apps-db/references/full-reference.md +424 -0
  22. package/miaoda/lark-apps-file/SKILL.md +216 -0
  23. package/miaoda/lark-apps-ops/SKILL.md +67 -0
  24. package/miaoda/lark-apps-ops/references/lark-apps-access-scope-get.md +30 -0
  25. package/miaoda/lark-apps-ops/references/lark-apps-access-scope-set.md +40 -0
  26. package/miaoda/lark-apps-ops/references/lark-apps-cache.md +62 -0
  27. package/miaoda/lark-apps-ops/references/lark-apps-env.md +46 -0
  28. package/miaoda/lark-apps-ops/references/lark-apps-export.md +46 -0
  29. package/miaoda/lark-apps-ops/references/lark-apps-local-dev.md +26 -0
  30. package/miaoda/lark-apps-ops/references/lark-apps-mcp.md +25 -0
  31. package/miaoda/lark-apps-ops/references/lark-apps-member.md +93 -0
  32. package/miaoda/lark-apps-ops/references/lark-apps-observability.md +46 -0
  33. package/miaoda/lark-apps-ops/references/lark-apps-plugin-install.md +36 -0
  34. package/miaoda/lark-apps-ops/references/lark-apps-plugin-list.md +23 -0
  35. package/miaoda/lark-apps-ops/references/lark-apps-plugin-uninstall.md +25 -0
  36. package/miaoda/lark-apps-ops/references/lark-apps-release-create.md +37 -0
  37. package/miaoda/lark-apps-ops/references/lark-apps-release-get.md +59 -0
  38. package/miaoda/lark-apps-ops/references/lark-apps-release-list.md +31 -0
  39. package/miaoda/lark-apps-ops/references/lark-apps-update.md +30 -0
  40. package/miaoda/lark-apps-ops/references/lark-apps-user-id-convert.md +63 -0
  41. package/miaoda/lark-apps-ops/references/openapi-key.md +80 -0
  42. package/miaoda/lark-design-prototype/DESIGN.md +603 -0
  43. package/miaoda/lark-design-prototype/SKILL.md +85 -0
  44. package/miaoda/lark-design-prototype/references/assets/card-illustration-library.md +113 -0
  45. package/miaoda/lark-design-prototype/references/case-matching.md +53 -0
  46. package/miaoda/lark-design-prototype/references/cases/conversational-ai-home.md +27 -0
  47. package/miaoda/lark-design-prototype/references/cases/data-table.md +30 -0
  48. package/miaoda/lark-design-prototype/references/cases/official-home.md +26 -0
  49. package/miaoda/lark-design-prototype/references/cases/workspace-home.md +34 -0
  50. package/miaoda/lark-design-prototype/references/color-roles.md +163 -0
  51. package/miaoda/lark-design-prototype/references/component-selection.md +134 -0
  52. package/miaoda/lark-design-prototype/references/design-quality-checklist.md +156 -0
  53. package/miaoda/lark-design-prototype/references/form-shell-patterns.md +77 -0
  54. package/miaoda/lark-design-prototype/references/icon-semantics.md +237 -0
  55. package/miaoda/lark-design-prototype/references/layout-interaction.md +164 -0
  56. package/miaoda/lark-design-prototype/references/page-contract.md +281 -0
  57. package/miaoda/lark-design-prototype/references/product-patterns.md +93 -0
  58. package/miaoda/lark-design-prototype/references/prompt-expansion.md +107 -0
  59. package/miaoda/lark-design-prototype/references/restoration-traps.md +113 -0
  60. package/miaoda/lark-design-prototype/references/token-semantics.md +112 -0
  61. package/miaoda/lark-design-prototype/references/visual-brief.md +125 -0
  62. package/miaoda/lark-design-prototype/references/visual-style-prompts.md +61 -0
  63. package/miaoda/lark-design-prototype/scripts/icon-query.mjs +272 -0
  64. package/miaoda/lark-design-prototype/scripts/token-query.mjs +76 -0
  65. package/miaoda/lark-design-prototype/scripts/verify-static-html.mjs +117 -0
  66. package/miaoda/miaoda-file/SKILL.md +1 -0
  67. package/miaoda/miaoda-sql/SKILL.md +21 -2
  68. package/miaoda/performance-review/SKILL.md +144 -0
  69. package/miaoda/performance-review/references/business-analyzer.md +139 -0
  70. package/miaoda/performance-review/references/examples.md +107 -0
  71. package/miaoda/semantic-search/SKILL.md +6 -4
  72. package/miaoda/table-skill/SKILL.md +2 -0
  73. package/{shared → miaoda}/testing-guide/SKILL.md +119 -13
  74. package/miaoda-design/lark-apps-comment/SKILL.md +119 -0
  75. package/miaoda-design/lark-apps-ops/SKILL.md +47 -0
  76. package/miaoda-design/lark-apps-ops/references/lark-apps-release-create.md +52 -0
  77. package/miaoda-design/lark-apps-ops/references/lark-apps-release-get.md +59 -0
  78. package/miaoda-design/lark-apps-ops/references/lark-apps-release-list.md +31 -0
  79. package/miaoda-design/lark-apps-ops/references/lark-apps-update.md +33 -0
  80. package/{shared → miaoda-modern}/charts-skill/SKILL.md +1 -1
  81. package/miaoda-modern/debug-investigation/SKILL.md +1 -1
  82. package/miaoda-modern/forms-skill/SKILL.md +70 -7
  83. package/{shared → miaoda-modern}/lark-apps/SKILL.md +5 -5
  84. package/miaoda-modern/lark-apps/references/openapi-key.md +80 -0
  85. package/miaoda-modern/lark-apps-ops/SKILL.md +67 -0
  86. package/miaoda-modern/lark-apps-ops/references/lark-apps-access-scope-get.md +30 -0
  87. package/miaoda-modern/lark-apps-ops/references/lark-apps-access-scope-set.md +40 -0
  88. package/miaoda-modern/lark-apps-ops/references/lark-apps-cache.md +62 -0
  89. package/miaoda-modern/lark-apps-ops/references/lark-apps-env.md +46 -0
  90. package/miaoda-modern/lark-apps-ops/references/lark-apps-export.md +46 -0
  91. package/miaoda-modern/lark-apps-ops/references/lark-apps-local-dev.md +26 -0
  92. package/miaoda-modern/lark-apps-ops/references/lark-apps-mcp.md +25 -0
  93. package/miaoda-modern/lark-apps-ops/references/lark-apps-member.md +93 -0
  94. package/miaoda-modern/lark-apps-ops/references/lark-apps-observability.md +46 -0
  95. package/miaoda-modern/lark-apps-ops/references/lark-apps-plugin-install.md +36 -0
  96. package/miaoda-modern/lark-apps-ops/references/lark-apps-plugin-list.md +23 -0
  97. package/miaoda-modern/lark-apps-ops/references/lark-apps-plugin-uninstall.md +25 -0
  98. package/miaoda-modern/lark-apps-ops/references/lark-apps-release-create.md +37 -0
  99. package/miaoda-modern/lark-apps-ops/references/lark-apps-release-get.md +59 -0
  100. package/miaoda-modern/lark-apps-ops/references/lark-apps-release-list.md +31 -0
  101. package/miaoda-modern/lark-apps-ops/references/lark-apps-update.md +30 -0
  102. package/miaoda-modern/lark-apps-ops/references/lark-apps-user-id-convert.md +63 -0
  103. package/{shared/lark-apps → miaoda-modern/lark-apps-ops}/references/openapi-key.md +3 -3
  104. package/miaoda-modern/lark-design-prototype/DESIGN.md +603 -0
  105. package/miaoda-modern/lark-design-prototype/SKILL.md +85 -0
  106. package/miaoda-modern/lark-design-prototype/references/assets/card-illustration-library.md +113 -0
  107. package/miaoda-modern/lark-design-prototype/references/case-matching.md +53 -0
  108. package/miaoda-modern/lark-design-prototype/references/cases/conversational-ai-home.md +27 -0
  109. package/miaoda-modern/lark-design-prototype/references/cases/data-table.md +30 -0
  110. package/miaoda-modern/lark-design-prototype/references/cases/official-home.md +26 -0
  111. package/miaoda-modern/lark-design-prototype/references/cases/workspace-home.md +34 -0
  112. package/miaoda-modern/lark-design-prototype/references/color-roles.md +163 -0
  113. package/miaoda-modern/lark-design-prototype/references/component-selection.md +134 -0
  114. package/miaoda-modern/lark-design-prototype/references/design-quality-checklist.md +156 -0
  115. package/miaoda-modern/lark-design-prototype/references/form-shell-patterns.md +77 -0
  116. package/miaoda-modern/lark-design-prototype/references/icon-semantics.md +237 -0
  117. package/miaoda-modern/lark-design-prototype/references/layout-interaction.md +164 -0
  118. package/miaoda-modern/lark-design-prototype/references/page-contract.md +281 -0
  119. package/miaoda-modern/lark-design-prototype/references/product-patterns.md +93 -0
  120. package/miaoda-modern/lark-design-prototype/references/prompt-expansion.md +107 -0
  121. package/miaoda-modern/lark-design-prototype/references/restoration-traps.md +113 -0
  122. package/miaoda-modern/lark-design-prototype/references/token-semantics.md +112 -0
  123. package/miaoda-modern/lark-design-prototype/references/visual-brief.md +125 -0
  124. package/miaoda-modern/lark-design-prototype/references/visual-style-prompts.md +61 -0
  125. package/miaoda-modern/lark-design-prototype/scripts/icon-query.mjs +272 -0
  126. package/miaoda-modern/lark-design-prototype/scripts/token-query.mjs +76 -0
  127. package/miaoda-modern/lark-design-prototype/scripts/verify-static-html.mjs +117 -0
  128. package/miaoda-modern/memory/SKILL.md +86 -0
  129. package/{shared → miaoda-modern}/performance-review/SKILL.md +3 -3
  130. package/miaoda-modern/reviewer-usage/SKILL.md +113 -0
  131. package/package.json +1 -1
  132. package/shared/attachment/SKILL.md +5 -1
  133. package/shared/lark-cli/SKILL.md +221 -0
  134. package/shared/lark-cli/lark-base/README.md +61 -0
  135. package/shared/lark-cli/lark-base/references/lark-base-commands.md +123 -0
  136. package/shared/lark-cli/lark-calendar/README.md +158 -0
  137. package/shared/lark-cli/lark-calendar/references/lark-calendar-meeting.md +30 -0
  138. package/shared/lark-cli/lark-calendar/references/lark-calendar-room-find.md +108 -0
  139. package/shared/lark-cli/lark-calendar/references/lark-calendar-suggestion.md +120 -0
  140. package/shared/lark-cli/lark-contact/README.md +35 -0
  141. package/shared/lark-cli/lark-contact/references/lark-contact-get-user.md +13 -0
  142. package/shared/lark-cli/lark-contact/references/lark-contact-search-user.md +121 -0
  143. package/shared/lark-cli/lark-doc/README.md +68 -0
  144. package/shared/lark-cli/lark-doc/references/lark-doc-fetch.md +138 -0
  145. package/shared/lark-cli/lark-doc/references/lark-doc-history.md +61 -0
  146. package/shared/lark-cli/lark-drive/README.md +158 -0
  147. package/shared/lark-cli/lark-drive/references/lark-drive-batch-query-comments.md +44 -0
  148. package/shared/lark-cli/lark-drive/references/lark-drive-files-list.md +183 -0
  149. package/shared/lark-cli/lark-drive/references/lark-drive-list-replies.md +49 -0
  150. package/shared/lark-cli/lark-im/README.md +70 -0
  151. package/shared/lark-cli/lark-im/references/lark-im-chat-list.md +140 -0
  152. package/shared/lark-cli/lark-im/references/lark-im-chat-members-list.md +84 -0
  153. package/shared/lark-cli/lark-im/references/lark-im-chat-search.md +135 -0
  154. package/shared/lark-cli/lark-im/references/lark-im-reactions.md +232 -0
  155. package/shared/lark-cli/lark-minutes/README.md +51 -0
  156. package/shared/lark-cli/lark-minutes/references/lark-minutes-download.md +130 -0
  157. package/shared/lark-cli/lark-sheets/README.md +174 -0
  158. package/shared/lark-cli/lark-sheets/references/lark-sheets-changeset.md +105 -0
  159. package/shared/lark-cli/lark-sheets/references/lark-sheets-chart.md +46 -0
  160. package/shared/lark-cli/lark-sheets/references/lark-sheets-conditional-format.md +42 -0
  161. package/shared/lark-cli/lark-sheets/references/lark-sheets-filter-view.md +51 -0
  162. package/shared/lark-cli/lark-sheets/references/lark-sheets-filter.md +42 -0
  163. package/shared/lark-cli/lark-sheets/references/lark-sheets-float-image.md +43 -0
  164. package/shared/lark-cli/lark-sheets/references/lark-sheets-formula-verify.md +64 -0
  165. package/shared/lark-cli/lark-sheets/references/lark-sheets-history.md +70 -0
  166. package/shared/lark-cli/lark-sheets/references/lark-sheets-pivot-table.md +44 -0
  167. package/shared/lark-cli/lark-sheets/references/lark-sheets-read-data.md +287 -0
  168. package/shared/lark-cli/lark-sheets/references/lark-sheets-search-replace.md +67 -0
  169. package/shared/lark-cli/lark-sheets/references/lark-sheets-sheet-structure.md +52 -0
  170. package/shared/lark-cli/lark-sheets/references/lark-sheets-sparkline.md +47 -0
  171. package/shared/lark-cli/lark-sheets/references/lark-sheets-workbook.md +69 -0
  172. package/shared/lark-cli/lark-sheets/scripts/lark_detect_subtables.py +596 -0
  173. package/shared/lark-cli/lark-sheets/scripts/lark_inspect_workbook.py +193 -0
  174. package/shared/lark-cli/lark-sheets/scripts/lark_profile_table.py +616 -0
  175. package/shared/lark-cli/lark-sheets/scripts/lark_sheet_range.py +176 -0
  176. package/shared/lark-cli/lark-sheets/scripts/lark_sheet_read_cli.py +221 -0
  177. package/shared/lark-cli/lark-sheets/scripts/sheets_df.py +50 -0
  178. package/shared/lark-cli/lark-slides/README.md +87 -0
  179. package/shared/lark-cli/lark-slides/references/lark-slides-history.md +117 -0
  180. package/shared/lark-cli/lark-slides/references/lark-slides-xml-presentation-slide-get.md +108 -0
  181. package/shared/lark-cli/lark-slides/references/lark-slides-xml-presentations-get.md +77 -0
  182. package/shared/lark-cli/lark-task/README.md +93 -0
  183. package/shared/lark-cli/lark-task/references/lark-task-get-my-tasks.md +57 -0
  184. package/shared/lark-cli/lark-task/references/lark-task-get-related-tasks.md +49 -0
  185. package/shared/lark-cli/lark-task/references/lark-task-search.md +36 -0
  186. package/shared/lark-cli/lark-task/references/lark-task-tasklist-search.md +35 -0
  187. package/shared/lark-cli/lark-vc/README.md +40 -0
  188. package/shared/lark-cli/lark-vc/references/lark-vc-recording.md +31 -0
  189. package/shared/lark-cli/lark-whiteboard/README.md +34 -0
  190. package/shared/lark-cli/lark-whiteboard/references/lark-whiteboard-export.md +59 -0
  191. package/shared/lark-cli/lark-wiki/README.md +50 -0
  192. package/shared/lark-cli/lark-wiki/references/lark-wiki-node-get.md +70 -0
  193. package/shared/lark-cli/lark-wiki/references/lark-wiki-node-list.md +95 -0
  194. package/shared/lark-cli/lark-wiki/references/lark-wiki-space-list.md +68 -0
  195. package/miaoda-design/attachment/SKILL.md +0 -58
  196. package/shared/dev-channel-probe/SKILL.md +0 -40
  197. /package/{shared → miaoda}/memory/SKILL.md +0 -0
  198. /package/{shared → miaoda}/reviewer-usage/SKILL.md +0 -0
  199. /package/{shared → miaoda-modern}/animation-skill/SKILL.md +0 -0
  200. /package/{shared → miaoda-modern}/data-analysis/SKILL.md +0 -0
  201. /package/{shared → miaoda-modern}/data-analysis/references/json-output-specification.md +0 -0
  202. /package/{shared → miaoda-modern}/data-analysis/references/post-analysis-guide.md +0 -0
  203. /package/{shared → miaoda-modern}/data-analysis/references/python-analysis-reference.md +0 -0
  204. /package/{shared → miaoda-modern}/data-analysis/references/tmp-file-management-guide.md +0 -0
  205. /package/{shared → miaoda-modern}/extract-json-schema/SKILL.md +0 -0
  206. /package/{shared → miaoda-modern}/performance-review/references/business-analyzer.md +0 -0
  207. /package/{shared → miaoda-modern}/performance-review/references/examples.md +0 -0
@@ -0,0 +1,70 @@
1
+ # im (v1)
2
+
3
+ ## Core Concepts
4
+
5
+ - **Chat**: A group chat or P2P conversation, identified by `chat_id` (oc_xxx).
6
+ - **Message**: A single message in a chat, identified by `message_id` (om_xxx).
7
+ - **Reaction**: An emoji reaction on a message.
8
+ - **Member**: An entry in a chat's member list — a user account or a bot (returned in separate `users[]` / `bots[]` buckets).
9
+
10
+ 所有命令以当前用户身份运行(`--as user`,默认值,无需显式指定);能否读到某个群 / 成员 / 消息取决于该用户对目标资源的可见性。
11
+
12
+ ## Resource Relationships
13
+
14
+ ```
15
+ Chat (oc_xxx)
16
+ ├── Message (om_xxx)
17
+ │ └── Reaction (emoji)
18
+ └── Member (user / bot)
19
+ ```
20
+
21
+ ## Shortcuts(推荐优先使用)
22
+
23
+ Shortcut 是对常用操作的高级封装(`lark-cli im +<verb> [flags]`)。有 Shortcut 的操作优先使用。本沙箱只透出以下 3 个只读快捷命令:
24
+
25
+ | Shortcut | 说明 |
26
+ |----------|------|
27
+ | [`+chat-list`](references/lark-im-chat-list.md) | List chats the current user is a member of; defaults to groups; pass --types=p2p,group to include p2p single chats; supports sorting, auto-pagination (--page-all), --exclude-muted |
28
+ | [`+chat-members-list`](references/lark-im-chat-members-list.md) | List members of a chat; returns separate users[] / bots[] buckets; --member-types filters which kinds to return; --page-all pagination; surfaces truncations[] when the server caps a bucket |
29
+ | [`+chat-search`](references/lark-im-chat-search.md) | Search visible group chats by --query keyword and/or --member-ids; e.g. look up chat_id by group name; supports type filters, sorting, auto-pagination (--page-all), and --exclude-muted |
30
+
31
+ ## API Resources
32
+
33
+ ```bash
34
+ lark-cli schema im.<resource>.<method> # 调用 API 前必须先查看参数结构
35
+ lark-cli im <resource> <method> [flags] # 调用 API
36
+ ```
37
+
38
+ > **重要**:使用原生 API 时,必须先运行 `schema` 查看 `--data` / `--params` 参数结构,不要猜测字段格式。
39
+
40
+ 本沙箱只透出以下只读 API 命令(均为 read-only);**不要**尝试列表之外的 `im <service>/<api>` 组合。
41
+
42
+ ### chats
43
+
44
+ - `get` — 获取群信息。调用方需在目标群内才能拿到完整信息;内部群还需与群属于同一租户。
45
+
46
+ ### chat.members
47
+
48
+ - `bots` — 读取群内机器人成员信息。上游 skill 未提供 typed-flag 文档,调用前先 `lark-cli schema im.chat.members.bots` 查看参数与返回结构。
49
+ - `get` — 读取群成员信息。上游 skill 未提供 typed-flag 文档,调用前先 `lark-cli schema im.chat.members.get` 查看参数与返回结构。
50
+
51
+ ### pins
52
+
53
+ - `list` — 获取群内 Pin 消息。
54
+
55
+ ### reactions
56
+
57
+ - `batch_query` — 批量获取多条消息的表情回复。[Must-read](references/lark-im-reactions.md)
58
+ - `list` — 获取单条消息的表情回复记录。[Must-read](references/lark-im-reactions.md)
59
+
60
+ ## 权限表
61
+
62
+ | 方法 | 所需 scope |
63
+ |------|-----------|
64
+ | `chats.get` | `im:chat:read` |
65
+ | `+chat-list` / `+chat-search` | `im:chat:read` |
66
+ | `chat.members.get` | `im:chat.members:read` |
67
+ | `+chat-members-list` | `im:chat.members:read` |
68
+ | `reactions.batch_query` | `im:message.reactions:read` |
69
+ | `reactions.list` | `im:message.reactions:read` |
70
+ | `pins.list` | `im:message.pins:read` |
@@ -0,0 +1,140 @@
1
+ # im +chat-list
2
+
3
+ List chats the current user is a member of. **Not a search API — there is no `--query` parameter; the call always returns the full member list, paginated.** For keyword-based lookup (e.g. find a group by name or by member), use [`+chat-search`](lark-im-chat-search.md) instead.
4
+
5
+ **Defaults to groups only**; pass `--types=p2p,group` (or `--types p2p --types group`) to also include p2p single chats. Supports pagination, sort order, and muted-chat filtering.
6
+
7
+ This skill maps to the shortcut: `lark-cli im +chat-list` (internally calls `GET /open-apis/im/v1/chats`).
8
+
9
+ ## Commands
10
+
11
+ ```bash
12
+ # List the user's chats (default sort: create_time, ascending)
13
+ lark-cli im +chat-list
14
+
15
+ # Sort by recent activity (most recently active first)
16
+ lark-cli im +chat-list --sort active_time
17
+
18
+ # Limit page size
19
+ lark-cli im +chat-list --page-size 50
20
+
21
+ # Pagination
22
+ lark-cli im +chat-list --page-token "xxx"
23
+
24
+ # Fetch multiple pages automatically, up to 10 pages by default
25
+ lark-cli im +chat-list --page-all
26
+
27
+ # Drop muted chats
28
+ lark-cli im +chat-list --exclude-muted
29
+
30
+ # JSON output
31
+ lark-cli im +chat-list --format json
32
+
33
+ # Preview the request without executing it
34
+ lark-cli im +chat-list --dry-run
35
+
36
+ # Include p2p single chats — comma form
37
+ lark-cli im +chat-list --types p2p,group
38
+
39
+ # Same, using repeat flag instead of CSV
40
+ lark-cli im +chat-list --types p2p --types group
41
+
42
+ # Only p2p single chats
43
+ lark-cli im +chat-list --types p2p
44
+ ```
45
+
46
+ ## Parameters
47
+
48
+ | Parameter | Required | Limits | Description |
49
+ |------|------|------|------|
50
+ | `--user-id-type <type>` | No | `open_id` (default), `union_id`, `user_id` | ID type used for `owner_id` in the response |
51
+ | `--types <strings>` | No | `group`, `p2p` (comma-separated or repeated) | Chat types to include. Omitted = groups only (backward compatible) |
52
+ | `--sort <field>` | No | `create_time` (default, ascending), `active_time` (descending) | Result ordering |
53
+ | `--page-size <n>` | No | 1-100, default 20 | Number of results per page |
54
+ | `--page-token <token>` | No | - | Starting cursor, normally returned by a previous response |
55
+ | `--page-all` | No | - | Automatically fetch and merge subsequent pages; capped by `--page-limit` |
56
+ | `--page-limit <n>` | No | 1-1000, default 10 | Maximum pages fetched by `--page-all` |
57
+ | `--exclude-muted` | No | - | Drop chats the current user has muted (do-not-disturb); see "Filtering muted chats" below |
58
+ | `--format json` | No | - | Output as JSON |
59
+ | `--dry-run` | No | - | Preview the request without executing it |
60
+
61
+ With `--page-all`, `--page-token` sets the starting cursor. If `meta.pagination.complete=false`, resume from `meta.pagination.next_token` or raise `--page-limit`.
62
+
63
+ ## Output Fields
64
+
65
+ | Field | Description |
66
+ |------|------|
67
+ | `chat_id` | Chat ID (`oc_xxx` format) |
68
+ | `name` | Chat name |
69
+ | `description` | Chat description |
70
+ | `owner_id` | Owner ID (type controlled by `--user-id-type`) |
71
+ | `external` | Whether the chat is external |
72
+ | `chat_status` | Chat status (`normal` / `dissolved` / `dissolved_save`) |
73
+ | `chat_mode` | Chat mode discriminator: `group` (regular) / `topic` (topic group) / `p2p` (single chat) |
74
+ | `p2p_target_type` | Peer type, e.g., `user` |
75
+ | `p2p_target_id` | Peer ID (type controlled by `--user-id-type`) |
76
+
77
+ ## Including p2p single chats
78
+
79
+ Default behavior lists groups only — same as before this feature. To include p2p, pass `--types`:
80
+
81
+ | User intent | Call |
82
+ |---|---|
83
+ | "list my groups" / 我的群 / 我加入了哪些群 | (default, omit `--types`) |
84
+ | "list my p2p chats" / 我的单聊 / 我跟谁有 1v1 | `--types p2p` |
85
+ | "all my chats" / 全部聊天 / 所有会话 (ambiguous) | `--types p2p,group` |
86
+
87
+ For p2p rows in the response: `name` is the peer's display name, `owner_id` follows group semantics, `chat_mode = "p2p"`, and `p2p_target_type` / `p2p_target_id` identify the peer.
88
+
89
+ ## Filtering muted chats
90
+
91
+ `--exclude-muted` drops chats the current user has set to do-not-disturb. After the list call, the CLI batches the page's chat_ids through `POST /open-apis/im/v1/chat_user_setting/batch_get_mute_status` and filters client-side.
92
+
93
+ When the flag is set, the JSON envelope gains a `filter` sub-object (absent otherwise, so existing consumers are unaffected); `fetched_count == returned_count + filtered_count` always holds:
94
+
95
+ ```json
96
+ {
97
+ "chats": [...],
98
+ "filter": {
99
+ "applied": "exclude_muted",
100
+ "fetched_count": 20,
101
+ "returned_count": 17,
102
+ "filtered_count": 3,
103
+ "hint": "Filtered out 3 muted chat(s) on this page (17 remaining); use --page-token to fetch more."
104
+ }
105
+ }
106
+ ```
107
+
108
+ ## Usage Scenarios
109
+
110
+ ### Scenario 1: List my recent chats
111
+
112
+ ```bash
113
+ lark-cli im +chat-list --sort active_time --page-size 10
114
+ ```
115
+
116
+ ### Scenario 2: List my non-muted chats sorted by activity
117
+
118
+ ```bash
119
+ lark-cli im +chat-list --sort active_time --exclude-muted
120
+ ```
121
+
122
+ ### Scenario 3: Iterate all my chats programmatically
123
+
124
+ ```bash
125
+ TOKEN=""
126
+ while :; do
127
+ RESP=$(lark-cli im +chat-list --page-size 100 --page-token "$TOKEN" --format json)
128
+ echo "$RESP" | jq -r '.data.chats[].chat_id'
129
+ HAS_MORE=$(echo "$RESP" | jq -r '.data.has_more')
130
+ [ "$HAS_MORE" = "true" ] || break
131
+ TOKEN=$(echo "$RESP" | jq -r '.data.page_token')
132
+ done
133
+ ```
134
+
135
+ ## Common Errors and Troubleshooting
136
+
137
+ | Symptom | Root Cause | Solution |
138
+ |---------|---------|---------|
139
+ | `invalid --page-size 101: must be between 1 and 100` | page-size is out of range | Use an integer between 1 and 100 |
140
+ | Permission denied | The current identity is not authorized for `im:chat:read` | 鉴权由沙箱运行环境提供,无需手动补登录;确认目标群对当前用户可见后重试 |
@@ -0,0 +1,84 @@
1
+ # im +chat-members-list
2
+
3
+ List the members of a chat. Users and bots are returned in **separate buckets** — `users[]` and `bots[]` — with per-bucket totals (`user_total` / `bot_total`). Use `--member-types` to return only one kind.
4
+
5
+ This skill maps to the shortcut: `lark-cli im +chat-members-list` (internally calls `GET /open-apis/im/v1/chats/{chat_id}/members/list`).
6
+
7
+ ## Commands
8
+
9
+ ```bash
10
+ # Single page (default)
11
+ lark-cli im +chat-members-list --chat-id oc_xxx
12
+
13
+ # Only users, or users + bots
14
+ lark-cli im +chat-members-list --chat-id oc_xxx --member-types user
15
+ lark-cli im +chat-members-list --chat-id oc_xxx --member-types user,bot
16
+
17
+ # Walk every page (capped by --page-limit; 0 = unlimited)
18
+ lark-cli im +chat-members-list --chat-id oc_xxx --page-all --page-limit 0
19
+
20
+ # Fetch one page starting at a specific cursor
21
+ lark-cli im +chat-members-list --chat-id oc_xxx --page-token "xxx"
22
+
23
+ # Continue automatically from a specific cursor
24
+ lark-cli im +chat-members-list --chat-id oc_xxx --page-token "xxx" --page-all
25
+
26
+ # JSON output / preview the request
27
+ lark-cli im +chat-members-list --chat-id oc_xxx --format json
28
+ lark-cli im +chat-members-list --chat-id oc_xxx --dry-run
29
+ ```
30
+
31
+ ## Parameters
32
+
33
+ | Parameter | Required | Limits | Description |
34
+ |------|------|------|------|
35
+ | `--chat-id <id>` | Yes | `oc_xxx` | Target chat |
36
+ | `--member-types <strings>` | No | `user`, `bot` (comma-separated or repeated) | Member types to return. Omitted = all |
37
+ | `--member-id-type <type>` | No | `open_id` (default), `union_id`, `user_id` | ID type for `member_id` in the response |
38
+ | `--page-size <n>` | No | 1-100, default 20 | Results per page. With `--page-all` and no explicit `--page-size`, the max (100) is used automatically to minimize round-trips |
39
+ | `--page-token <token>` | No | - | Starting cursor, normally returned by a previous response |
40
+ | `--page-all` | No | - | Automatically walk every page (capped by `--page-limit`) |
41
+ | `--page-limit <n>` | No | default 10, `0` = unlimited | Max pages to fetch with `--page-all` |
42
+ | `--page-delay <ms>` | No | default 200, `0` = no delay | Delay between pages during `--page-all` (throttle to avoid rate limits on large lists) |
43
+ | `--format json` | No | - | Output as JSON |
44
+ | `--dry-run` | No | - | Preview the request without executing it |
45
+
46
+ > The caller must be in the target chat, and must belong to the same tenant for internal chats.
47
+
48
+ ## Output Fields
49
+
50
+ | Field | Description |
51
+ |------|------|
52
+ | `chat_id` | The queried chat ID |
53
+ | `users` | Array of user members (`member_id`, `name`, `tenant_key`, …) |
54
+ | `bots` | Array of bot members (`member_id`, `app_id`, `name`, …) |
55
+ | `user_total` / `bot_total` | Server-reported totals for each bucket |
56
+ | `truncations` | Non-empty when the server **capped a bucket** due to security config — see below |
57
+ | `has_more` / `page_token` | Paging signals from the final page fetched |
58
+
59
+ ## Truncation: the result may be incomplete
60
+
61
+ The server applies a security cap to large member lists. When a bucket is capped, the response carries a `truncations[]` entry (e.g. `[{"limit": 100, "member_type": "user"}]`) **on the final page only**. The shortcut surfaces this two ways so it is never missed:
62
+
63
+ - **stderr**: `⚠️ member list truncated by server security config: user bucket capped at 100 — the list is INCOMPLETE.`
64
+ - **stdout JSON**: the `truncations` array is preserved verbatim in the output.
65
+
66
+ A truncated result is *not* fixable by paging further — it is a server-side cap. Treat `users`/`bots` as a partial list whenever `truncations` is non-empty.
67
+
68
+ ## Pagination notes
69
+
70
+ - Default fetches a single page. Pass `--page-all` to drain every page.
71
+ - With `--page-all` and no explicit `--page-size`, the shortcut uses the maximum page size (100) so a full walk takes the fewest round-trips. An explicit `--page-size` is always honored.
72
+ - `--page-all` sleeps `--page-delay` ms (default 200) between pages to avoid hammering the API when a tenant has no server-side member cap and the list spans many pages. Set `--page-delay 0` to disable.
73
+ - `--page-all` stops at `--page-limit` pages (default 10). When it stops early, `has_more` stays `true` so you know the result is incomplete; re-run with `--page-limit 0` for everything.
74
+ - `--page-token` and `--page-all` together: automatic pagination starts at the supplied cursor and continues until exhaustion or `--page-limit`.
75
+ - Across pages, `users[]` and `bots[]` are concatenated; `truncations` / `has_more` / `page_token` come from the last page fetched.
76
+
77
+ ## Common Errors and Troubleshooting
78
+
79
+ | Symptom | Root Cause | Solution |
80
+ |---------|---------|---------|
81
+ | `--chat-id is required` | `--chat-id` omitted | Provide the `oc_xxx` chat ID |
82
+ | `invalid --page-size 101: must be between 1 and 100` | out of range | Use 1-100 |
83
+ | `--member-types contains invalid value` | value other than `user`/`bot` | Use `user`, `bot`, or both |
84
+ | Permission denied | missing `im:chat.members:read` | 鉴权由沙箱运行环境提供,无需手动补登录;确认目标群对当前用户可见后重试 |
@@ -0,0 +1,135 @@
1
+ # im +chat-search
2
+
3
+ Search the list of group chats visible to the current user, including chats the user belongs to and public chats visible to them. Supports keyword matching on chat names and member names, including pinyin and prefix fuzzy search.
4
+
5
+ This skill maps to the shortcut: `lark-cli im +chat-search` (internally calls `POST /open-apis/im/v2/chats/search`).
6
+
7
+ ## Commands
8
+
9
+ ```bash
10
+ # Search chats by keyword
11
+ lark-cli im +chat-search --query "project"
12
+
13
+ # Restrict by search types
14
+ lark-cli im +chat-search --query "project" --search-types "private,public_joined"
15
+
16
+ # Filter by chat mode (group = regular group, topic = topic/thread group)
17
+ lark-cli im +chat-search --query "project" --chat-modes "topic"
18
+
19
+ # Filter by member open_ids (with keyword)
20
+ lark-cli im +chat-search --query "project" --member-ids "ou_xxx,ou_yyy"
21
+
22
+ # Search by member open_ids only
23
+ lark-cli im +chat-search --member-ids "ou_xxx,ou_yyy"
24
+
25
+ # Only show chats you created or manage
26
+ lark-cli im +chat-search --query "project" --is-manager
27
+
28
+ # Set page size
29
+ lark-cli im +chat-search --query "project" --page-size 10
30
+
31
+ # Pagination
32
+ lark-cli im +chat-search --query "project" --page-token "xxx"
33
+
34
+ # Fetch multiple pages automatically, up to 10 pages by default
35
+ lark-cli im +chat-search --query "project" --page-all
36
+
37
+ # JSON output
38
+ lark-cli im +chat-search --query "project" --format json
39
+
40
+ # Preview the request without executing it
41
+ lark-cli im +chat-search --query "project" --dry-run
42
+ ```
43
+
44
+ ## Parameters
45
+
46
+ | Parameter | Required | Limits | Description |
47
+ |------|------|------|------|
48
+ | `--query <keyword>` | No (at least one of `--query` / `--member-ids` required) | Max 64 characters | Search keyword. Supports matching localized chat names, member names, multilingual search, pinyin, and prefix fuzzy search. If the query contains `-`, it is automatically wrapped in quotes |
49
+ | `--search-types <types>` | No | Comma-separated: `private`, `external`, `public_joined`, `public_not_joined` | Restrict the visible chat types returned by search |
50
+ | `--chat-modes <modes>` | No | Comma-separated: `group`, `topic` | Filter by chat mode (server-side): `group` = regular group, `topic` = topic/thread group |
51
+ | `--member-ids <ids>` | No (at least one of `--query` / `--member-ids` required) | Up to 50, format `ou_xxx` | Filter by member open_ids; can be used alone or combined with `--query` |
52
+ | `--is-manager` | No | - | Only show chats you created or manage |
53
+ | `--disable-search-by-user` | No | - | Disable member-name-based matching and search by group name only |
54
+ | `--sort <field>` | No | `create_time`, `update_time`, `member_count` | Sort field (always descending) |
55
+ | `--page-size <n>` | No | 1-100, default 20 | Number of results per page |
56
+ | `--page-token <token>` | No | - | Starting cursor, normally returned by a previous response |
57
+ | `--page-all` | No | - | Automatically fetch and merge subsequent pages; capped by `--page-limit` |
58
+ | `--page-limit <n>` | No | 1-1000, default 10 | Maximum pages fetched by `--page-all` |
59
+ | `--exclude-muted` | No | - | Drop chats the current user has muted (do-not-disturb); see "Filtering muted chats" below |
60
+ | `--format json` | No | - | Output as JSON |
61
+ | `--dry-run` | No | - | Preview the request without executing it |
62
+
63
+ With `--page-all`, `--page-token` sets the starting cursor. If `meta.pagination.complete=false`, resume from `meta.pagination.next_token` or raise `--page-limit`.
64
+
65
+ > **CAUTION:** `--sort` is **always descending** — the search API only ranks the chosen field high-to-low (e.g. `member_count` = most members first). There is no ascending option. If the user asks for "fewest first / ascending / 从少到多", tell them the search API does not support ascending order; any low-to-high view requires re-sorting the fetched page client-side and is not an upstream sort. Do **not** invent values like `member_count_asc` or pass `asc` (they are rejected).
66
+
67
+ ## Output Fields
68
+
69
+ | Field | Description |
70
+ |------|------|
71
+ | `chat_id` | Chat ID (`oc_xxx` format) |
72
+ | `name` | Chat name |
73
+ | `description` | Chat description |
74
+ | `owner_id` | Owner ID |
75
+ | `external` | Whether the chat is external |
76
+ | `chat_status` | Chat status (`normal` / `dissolved` / `dissolved_save`) |
77
+
78
+ ## Filtering muted chats
79
+
80
+ `--exclude-muted` drops chats the current user has set to do-not-disturb. After the search call, the CLI batches the page's chat_ids through `POST /open-apis/im/v1/chat_user_setting/batch_get_mute_status` and filters client-side.
81
+
82
+ When the flag is set, the JSON envelope gains a `filter` sub-object (absent otherwise, so existing consumers are unaffected); `fetched_count == returned_count + filtered_count` always holds:
83
+
84
+ ```json
85
+ {
86
+ "chats": [...],
87
+ "filter": {
88
+ "applied": "exclude_muted",
89
+ "fetched_count": 20,
90
+ "returned_count": 19,
91
+ "filtered_count": 1,
92
+ "hint": "Filtered out 1 muted chat(s) on this page (19 remaining, including 2 non-member public group(s)); use --page-token to fetch more."
93
+ }
94
+ }
95
+ ```
96
+
97
+ Note: only confirmed-muted chats count toward `filtered_count`; non-member public groups are retained and surfaced in `hint`. For strict member-only results, combine with `--search-types "private,public_joined,external"`.
98
+
99
+ ## Usage Scenarios
100
+
101
+ ### Scenario 1: Search chats that contain a keyword
102
+
103
+ ```bash
104
+ lark-cli im +chat-search --query "design review"
105
+ ```
106
+
107
+ ### Scenario 2: Search a chat and list its members
108
+
109
+ ```bash
110
+ CHAT_ID=$(lark-cli im +chat-search --query "project" --format json | jq -r '.data.chats[0].chat_id')
111
+ lark-cli im +chat-members-list --chat-id "$CHAT_ID"
112
+ ```
113
+
114
+ ## Common Errors and Troubleshooting
115
+
116
+ | Symptom | Root Cause | Solution |
117
+ |---------|---------|---------|
118
+ | `--query and --member-ids cannot both be empty` | Both were omitted | Provide at least `--query` or `--member-ids` |
119
+ | Empty results | No visible chats matched the keyword or filters | Relax the keyword or filters and try again |
120
+ | `invalid --page-size 101: must be between 1 and 100` | page-size is out of range | Use an integer between 1 and 100 |
121
+ | Permission denied | The current identity is not authorized for `im:chat:read` | 鉴权由沙箱运行环境提供,无需手动补登录;确认目标群对当前用户可见后重试 |
122
+
123
+ ## AI Usage Guidance
124
+
125
+ When the user asks to search chats, follow these rules:
126
+
127
+ 1. **At least one filter required:** `--query` and `--member-ids` cannot both be empty. Either alone or combined together are valid.
128
+ 2. **Search scope is limited:** only chats visible to the current user can be found (joined chats plus public chats). This is not a global search over all chats.
129
+ 3. **Control result volume:** the result set may be large. Use `--page-size` deliberately.
130
+ 4. **Suggest follow-up actions:** after finding a chat, a common next step is listing its members (`im +chat-members-list`).
131
+ 5. **NEVER fall back to chats list:** If `+chat-search` returns empty results, do NOT attempt to use `+chat-list` or `GET /open-apis/im/v1/chats` as a fallback. The list API is not a search API — it returns all chats without keyword filtering and will not help locate the target chat. Instead, ask the user to refine the keyword or check whether the chat is visible to the current identity.
132
+
133
+ ## References
134
+
135
+ - [lark-im](../README.md) - all IM commands
@@ -0,0 +1,232 @@
1
+ # im reactions
2
+
3
+ This reference is the annotation target for the read-only IM reaction APIs available in this sandbox:
4
+
5
+ - `im.reactions.list`
6
+ - `im.reactions.batch_query`
7
+
8
+ It focuses on:
9
+
10
+ - What each reaction read method does
11
+ - The request/response shape you need when calling the raw API commands
12
+ - The complete `emoji_type` list used in reaction payloads and filters
13
+
14
+ > **Important:** These raw API commands accept structured input through `--params '<json>'` and `--data '<json>'`. They do not expose typed flags such as `--message-id` or `--reaction-type` directly.
15
+
16
+ ## Command Overview
17
+
18
+ | Method | HTTP | Path | Purpose |
19
+ |---|---|---|---|
20
+ | `im.reactions.list` | `GET` | `/open-apis/im/v1/messages/{message_id}/reactions` | List reaction records on one message |
21
+ | `im.reactions.batch_query` | `POST` | `/open-apis/im/v1/messages/reactions/batch_query` | Query reactions for multiple messages in one request |
22
+
23
+ ## Common Notes
24
+
25
+ - `message_id` is always an IM message ID such as `om_xxx`
26
+ - `reaction_id` is the unique record ID of a reaction
27
+ - `reaction_type.emoji_type` is the enum-like emoji identifier used by the read APIs
28
+ - Reaction APIs return **reaction records**, not only aggregated counts
29
+ - When the operator is a human user, the returned ID type may depend on `user_id_type`
30
+
31
+ ## Inspect Schema
32
+
33
+ ```bash
34
+ lark-cli schema im.reactions
35
+ lark-cli schema im.reactions.list --format pretty
36
+ ```
37
+
38
+ If your local build has already exposed the batch API in `schema`, also check:
39
+
40
+ ```bash
41
+ lark-cli schema im.reactions.batch_query --format pretty
42
+ ```
43
+
44
+ ## list
45
+
46
+ List reaction records on one message.
47
+
48
+ ```bash
49
+ lark-cli im reactions list --params '{"message_id":"om_xxx"}'
50
+ lark-cli im reactions list --params '{"message_id":"om_xxx","reaction_type":"SMILE"}'
51
+ lark-cli im reactions list --params '{"message_id":"om_xxx","page_size":50}'
52
+ lark-cli im reactions list --params '{"message_id":"om_xxx","page_token":"<PAGE_TOKEN>"}'
53
+ lark-cli im reactions list --params '{"message_id":"om_xxx","user_id_type":"open_id"}'
54
+ ```
55
+
56
+ ### Request Parameters (`--params`)
57
+
58
+ | Parameter | Required | Description |
59
+ |---|---|---|
60
+ | `message_id` | Yes | Message ID (`om_xxx`) |
61
+ | `reaction_type` | No | Filter by one emoji type such as `SMILE` or `LAUGH` |
62
+ | `page_size` | No | Number of records per page. Default is 20 |
63
+ | `page_token` | No | Pagination token from the previous page |
64
+ | `user_id_type` | No | Returned operator ID type when `operator_type=user`: `open_id`, `union_id`, or `user_id` |
65
+
66
+ ### Response Shape
67
+
68
+ ```json
69
+ {
70
+ "items": [
71
+ {
72
+ "reaction_id": "ZCaCIjUBVVWSrm5L-3ZTw_xxx",
73
+ "operator": {
74
+ "operator_id": "ou_xxx",
75
+ "operator_type": "user"
76
+ },
77
+ "action_time": "1663054162546",
78
+ "reaction_type": {
79
+ "emoji_type": "SMILE"
80
+ }
81
+ }
82
+ ],
83
+ "has_more": true,
84
+ "page_token": "YhljsPiGfUgnVAg9urvRFd-BvSqRLxxxx"
85
+ }
86
+ ```
87
+
88
+ ### Top-Level Fields
89
+
90
+ | Field | Type | Meaning |
91
+ |---|---|---|
92
+ | `items` | `array<object>` | Reaction records for the current page |
93
+ | `has_more` | `boolean` | Whether more pages are available |
94
+ | `page_token` | `string` | Token for the next page when `has_more=true` |
95
+
96
+ ### `items[]` Fields
97
+
98
+ | Field | Type | Meaning |
99
+ |---|---|---|
100
+ | `reaction_id` | `string` | Unique ID of this reaction record |
101
+ | `operator` | `object` | Identity of the user or app that added the reaction |
102
+ | `action_time` | `string` | Unix timestamp in milliseconds |
103
+ | `reaction_type` | `object` | Reaction payload. The key field is `emoji_type` |
104
+
105
+ ### `operator` Fields
106
+
107
+ | Field | Type | Meaning |
108
+ |---|---|---|
109
+ | `operator.operator_id` | `string` | Operator ID. If `operator_type=user`, the returned ID type follows `user_id_type`; if `operator_type=app`, this is the app ID |
110
+ | `operator.operator_type` | `string` | `user` or `app` |
111
+
112
+ ## batch_query
113
+
114
+ Query reactions for multiple messages in one request.
115
+
116
+ ```bash
117
+ lark-cli im reactions batch_query \
118
+ --params '{"user_id_type":"open_id"}' \
119
+ --data '{
120
+ "queries":[
121
+ {"message_id":"om_xxx"},
122
+ {"message_id":"om_yyy","page_token":"<PAGE_TOKEN>"}
123
+ ],
124
+ "page_size_per_message":10,
125
+ "reaction_type":"LAUGH"
126
+ }'
127
+ ```
128
+
129
+ ### Request
130
+
131
+ #### `--params`
132
+
133
+ | Parameter | Required | Description |
134
+ |---|---|---|
135
+ | `user_id_type` | No | Returned user ID type in operator info: `open_id`, `union_id`, or `user_id` |
136
+
137
+ #### `--data`
138
+
139
+ | Field | Required | Description |
140
+ |---|---|---|
141
+ | `queries` | Yes | Array of target messages |
142
+ | `queries[].message_id` | No | Message ID to query |
143
+ | `queries[].page_token` | No | Continuation token for that message |
144
+ | `page_size_per_message` | No | Max reactions returned per message |
145
+ | `reaction_type` | No | Filter by one emoji type |
146
+
147
+ ### Response
148
+
149
+ The meta definition contains three top-level result groups:
150
+
151
+ | Field | Meaning |
152
+ |---|---|
153
+ | `success_msg_reaction_details` | Per-message reaction detail records |
154
+ | `success_msg_reaction_counts` | Per-message aggregated reaction counts |
155
+ | `fail_msg_reaction_details` | Query failures for individual messages |
156
+
157
+ #### `success_msg_reaction_details`
158
+
159
+ Each `message_reaction_items[]` element includes:
160
+
161
+ - `reaction_id`
162
+ - `operator`
163
+ - `action_time`
164
+ - `emoji_type`
165
+
166
+ #### `success_msg_reaction_counts`
167
+
168
+ Each aggregated count record includes:
169
+
170
+ - `message_id`
171
+ - `reaction_count[].reaction_type`
172
+ - `reaction_count[].count`
173
+
174
+ #### `fail_msg_reaction_details`
175
+
176
+ Each failed message record includes:
177
+
178
+ - `message_id`
179
+ - `fail_reason`
180
+
181
+ Supported `fail_reason` values from meta:
182
+
183
+ - `invalid`
184
+ - `invalid_page_token`
185
+ - `no_permission`
186
+
187
+ ## `emoji_type` Field
188
+
189
+ Reaction emoji identifiers are used in slightly different field names across the read APIs:
190
+
191
+ - `im.reactions.list`: request filter uses `reaction_type`, response uses `reaction_type.emoji_type`
192
+ - `im.reactions.batch_query`: request filter uses top-level `reaction_type`, detail results use `message_reaction_items[].emoji_type`, aggregated results use `reaction_count[].reaction_type`
193
+
194
+ ## Complete `emoji_type` List
195
+
196
+ The following list is synchronized from the official Feishu reaction emoji documentation:
197
+
198
+ - Source page: `https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce`
199
+ - Markdown source: `https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce.md`
200
+
201
+ Current count in the fetched source: `185`.
202
+
203
+ ```text
204
+ OK, THUMBSUP, THANKS, MUSCLE, FINGERHEART, APPLAUSE, FISTBUMP, JIAYI
205
+ DONE, SMILE, BLUSH, LAUGH, SMIRK, LOL, FACEPALM, LOVE
206
+ WINK, PROUD, WITTY, SMART, SCOWL, THINKING, SOB, CRY
207
+ ERROR, NOSEPICK, HAUGHTY, SLAP, SPITBLOOD, TOASTED, GLANCE, DULL
208
+ INNOCENTSMILE, JOYFUL, WOW, TRICK, YEAH, ENOUGH, TEARS, EMBARRASSED
209
+ KISS, SMOOCH, DROOL, OBSESSED, MONEY, TEASE, SHOWOFF, COMFORT
210
+ CLAP, PRAISE, STRIVE, XBLUSH, SILENT, WAVE, WHAT, FROWN
211
+ SHY, DIZZY, LOOKDOWN, CHUCKLE, WAIL, CRAZY, WHIMPER, HUG
212
+ BLUBBER, WRONGED, HUSKY, SHHH, SMUG, ANGRY, HAMMER, SHOCKED
213
+ TERROR, PETRIFIED, SKULL, SWEAT, SPEECHLESS, SLEEP, DROWSY, YAWN
214
+ SICK, PUKE, BETRAYED, HEADSET, EatingFood, MeMeMe, Sigh, Typing
215
+ Lemon, Get, LGTM, OnIt, OneSecond, VRHeadset, YouAreTheBest, SALUTE
216
+ SHAKE, HIGHFIVE, UPPERLEFT, ThumbsDown, SLIGHT, TONGUE, EYESCLOSED, RoarForYou
217
+ CALF, BEAR, BULL, RAINBOWPUKE, ROSE, HEART, PARTY, LIPS
218
+ BEER, CAKE, GIFT, CUCUMBER, Drumstick, Pepper, CANDIEDHAWS, BubbleTea
219
+ Coffee, Yes, No, OKR, CheckMark, CrossMark, MinusOne, Hundred
220
+ AWESOMEN, Pin, Alarm, Loudspeaker, Trophy, Fire, BOMB, Music
221
+ XmasTree, Snowman, XmasHat, FIREWORKS, 2022, REDPACKET, FORTUNE, LUCK
222
+ FIRECRACKER, StickyRiceBalls, HEARTBROKEN, POOP, StatusFlashOfInspiration, 18X, CLEAVER, Soccer
223
+ Basketball, GeneralDoNotDisturb, Status_PrivateMessage, GeneralInMeetingBusy, StatusReading, StatusInFlight, GeneralBusinessTrip, GeneralWorkFromHome
224
+ StatusEnjoyLife, GeneralTravellingCar, StatusBus, GeneralSun, GeneralMoonRest, MoonRabbit, Mooncake, JubilantRabbit
225
+ TV, Movie, Pumpkin, BeamingFace, Delighted, ColdSweat, FullMoonFace, Partying
226
+ GoGoGo, ThanksFace, SaluteFace, Shrug, ClownFace, HappyDragon
227
+ ```
228
+
229
+ ## References
230
+
231
+ - [lark-im](../README.md) - all IM commands
232
+ - Official emoji doc: `https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce`