@satorijs/adapter-lark 3.10.6 → 3.11.0

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 (116) hide show
  1. package/lib/index.cjs +2880 -2370
  2. package/lib/internal.d.ts +4 -4
  3. package/lib/types/acs.d.ts +212 -172
  4. package/lib/types/admin.d.ts +331 -291
  5. package/lib/types/aily.d.ts +331 -216
  6. package/lib/types/apaas.d.ts +646 -494
  7. package/lib/types/application.d.ts +559 -458
  8. package/lib/types/approval.d.ts +826 -791
  9. package/lib/types/attendance.d.ts +1094 -994
  10. package/lib/types/auth.d.ts +66 -61
  11. package/lib/types/authen.d.ts +221 -186
  12. package/lib/types/baike.d.ts +258 -233
  13. package/lib/types/base.d.ts +74 -0
  14. package/lib/types/bitable.d.ts +830 -770
  15. package/lib/types/board.d.ts +29 -14
  16. package/lib/types/calendar.d.ts +660 -605
  17. package/lib/types/cardkit.d.ts +149 -134
  18. package/lib/types/compensation.d.ts +84 -49
  19. package/lib/types/contact.d.ts +1279 -1204
  20. package/lib/types/corehr.d.ts +4982 -4526
  21. package/lib/types/directory.d.ts +447 -0
  22. package/lib/types/docs.d.ts +28 -18
  23. package/lib/types/document_ai.d.ts +347 -252
  24. package/lib/types/docx.d.ts +428 -383
  25. package/lib/types/drive.d.ts +1093 -1048
  26. package/lib/types/ehr.d.ts +66 -51
  27. package/lib/types/event.d.ts +16 -6
  28. package/lib/types/helpdesk.d.ts +816 -741
  29. package/lib/types/hire.d.ts +3955 -3589
  30. package/lib/types/human_authentication.d.ts +32 -22
  31. package/lib/types/im.d.ts +1420 -1295
  32. package/lib/types/index.d.ts +1422 -330
  33. package/lib/types/lingo.d.ts +279 -249
  34. package/lib/types/mail.d.ts +1032 -675
  35. package/lib/types/mdm.d.ts +105 -37
  36. package/lib/types/minutes.d.ts +73 -26
  37. package/lib/types/moments.d.ts +23 -13
  38. package/lib/types/okr.d.ts +266 -225
  39. package/lib/types/optical_char_recognition.d.ts +22 -12
  40. package/lib/types/passport.d.ts +58 -48
  41. package/lib/types/payroll.d.ts +210 -53
  42. package/lib/types/performance.d.ts +463 -414
  43. package/lib/types/personal_settings.d.ts +93 -82
  44. package/lib/types/report.d.ts +79 -58
  45. package/lib/types/search.d.ts +265 -235
  46. package/lib/types/security_and_compliance.d.ts +30 -19
  47. package/lib/types/sheets.d.ts +356 -321
  48. package/lib/types/speech_to_text.d.ts +44 -34
  49. package/lib/types/task.d.ts +998 -1087
  50. package/lib/types/tenant.d.ts +25 -15
  51. package/lib/types/translation.d.ts +42 -32
  52. package/lib/types/trust_party.d.ts +81 -0
  53. package/lib/types/vc.d.ts +1218 -1123
  54. package/lib/types/verification.d.ts +11 -6
  55. package/lib/types/wiki.d.ts +270 -235
  56. package/lib/types/workplace.d.ts +58 -38
  57. package/lib/utils.d.ts +2 -2
  58. package/package.json +4 -4
  59. package/src/bot.ts +15 -15
  60. package/src/internal.ts +29 -12
  61. package/src/message.ts +10 -10
  62. package/src/types/acs.ts +234 -186
  63. package/src/types/admin.ts +353 -305
  64. package/src/types/aily.ts +375 -233
  65. package/src/types/apaas.ts +754 -568
  66. package/src/types/application.ts +633 -507
  67. package/src/types/approval.ts +914 -872
  68. package/src/types/attendance.ts +1226 -1104
  69. package/src/types/auth.ts +72 -66
  70. package/src/types/authen.ts +233 -191
  71. package/src/types/baike.ts +276 -246
  72. package/src/types/base.ts +93 -0
  73. package/src/types/bitable.ts +966 -894
  74. package/src/types/board.ts +34 -16
  75. package/src/types/calendar.ts +751 -685
  76. package/src/types/cardkit.ts +164 -146
  77. package/src/types/compensation.ts +97 -55
  78. package/src/types/contact.ts +1465 -1375
  79. package/src/types/corehr.ts +5664 -5077
  80. package/src/types/directory.ts +569 -0
  81. package/src/types/docs.ts +31 -19
  82. package/src/types/document_ai.ts +401 -287
  83. package/src/types/docx.ts +492 -438
  84. package/src/types/drive.ts +1266 -1213
  85. package/src/types/ehr.ts +71 -53
  86. package/src/types/event.ts +19 -7
  87. package/src/types/helpdesk.ts +930 -840
  88. package/src/types/hire.ts +4453 -4019
  89. package/src/types/human_authentication.ts +35 -23
  90. package/src/types/im.ts +1626 -1476
  91. package/src/types/index.ts +1532 -346
  92. package/src/types/lingo.ts +299 -263
  93. package/src/types/mail.ts +1231 -779
  94. package/src/types/mdm.ts +122 -39
  95. package/src/types/minutes.ts +88 -28
  96. package/src/types/moments.ts +26 -14
  97. package/src/types/okr.ts +286 -238
  98. package/src/types/optical_char_recognition.ts +25 -13
  99. package/src/types/passport.ts +62 -50
  100. package/src/types/payroll.ts +254 -57
  101. package/src/types/performance.ts +528 -467
  102. package/src/types/personal_settings.ts +101 -89
  103. package/src/types/report.ts +86 -62
  104. package/src/types/search.ts +285 -249
  105. package/src/types/security_and_compliance.ts +33 -21
  106. package/src/types/sheets.ts +421 -379
  107. package/src/types/speech_to_text.ts +48 -36
  108. package/src/types/task.ts +1152 -1260
  109. package/src/types/tenant.ts +29 -17
  110. package/src/types/translation.ts +46 -34
  111. package/src/types/trust_party.ts +110 -0
  112. package/src/types/vc.ts +1397 -1283
  113. package/src/types/verification.ts +13 -7
  114. package/src/types/wiki.ts +293 -251
  115. package/src/types/workplace.ts +65 -41
  116. package/src/utils.ts +3 -3
package/src/types/im.ts CHANGED
@@ -1,1605 +1,1755 @@
1
- import { BatchMessageReadUser, BatchMessageRecallProgress, BatchMessageSendProgress, ChatMenuItem, ChatMenuTree, ChatTab, ChatTopNotice, CreateTag, CreateTagFailReason, Emoji, FailedReason, FollowUp, I18nNames, ListChat, ListMember, ListModerator, Mention, Message, MessageBody, MessageReaction, OpenAppFeedCard, OpenAppFeedCardButtons, OpenFailedUserAppFeedCardItem, Operator, PatchTag, PatchTagFailReason, Pin, ReadUser, RestrictedModeSetting, Sender, TagInfo, TagInfoWithBindVersion, UserOpenAppFeedCardDeleter, UserOpenAppFeedCardUpdater } from '.'
2
- import { Internal, Pagination } from '../internal'
1
+ import * as Lark from '.'
2
+ import { Internal, Paginated, Pagination } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
- /**
7
- * 发送消息
8
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create
9
- */
10
- createImMessage(body: CreateImMessageRequest, query?: CreateImMessageQuery): Promise<CreateImMessageResponse>
11
- /**
12
- * 回复消息
13
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply
14
- */
15
- replyImMessage(message_id: string, body: ReplyImMessageRequest): Promise<ReplyImMessageResponse>
16
- /**
17
- * 编辑消息
18
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update
19
- */
20
- updateImMessage(message_id: string, body: UpdateImMessageRequest): Promise<UpdateImMessageResponse>
21
- /**
22
- * 转发消息
23
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward
24
- */
25
- forwardImMessage(message_id: string, body: ForwardImMessageRequest, query?: ForwardImMessageQuery): Promise<ForwardImMessageResponse>
26
- /**
27
- * 合并转发消息
28
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward
29
- */
30
- mergeForwardImMessage(body: MergeForwardImMessageRequest, query?: MergeForwardImMessageQuery): Promise<MergeForwardImMessageResponse>
31
- /**
32
- * 转发话题
33
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/thread/forward
34
- */
35
- forwardImThread(thread_id: string, body: ForwardImThreadRequest, query?: ForwardImThreadQuery): Promise<ForwardImThreadResponse>
36
- /**
37
- * 撤回消息
38
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete
39
- */
40
- deleteImMessage(message_id: string): Promise<void>
41
- /**
42
- * 添加跟随气泡
43
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/push_follow_up
44
- */
45
- pushFollowUpImMessage(message_id: string, body: PushFollowUpImMessageRequest): Promise<void>
46
- /**
47
- * 查询消息已读信息
48
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users
49
- */
50
- readUsersImMessage(message_id: string, query?: ReadUsersImMessageQuery): Paginated<ReadUser>
51
- /**
52
- * 获取会话历史消息
53
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list
54
- */
55
- listImMessage(query?: ListImMessageQuery): Paginated<Message>
56
- /**
57
- * 获取消息中的资源文件
58
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get
59
- */
60
- getImMessageResource(message_id: string, file_key: string, query?: GetImMessageResourceQuery): Promise<ArrayBuffer>
61
- /**
62
- * 获取指定消息的内容
63
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get
64
- */
65
- getImMessage(message_id: string, query?: GetImMessageQuery): Promise<GetImMessageResponse>
66
- /**
67
- * 批量撤回消息
68
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete
69
- */
70
- deleteImBatchMessage(batch_message_id: string): Promise<void>
71
- /**
72
- * 查询批量消息推送和阅读人数
73
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user
74
- */
75
- readUserImBatchMessage(batch_message_id: string): Promise<ReadUserImBatchMessageResponse>
76
- /**
77
- * 查询批量消息整体进度
78
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/get_progress
79
- */
80
- getProgressImBatchMessage(batch_message_id: string): Promise<GetProgressImBatchMessageResponse>
81
- /**
82
- * 上传图片
83
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create
84
- */
85
- createImImage(form: CreateImImageForm): Promise<CreateImImageResponse>
86
- /**
87
- * 下载图片
88
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get
89
- */
90
- getImImage(image_key: string): Promise<ArrayBuffer>
91
- /**
92
- * 上传文件
93
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create
94
- */
95
- createImFile(form: CreateImFileForm): Promise<CreateImFileResponse>
96
- /**
97
- * 下载文件
98
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/get
99
- */
100
- getImFile(file_key: string): Promise<ArrayBuffer>
101
- /**
102
- * 发送应用内加急
103
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_app
104
- */
105
- urgentAppImMessage(message_id: string, body: UrgentAppImMessageRequest, query?: UrgentAppImMessageQuery): Promise<UrgentAppImMessageResponse>
106
- /**
107
- * 发送短信加急
108
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_sms
109
- */
110
- urgentSmsImMessage(message_id: string, body: UrgentSmsImMessageRequest, query?: UrgentSmsImMessageQuery): Promise<UrgentSmsImMessageResponse>
111
- /**
112
- * 发送电话加急
113
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_phone
114
- */
115
- urgentPhoneImMessage(message_id: string, body: UrgentPhoneImMessageRequest, query?: UrgentPhoneImMessageQuery): Promise<UrgentPhoneImMessageResponse>
116
- /**
117
- * 添加消息表情回复
118
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create
119
- */
120
- createImMessageReaction(message_id: string, body: CreateImMessageReactionRequest): Promise<CreateImMessageReactionResponse>
121
- /**
122
- * 获取消息表情回复
123
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list
124
- */
125
- listImMessageReaction(message_id: string, query?: ListImMessageReactionQuery): Paginated<MessageReaction>
126
- /**
127
- * 删除消息表情回复
128
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete
129
- */
130
- deleteImMessageReaction(message_id: string, reaction_id: string): Promise<DeleteImMessageReactionResponse>
131
- /**
132
- * Pin 消息
133
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create
134
- */
135
- createImPin(body: CreateImPinRequest): Promise<CreateImPinResponse>
136
- /**
137
- * 移除 Pin 消息
138
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete
139
- */
140
- deleteImPin(message_id: string): Promise<void>
141
- /**
142
- * 获取群内 Pin 消息
143
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list
144
- */
145
- listImPin(query?: ListImPinQuery): Paginated<Pin>
146
- /**
147
- * 更新应用发送的消息卡片
148
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch
149
- */
150
- patchImMessage(message_id: string, body: PatchImMessageRequest): Promise<void>
151
- /**
152
- * 更新 URL 预览
153
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/url_preview/batch_update
154
- */
155
- batchUpdateImUrlPreview(body: BatchUpdateImUrlPreviewRequest): Promise<void>
156
- /**
157
- * 创建群
158
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
159
- */
160
- createImChat(body: CreateImChatRequest, query?: CreateImChatQuery): Promise<CreateImChatResponse>
161
- /**
162
- * 解散群
163
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete
164
- */
165
- deleteImChat(chat_id: string): Promise<void>
166
- /**
167
- * 更新群信息
168
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update
169
- */
170
- updateImChat(chat_id: string, body: UpdateImChatRequest, query?: UpdateImChatQuery): Promise<void>
171
- /**
172
- * 更新群发言权限
173
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update
174
- */
175
- updateImChatModeration(chat_id: string, body: UpdateImChatModerationRequest, query?: UpdateImChatModerationQuery): Promise<void>
176
- /**
177
- * 获取群信息
178
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get
179
- */
180
- getImChat(chat_id: string, query?: GetImChatQuery): Promise<GetImChatResponse>
181
- /**
182
- * 更新群置顶
183
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice
184
- */
185
- putTopNoticeImChatTopNotice(chat_id: string, body: PutTopNoticeImChatTopNoticeRequest): Promise<void>
186
- /**
187
- * 撤销群置顶
188
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice
189
- */
190
- deleteTopNoticeImChatTopNotice(chat_id: string): Promise<void>
191
- /**
192
- * 获取用户或机器人所在的群列表
193
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list
194
- */
195
- listImChat(query?: ListImChatQuery): Paginated<ListChat>
196
- /**
197
- * 搜索对用户或机器人可见的群列表
198
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search
199
- */
200
- searchImChat(query?: SearchImChatQuery): Paginated<ListChat>
201
- /**
202
- * 获取群成员发言权限
203
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get
204
- */
205
- getImChatModeration(chat_id: string, query?: GetImChatModerationQuery): Promise<GetImChatModerationResponse>
206
- /**
207
- * 获取群分享链接
208
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link
209
- */
210
- linkImChat(chat_id: string, body: LinkImChatRequest): Promise<LinkImChatResponse>
211
- /**
212
- * 指定群管理员
213
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers
214
- */
215
- addManagersImChatManagers(chat_id: string, body: AddManagersImChatManagersRequest, query?: AddManagersImChatManagersQuery): Promise<AddManagersImChatManagersResponse>
216
- /**
217
- * 删除群管理员
218
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers
219
- */
220
- deleteManagersImChatManagers(chat_id: string, body: DeleteManagersImChatManagersRequest, query?: DeleteManagersImChatManagersQuery): Promise<DeleteManagersImChatManagersResponse>
221
- /**
222
- * 将用户或机器人拉入群聊
223
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create
224
- */
225
- createImChatMembers(chat_id: string, body: CreateImChatMembersRequest, query?: CreateImChatMembersQuery): Promise<CreateImChatMembersResponse>
226
- /**
227
- * 用户或机器人主动加入群聊
228
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join
229
- */
230
- meJoinImChatMembers(chat_id: string): Promise<void>
231
- /**
232
- * 将用户或机器人移出群聊
233
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete
234
- */
235
- deleteImChatMembers(chat_id: string, body: DeleteImChatMembersRequest, query?: DeleteImChatMembersQuery): Promise<DeleteImChatMembersResponse>
236
- /**
237
- * 获取群成员列表
238
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get
239
- */
240
- getImChatMembers(chat_id: string, query?: GetImChatMembersQuery): Promise<GetImChatMembersResponse>
241
- /**
242
- * 判断用户或机器人是否在群里
243
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat
244
- */
245
- isInChatImChatMembers(chat_id: string): Promise<IsInChatImChatMembersResponse>
246
- /**
247
- * 更新群公告信息
248
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch
249
- */
250
- patchImChatAnnouncement(chat_id: string, body: PatchImChatAnnouncementRequest): Promise<void>
251
- /**
252
- * 获取群公告信息
253
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get
254
- */
255
- getImChatAnnouncement(chat_id: string, query?: GetImChatAnnouncementQuery): Promise<GetImChatAnnouncementResponse>
256
- /**
257
- * 添加会话标签页
258
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create
259
- */
260
- createImChatTab(chat_id: string, body: CreateImChatTabRequest): Promise<CreateImChatTabResponse>
261
- /**
262
- * 删除会话标签页
263
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs
264
- */
265
- deleteTabsImChatTab(chat_id: string, body: DeleteTabsImChatTabRequest): Promise<DeleteTabsImChatTabResponse>
266
- /**
267
- * 更新会话标签页
268
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs
269
- */
270
- updateTabsImChatTab(chat_id: string, body: UpdateTabsImChatTabRequest): Promise<UpdateTabsImChatTabResponse>
271
- /**
272
- * 会话标签页排序
273
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs
274
- */
275
- sortTabsImChatTab(chat_id: string, body: SortTabsImChatTabRequest): Promise<SortTabsImChatTabResponse>
276
- /**
277
- * 拉取会话标签页
278
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs
279
- */
280
- listTabsImChatTab(chat_id: string): Promise<ListTabsImChatTabResponse>
281
- /**
282
- * 添加群菜单
283
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create
284
- */
285
- createImChatMenuTree(chat_id: string, body: CreateImChatMenuTreeRequest): Promise<CreateImChatMenuTreeResponse>
286
- /**
287
- * 删除群菜单
288
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete
289
- */
290
- deleteImChatMenuTree(chat_id: string, body: DeleteImChatMenuTreeRequest): Promise<DeleteImChatMenuTreeResponse>
291
- /**
292
- * 修改群菜单元信息
293
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch
294
- */
295
- patchImChatMenuItem(chat_id: string, menu_item_id: string, body: PatchImChatMenuItemRequest): Promise<PatchImChatMenuItemResponse>
296
- /**
297
- * 排序群菜单
298
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort
299
- */
300
- sortImChatMenuTree(chat_id: string, body: SortImChatMenuTreeRequest): Promise<SortImChatMenuTreeResponse>
301
- /**
302
- * 获取群菜单
303
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get
304
- */
305
- getImChatMenuTree(chat_id: string): Promise<GetImChatMenuTreeResponse>
306
- /**
307
- * 创建应用消息流卡片
308
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card/create
309
- */
310
- createImAppFeedCard(body: CreateImAppFeedCardRequest, query?: CreateImAppFeedCardQuery): Promise<CreateImAppFeedCardResponse>
311
- /**
312
- * 更新应用消息流卡片
313
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/update
314
- */
315
- updateImAppFeedCardBatch(body: UpdateImAppFeedCardBatchRequest, query?: UpdateImAppFeedCardBatchQuery): Promise<UpdateImAppFeedCardBatchResponse>
316
- /**
317
- * 删除应用消息流卡片
318
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/delete
319
- */
320
- deleteImAppFeedCardBatch(body: DeleteImAppFeedCardBatchRequest, query?: DeleteImAppFeedCardBatchQuery): Promise<DeleteImAppFeedCardBatchResponse>
321
- /**
322
- * 机器人单聊即时提醒
323
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/bot_time_sentive
324
- */
325
- botTimeSentiveImFeedCard(body: BotTimeSentiveImFeedCardRequest, query?: BotTimeSentiveImFeedCardQuery): Promise<BotTimeSentiveImFeedCardResponse>
326
- /**
327
- * 更新消息流卡片按钮
328
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/chat_button/update
329
- */
330
- updateImChatButton(body: UpdateImChatButtonRequest, query?: UpdateImChatButtonQuery): Promise<UpdateImChatButtonResponse>
331
- /**
332
- * 即时提醒
333
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/patch
334
- */
335
- patchImFeedCard(feed_card_id: string, body: PatchImFeedCardRequest, query?: PatchImFeedCardQuery): Promise<PatchImFeedCardResponse>
336
- /**
337
- * 查询实体与标签的绑定关系
338
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/get
339
- */
340
- getImBizEntityTagRelation(query?: GetImBizEntityTagRelationQuery): Promise<GetImBizEntityTagRelationResponse>
341
- /**
342
- * 创建标签
343
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/create
344
- */
345
- createImTag(body: CreateImTagRequest): Promise<CreateImTagResponse>
346
- /**
347
- * 修改标签
348
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/patch
349
- */
350
- patchImTag(tag_id: string, body: PatchImTagRequest): Promise<PatchImTagResponse>
351
- /**
352
- * 绑定标签到群
353
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/create
354
- */
355
- createImBizEntityTagRelation(body: CreateImBizEntityTagRelationRequest): Promise<void>
356
- /**
357
- * 解绑标签与群
358
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/update
359
- */
360
- updateImBizEntityTagRelation(body: UpdateImBizEntityTagRelationRequest): Promise<void>
6
+ im: Im.Methods
361
7
  }
362
8
  }
363
9
 
364
- export interface CreateImMessageRequest {
365
- /** 依据receive_id_type的值,填写对应的消息接收者id */
366
- receive_id: string
367
- /** 消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
368
- msg_type: string
369
- /** 消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,具体格式说明参考:[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)<b>请求体大小限制</b>:- 文本消息请求体最大不能超过150KB- 卡片及富文本消息请求体最大不能超过30KB */
370
- content: string
371
- /** 由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
372
- uuid?: string
373
- }
374
-
375
- export interface CreateImMessageQuery {
376
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
377
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id'
378
- }
379
-
380
- export interface CreateImMessageResponse {
381
- /** 消息id open_message_id */
382
- message_id?: string
383
- /** 根消息id open_message_id */
384
- root_id?: string
385
- /** 父消息的id open_message_id */
386
- parent_id?: string
387
- /** 消息所属的话题 ID */
388
- thread_id?: string
389
- /** 消息类型 text post card image等等 */
390
- msg_type?: string
391
- /** 消息生成的时间戳(毫秒) */
392
- create_time?: string
393
- /** 消息更新的时间戳 */
394
- update_time?: string
395
- /** 消息是否被撤回 */
396
- deleted?: boolean
397
- /** 消息是否被更新 */
398
- updated?: boolean
399
- /** 所属的群 */
400
- chat_id?: string
401
- /** 发送者,可以是用户或应用 */
402
- sender?: Sender
403
- /** 消息内容,json结构 */
404
- body?: MessageBody
405
- /** 被艾特的人或应用的id */
406
- mentions?: Mention[]
407
- /** 合并消息的上一层级消息id open_message_id */
408
- upper_message_id?: string
409
- }
410
-
411
- export interface ReplyImMessageRequest {
412
- /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
413
- content: string
414
- /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
415
- msg_type: string
416
- /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
417
- reply_in_thread?: boolean
418
- /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
419
- uuid?: string
420
- }
421
-
422
- export interface ReplyImMessageResponse {
423
- /** 消息id open_message_id */
424
- message_id?: string
425
- /** 根消息id open_message_id */
426
- root_id?: string
427
- /** 父消息的id open_message_id */
428
- parent_id?: string
429
- /** 消息所属的话题 ID */
430
- thread_id?: string
431
- /** 消息类型 text post card image等等 */
432
- msg_type?: string
433
- /** 消息生成的时间戳(毫秒) */
434
- create_time?: string
435
- /** 消息更新的时间戳 */
436
- update_time?: string
437
- /** 消息是否被撤回 */
438
- deleted?: boolean
439
- /** 消息是否被更新 */
440
- updated?: boolean
441
- /** 所属的群 */
442
- chat_id?: string
443
- /** 发送者,可以是用户或应用 */
444
- sender?: Sender
445
- /** 消息内容,json结构 */
446
- body?: MessageBody
447
- /** 被艾特的人或应用的id */
448
- mentions?: Mention[]
449
- /** 合并消息的上一层级消息id open_message_id */
450
- upper_message_id?: string
451
- }
452
-
453
- export interface UpdateImMessageRequest {
454
- /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
455
- msg_type: string
456
- /** 消息内容,JSON 格式 */
457
- content: string
458
- }
459
-
460
- export interface UpdateImMessageResponse {
461
- /** 消息id open_message_id */
462
- message_id?: string
463
- /** 根消息id open_message_id */
464
- root_id?: string
465
- /** 父消息的id open_message_id */
466
- parent_id?: string
467
- /** 消息所属的话题 ID */
468
- thread_id?: string
469
- /** 消息类型 text post card image等等 */
470
- msg_type?: string
471
- /** 消息生成的时间戳(毫秒) */
472
- create_time?: string
473
- /** 消息更新的时间戳 */
474
- update_time?: string
475
- /** 消息是否被撤回 */
476
- deleted?: boolean
477
- /** 消息是否被更新 */
478
- updated?: boolean
479
- /** 所属的群 */
480
- chat_id?: string
481
- /** 发送者,可以是用户或应用 */
482
- sender?: Sender
483
- /** 消息内容,json结构 */
484
- body?: MessageBody
485
- /** 被艾特的人或应用的id */
486
- mentions?: Mention[]
487
- /** 合并消息的上一层级消息id open_message_id */
488
- upper_message_id?: string
489
- }
490
-
491
- export interface ForwardImMessageRequest {
492
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
493
- receive_id: string
494
- }
495
-
496
- export interface ForwardImMessageQuery {
497
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
498
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
499
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
500
- uuid?: string
501
- }
502
-
503
- export interface ForwardImMessageResponse {
504
- /** 消息id open_message_id */
505
- message_id?: string
506
- /** 根消息id open_message_id */
507
- root_id?: string
508
- /** 父消息的id open_message_id */
509
- parent_id?: string
510
- /** 消息所属的话题 ID */
511
- thread_id?: string
512
- /** 消息类型 text post card image等等 */
513
- msg_type?: string
514
- /** 消息生成的时间戳(毫秒) */
515
- create_time?: string
516
- /** 消息更新的时间戳 */
517
- update_time?: string
518
- /** 消息是否被撤回 */
519
- deleted?: boolean
520
- /** 消息是否被更新 */
521
- updated?: boolean
522
- /** 所属的群 */
523
- chat_id?: string
524
- /** 发送者,可以是用户或应用 */
525
- sender?: Sender
526
- /** 消息内容,json结构 */
527
- body?: MessageBody
528
- /** 被艾特的人或应用的id */
529
- mentions?: Mention[]
530
- /** 合并消息的上一层级消息id open_message_id */
531
- upper_message_id?: string
532
- }
533
-
534
- export interface MergeForwardImMessageRequest {
535
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
536
- receive_id: string
537
- /** 要转发的消息ID列表 */
538
- message_id_list: string[]
539
- }
540
-
541
- export interface MergeForwardImMessageQuery {
542
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
543
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
544
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
545
- uuid?: string
546
- }
547
-
548
- export interface MergeForwardImMessageResponse {
549
- /** 合并转发生成的新消息 */
550
- message?: Message
551
- /** 无效的消息ID列表 */
552
- invalid_message_id_list?: string[]
553
- }
554
-
555
- export interface ForwardImThreadRequest {
556
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
557
- receive_id: string
558
- }
559
-
560
- export interface ForwardImThreadQuery {
561
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
562
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
563
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
564
- uuid?: string
565
- }
566
-
567
- export interface ForwardImThreadResponse {
568
- /** 消息id open_message_id */
569
- message_id?: string
570
- /** 根消息id open_message_id */
571
- root_id?: string
572
- /** 父消息的id open_message_id */
573
- parent_id?: string
574
- /** 消息所属的话题 ID */
575
- thread_id?: string
576
- /** 消息类型 text post card image等等 */
577
- msg_type?: string
578
- /** 消息生成的时间戳(毫秒) */
579
- create_time?: string
580
- /** 消息更新的时间戳 */
581
- update_time?: string
582
- /** 消息是否被撤回 */
583
- deleted?: boolean
584
- /** 消息是否被更新 */
585
- updated?: boolean
586
- /** 所属的群 */
587
- chat_id?: string
588
- /** 发送者,可以是用户或应用 */
589
- sender?: Sender
590
- /** 消息内容,json结构 */
591
- body?: MessageBody
592
- /** 被艾特的人或应用的id */
593
- mentions?: Mention[]
594
- /** 合并消息的上一层级消息id open_message_id */
595
- upper_message_id?: string
596
- }
597
-
598
- export interface PushFollowUpImMessageRequest {
599
- /** follow up列表 */
600
- follow_ups: FollowUp[]
601
- }
602
-
603
- export interface ReadUsersImMessageQuery extends Pagination {
604
- /** 此次调用中使用的用户ID的类型 */
605
- user_id_type: 'user_id' | 'union_id' | 'open_id'
606
- }
607
-
608
- export interface ListImMessageQuery extends Pagination {
609
- /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
610
- container_id_type: string
611
- /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
612
- container_id: string
613
- /** 历史信息的起始时间(秒级时间戳) */
614
- start_time?: string
615
- /** 历史信息的结束时间(秒级时间戳) */
616
- end_time?: string
617
- /** 消息排序方式 */
618
- sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc'
619
- }
620
-
621
- export interface GetImMessageResourceQuery {
622
- /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
623
- type: string
624
- }
625
-
626
- export interface GetImMessageQuery {
627
- /** 此次调用中使用的用户ID的类型 */
628
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
629
- }
630
-
631
- export interface GetImMessageResponse {
632
- /** message[] */
633
- items?: Message[]
634
- }
635
-
636
- export interface ReadUserImBatchMessageResponse {
637
- read_user?: BatchMessageReadUser
638
- }
639
-
640
- export interface GetProgressImBatchMessageResponse {
641
- /** 消息发送进度 */
642
- batch_message_send_progress?: BatchMessageSendProgress
643
- /** 消息撤回进度 */
644
- batch_message_recall_progress?: BatchMessageRecallProgress
645
- }
646
-
647
- export interface CreateImImageForm {
648
- /** 图片类型 */
649
- image_type: 'message' | 'avatar'
650
- /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
651
- image: Blob
652
- }
653
-
654
- export interface CreateImImageResponse {
655
- /** 图片的key */
656
- image_key?: string
657
- }
658
-
659
- export interface CreateImFileForm {
660
- /** 文件类型 */
661
- file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream'
662
- /** 带后缀的文件名 */
663
- file_name: string
664
- /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
665
- duration?: number
666
- /** 文件内容 */
667
- file: Blob
668
- }
669
-
670
- export interface CreateImFileResponse {
671
- /** 文件的key */
672
- file_key?: string
673
- }
674
-
675
- export interface UrgentAppImMessageRequest {
676
- /** 该字段标识目标用户的id类型 */
677
- user_id_list: string[]
678
- }
679
-
680
- export interface UrgentAppImMessageQuery {
681
- /** 此次调用中使用的用户ID的类型 */
682
- user_id_type: 'user_id' | 'union_id' | 'open_id'
683
- }
684
-
685
- export interface UrgentAppImMessageResponse {
686
- /** 无效的用户id */
687
- invalid_user_id_list: string[]
688
- }
689
-
690
- export interface UrgentSmsImMessageRequest {
691
- /** 该字段标识目标用户的id类型 */
692
- user_id_list: string[]
693
- }
694
-
695
- export interface UrgentSmsImMessageQuery {
696
- /** 此次调用中使用的用户ID的类型 */
697
- user_id_type: 'user_id' | 'union_id' | 'open_id'
698
- }
699
-
700
- export interface UrgentSmsImMessageResponse {
701
- /** 无效的用户id */
702
- invalid_user_id_list: string[]
703
- }
704
-
705
- export interface UrgentPhoneImMessageRequest {
706
- /** 该字段标识目标用户的id类型 */
707
- user_id_list: string[]
708
- }
709
-
710
- export interface UrgentPhoneImMessageQuery {
711
- /** 此次调用中使用的用户ID的类型 */
712
- user_id_type: 'user_id' | 'union_id' | 'open_id'
713
- }
714
-
715
- export interface UrgentPhoneImMessageResponse {
716
- /** 无效的用户id */
717
- invalid_user_id_list: string[]
718
- }
719
-
720
- export interface CreateImMessageReactionRequest {
721
- /** reaction资源类型 */
722
- reaction_type: Emoji
723
- }
724
-
725
- export interface CreateImMessageReactionResponse {
726
- /** reaction资源ID */
727
- reaction_id?: string
728
- /** 添加reaction的操作人 */
729
- operator?: Operator
730
- /** reaction动作的的unix timestamp(单位:ms) */
731
- action_time?: string
732
- /** reaction资源类型 */
733
- reaction_type?: Emoji
734
- }
735
-
736
- export interface ListImMessageReactionQuery extends Pagination {
737
- /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
738
- reaction_type?: string
739
- /** 当操作人为用户时返回用户ID的类型 */
740
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
741
- }
742
-
743
- export interface DeleteImMessageReactionResponse {
744
- /** reaction资源ID */
745
- reaction_id?: string
746
- /** 添加reaction的操作人 */
747
- operator?: Operator
748
- /** reaction动作的的unix timestamp(单位:ms) */
749
- action_time?: string
750
- /** reaction资源类型 */
751
- reaction_type?: Emoji
752
- }
753
-
754
- export interface CreateImPinRequest {
755
- /** 待Pin的消息ID */
756
- message_id: string
757
- }
758
-
759
- export interface CreateImPinResponse {
760
- pin?: Pin
761
- }
762
-
763
- export interface ListImPinQuery extends Pagination {
764
- /** 待获取Pin消息的Chat ID */
765
- chat_id: string
766
- /** Pin信息的起始时间(毫秒级时间戳) */
767
- start_time?: string
768
- /** Pin信息的结束时间(毫秒级时间戳) */
769
- end_time?: string
770
- }
771
-
772
- export interface PatchImMessageRequest {
773
- /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
774
- content: string
775
- }
776
-
777
- export interface BatchUpdateImUrlPreviewRequest {
778
- /** URL预览的token列表 */
779
- preview_tokens: string[]
780
- /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
781
- open_ids?: string[]
782
- }
783
-
784
- export interface CreateImChatRequest {
785
- /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
786
- avatar?: string
787
- /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
788
- name?: string
789
- /** 群描述 */
790
- description?: string
791
- /** 群国际化名称 */
792
- i18n_names?: I18nNames
793
- /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
794
- owner_id?: string
795
- /** 创建群时邀请的群成员,id 类型为 user_id_type */
796
- user_id_list?: string[]
797
- /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
798
- bot_id_list?: string[]
799
- /** 群消息模式 */
800
- group_message_type?: 'chat' | 'thread'
801
- /** 群模式**可选值有**:- `group`:群组 */
802
- chat_mode?: string
803
- /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
804
- chat_type?: string
805
- /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
806
- join_message_visibility?: string
807
- /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
808
- leave_message_visibility?: string
809
- /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
810
- membership_approval?: string
811
- /** 防泄密模式设置 */
812
- restricted_mode_setting?: RestrictedModeSetting
813
- /** 谁可以加急 */
814
- urgent_setting?: 'only_owner' | 'all_members'
815
- /** 谁可以发起视频会议 */
816
- video_conference_setting?: 'only_owner' | 'all_members'
817
- /** 谁可以编辑群信息 */
818
- edit_permission?: 'only_owner' | 'all_members'
819
- /** 隐藏群成员人数设置 */
820
- hide_member_count_setting?: 'all_members' | 'only_owner'
821
- }
822
-
823
- export interface CreateImChatQuery {
824
- /** 此次调用中使用的用户ID的类型 */
825
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
826
- /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
827
- set_bot_manager?: boolean
828
- /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
829
- uuid?: string
830
- }
831
-
832
- export interface CreateImChatResponse {
833
- /** 群ID */
834
- chat_id?: string
835
- /** 群头像URL */
836
- avatar?: string
837
- /** 群名称 */
838
- name?: string
839
- /** 群描述 */
840
- description?: string
841
- /** 群国际化名称 */
842
- i18n_names?: I18nNames
843
- /** 群主 ID */
844
- owner_id?: string
845
- /** 群主 ID 类型 */
846
- owner_id_type?: string
847
- /** 谁可以加急 */
848
- urgent_setting?: 'only_owner' | 'all_members'
849
- /** 谁可以发起视频会议 */
850
- video_conference_setting?: 'only_owner' | 'all_members'
851
- /** 加user/bot入群权限(all_members/only_owner) */
852
- add_member_permission?: string
853
- /** 群分享权限(allowed/not_allowed) */
854
- share_card_permission?: string
855
- /** at所有人权限(all_members/only_owner) */
856
- at_all_permission?: string
857
- /** 群编辑权限(all_members/only_owner) */
858
- edit_permission?: string
859
- /** 群消息模式 */
860
- group_message_type?: string
861
- /** 群模式 */
862
- chat_mode?: string
863
- /** 群类型 */
864
- chat_type?: string
865
- /** 优先级最高的一个群tag */
866
- chat_tag?: string
867
- /** 是否是外部群 */
868
- external?: boolean
869
- /** tenant key */
870
- tenant_key?: string
871
- /** 入群消息可见性 */
872
- join_message_visibility?: string
873
- /** 出群消息可见性 */
874
- leave_message_visibility?: string
875
- /** 加群审批 */
876
- membership_approval?: string
877
- /** 发言权限 */
878
- moderation_permission?: string
879
- /** 防泄密模式设置 */
880
- restricted_mode_setting?: RestrictedModeSetting
881
- /** 隐藏群成员人数设置 */
882
- hide_member_count_setting?: 'all_members' | 'only_owner'
883
- }
884
-
885
- export interface UpdateImChatRequest {
886
- /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
887
- avatar?: string
888
- /** 群名称 */
889
- name?: string
890
- /** 群描述 */
891
- description?: string
892
- /** 群国际化名称 */
893
- i18n_names?: I18nNames
894
- /** 加 user/bot 入群权限(all_members/only_owner) */
895
- add_member_permission?: string
896
- /** 群分享权限(allowed/not_allowed) */
897
- share_card_permission?: string
898
- /** at 所有人权限(all_members/only_owner) */
899
- at_all_permission?: string
900
- /** 群编辑权限(all_members/only_owner) */
901
- edit_permission?: string
902
- /** 新群主 ID */
903
- owner_id?: string
904
- /** 入群消息可见性(only_owner/all_members/not_anyone) */
905
- join_message_visibility?: string
906
- /** 出群消息可见性(only_owner/all_members/not_anyone) */
907
- leave_message_visibility?: string
908
- /** 加群审批(no_approval_required/approval_required) */
909
- membership_approval?: string
910
- /** 防泄密模式设置 */
911
- restricted_mode_setting?: RestrictedModeSetting
912
- /** 群类型 */
913
- chat_type?: string
914
- /** 群消息模式 */
915
- group_message_type?: 'chat' | 'thread'
916
- /** 谁可以加急 */
917
- urgent_setting?: 'only_owner' | 'all_members'
918
- /** 谁可以发起视频会议 */
919
- video_conference_setting?: 'only_owner' | 'all_members'
920
- /** 隐藏群成员人数设置 */
921
- hide_member_count_setting?: 'all_members' | 'only_owner'
922
- }
923
-
924
- export interface UpdateImChatQuery {
925
- /** 此次调用中使用的用户ID的类型 */
926
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
927
- }
928
-
929
- export interface UpdateImChatModerationRequest {
930
- /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
931
- moderation_setting?: string
932
- /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
933
- moderator_added_list?: string[]
934
- /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
935
- moderator_removed_list?: string[]
936
- }
937
-
938
- export interface UpdateImChatModerationQuery {
939
- /** 此次调用中使用的用户ID的类型 */
940
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
941
- }
942
-
943
- export interface GetImChatQuery {
944
- /** 此次调用中使用的用户ID的类型 */
945
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
946
- }
947
-
948
- export interface GetImChatResponse {
949
- /** 群头像URL */
950
- avatar?: string
951
- /** 群名称 */
952
- name?: string
953
- /** 群描述 */
954
- description?: string
955
- /** 群国际化名称 */
956
- i18n_names?: I18nNames
957
- /** 加user/bot入群权限(all_members/only_owner) */
958
- add_member_permission?: string
959
- /** 群分享权限(allowed/not_allowed) */
960
- share_card_permission?: string
961
- /** at所有人权限(all_members/only_owner) */
962
- at_all_permission?: string
963
- /** 群编辑权限(all_members/only_owner) */
964
- edit_permission?: string
965
- /** 群主ID的类型(open_id/user_id/union_id) */
966
- owner_id_type?: string
967
- /** 群主ID */
968
- owner_id?: string
969
- /** 用户管理员列表 */
970
- user_manager_id_list?: string[]
971
- /** 机器人管理员列表 */
972
- bot_manager_id_list?: string[]
973
- /** 群消息模式 */
974
- group_message_type?: string
975
- /** 群模式 */
976
- chat_mode?: string
977
- /** 群类型 */
978
- chat_type?: string
979
- /** 优先级最高的一个群tag */
980
- chat_tag?: string
981
- /** 入群消息可见性 */
982
- join_message_visibility?: string
983
- /** 出群消息可见性 */
984
- leave_message_visibility?: string
985
- /** 加群审批 */
986
- membership_approval?: string
987
- /** 发言权限 */
988
- moderation_permission?: string
989
- /** 是否是外部群 */
990
- external?: boolean
991
- /** tenant key */
992
- tenant_key?: string
993
- /** 群成员人数 */
994
- user_count?: string
995
- /** 群机器人数 */
996
- bot_count?: string
997
- /** 防泄密模式设置 */
998
- restricted_mode_setting?: RestrictedModeSetting
999
- /** 谁可以加急 */
1000
- urgent_setting?: 'only_owner' | 'all_members'
1001
- /** 谁可以发起视频会议 */
1002
- video_conference_setting?: 'only_owner' | 'all_members'
1003
- /** 隐藏群成员人数设置 */
1004
- hide_member_count_setting?: 'all_members' | 'only_owner'
1005
- /** 群状态 */
1006
- chat_status?: 'normal' | 'dissolved' | 'dissolved_save'
1007
- }
1008
-
1009
- export interface PutTopNoticeImChatTopNoticeRequest {
1010
- /** 要进行发布的群置顶 */
1011
- chat_top_notice: ChatTopNotice[]
1012
- }
1013
-
1014
- export interface ListImChatQuery extends Pagination {
1015
- /** 此次调用中使用的用户ID的类型 */
1016
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1017
- /** 群组排序方式 */
1018
- sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc'
1019
- }
1020
-
1021
- export interface SearchImChatQuery extends Pagination {
1022
- /** 此次调用中使用的用户ID的类型 */
1023
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1024
- /** 关键词。注意:如果query为空值将返回空的结果 */
1025
- query?: string
1026
- }
1027
-
1028
- export interface GetImChatModerationQuery extends Pagination {
1029
- /** 此次调用中使用的用户ID的类型 */
1030
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1031
- }
1032
-
1033
- export interface GetImChatModerationResponse {
1034
- /** 群发言模式 */
1035
- moderation_setting?: string
1036
- /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
1037
- page_token?: string
1038
- /** 是否还有更多项 */
1039
- has_more?: boolean
1040
- /** 可发言用户列表 */
1041
- items?: ListModerator[]
1042
- }
1043
-
1044
- export interface LinkImChatRequest {
1045
- /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
1046
- validity_period?: 'week' | 'year' | 'permanently'
1047
- }
1048
-
1049
- export interface LinkImChatResponse {
1050
- /** 群分享链接 */
1051
- share_link?: string
1052
- /** 分享链接过期时间戳(秒级) */
1053
- expire_time?: string
1054
- /** 分享链接是否永久有效 */
1055
- is_permanent?: boolean
1056
- }
1057
-
1058
- export interface AddManagersImChatManagersRequest {
1059
- /** 要增加的 manager_id */
1060
- manager_ids?: string[]
1061
- }
1062
-
1063
- export interface AddManagersImChatManagersQuery {
1064
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1065
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1066
- }
1067
-
1068
- export interface AddManagersImChatManagersResponse {
1069
- /** 群目前的管理员id */
1070
- chat_managers?: string[]
1071
- /** 群目前的管理员bot id */
1072
- chat_bot_managers?: string[]
1073
- }
1074
-
1075
- export interface DeleteManagersImChatManagersRequest {
1076
- /** 要删除的 manager_id */
1077
- manager_ids?: string[]
1078
- }
1079
-
1080
- export interface DeleteManagersImChatManagersQuery {
1081
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1082
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1083
- }
1084
-
1085
- export interface DeleteManagersImChatManagersResponse {
1086
- /** 群目前的管理员id */
1087
- chat_managers?: string[]
1088
- /** 群目前的管理员bot id */
1089
- chat_bot_managers?: string[]
1090
- }
1091
-
1092
- export interface CreateImChatMembersRequest {
1093
- /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
1094
- id_list?: string[]
1095
- }
1096
-
1097
- export interface CreateImChatMembersQuery {
1098
- /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
1099
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1100
- /** 出现不可用ID后的处理方式 0/1/2 */
1101
- succeed_type?: 0 | 1 | 2
1102
- }
1103
-
1104
- export interface CreateImChatMembersResponse {
1105
- /** ID无效的成员列表 */
1106
- invalid_id_list?: string[]
1107
- /** ID不存在的成员列表 */
1108
- not_existed_id_list?: string[]
1109
- /** 等待群主或管理员审批的成员ID列表 */
1110
- pending_approval_id_list?: string[]
1111
- }
1112
-
1113
- export interface DeleteImChatMembersRequest {
1114
- /** 成员列表 */
1115
- id_list?: string[]
1116
- }
1117
-
1118
- export interface DeleteImChatMembersQuery {
1119
- /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
1120
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1121
- }
1122
-
1123
- export interface DeleteImChatMembersResponse {
1124
- /** 无效成员列表 */
1125
- invalid_id_list?: string[]
1126
- }
1127
-
1128
- export interface GetImChatMembersQuery extends Pagination {
1129
- /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
1130
- member_id_type?: 'user_id' | 'union_id' | 'open_id'
1131
- }
1132
-
1133
- export interface GetImChatMembersResponse {
1134
- /** member列表 */
1135
- items?: ListMember[]
1136
- /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
1137
- page_token?: string
1138
- /** 是否还有更多项 */
1139
- has_more?: boolean
1140
- /** 成员总数 */
1141
- member_total?: number
1142
- }
1143
-
1144
- export interface IsInChatImChatMembersResponse {
1145
- /** 用户或者机器人是否在群中 */
1146
- is_in_chat?: boolean
1147
- }
1148
-
1149
- export interface PatchImChatAnnouncementRequest {
1150
- /** 文档当前版本号 int64 类型,get 接口会返回 */
1151
- revision: string
1152
- /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
1153
- requests?: string[]
1154
- }
1155
-
1156
- export interface GetImChatAnnouncementQuery {
1157
- /** 此次调用中使用的用户ID的类型 */
1158
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1159
- }
1160
-
1161
- export interface GetImChatAnnouncementResponse {
1162
- /** CCM 文档序列化信息 */
1163
- content?: string
1164
- /** 文档当前版本号 纯数字 */
1165
- revision?: string
1166
- /** 文档生成的时间戳(秒) */
1167
- create_time?: string
1168
- /** 消息更新的时间戳(秒) */
1169
- update_time?: string
1170
- /** 文档所有者id类型, open_id/user_id/union_id/app_id */
1171
- owner_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1172
- /** 文档所有者id */
1173
- owner_id?: string
1174
- /** 文档最新修改者id类型, open_id/user_id/union_id/app_id */
1175
- modifier_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1176
- /** 文档最新修改者id */
1177
- modifier_id?: string
1178
- }
1179
-
1180
- export interface CreateImChatTabRequest {
1181
- /** 会话标签页 */
1182
- chat_tabs: ChatTab[]
1183
- }
1184
-
1185
- export interface CreateImChatTabResponse {
1186
- /** 群标签列表 */
1187
- chat_tabs?: ChatTab[]
1188
- }
1189
-
1190
- export interface DeleteTabsImChatTabRequest {
1191
- /** 会话标签页id列表 */
1192
- tab_ids: string[]
1193
- }
1194
-
1195
- export interface DeleteTabsImChatTabResponse {
1196
- /** 群标签列表 */
1197
- chat_tabs?: ChatTab[]
1198
- }
1199
-
1200
- export interface UpdateTabsImChatTabRequest {
1201
- /** 会话标签页 */
1202
- chat_tabs?: ChatTab[]
1203
- }
1204
-
1205
- export interface UpdateTabsImChatTabResponse {
1206
- /** 群标签列表 */
1207
- chat_tabs?: ChatTab[]
1208
- }
1209
-
1210
- export interface SortTabsImChatTabRequest {
1211
- /** 会话标签页ID列表 */
1212
- tab_ids?: string[]
1213
- }
1214
-
1215
- export interface SortTabsImChatTabResponse {
1216
- /** 群标签列表 */
1217
- chat_tabs?: ChatTab[]
1218
- }
1219
-
1220
- export interface ListTabsImChatTabResponse {
1221
- /** 会话标签页 */
1222
- chat_tabs?: ChatTab[]
1223
- }
1224
-
1225
- export interface CreateImChatMenuTreeRequest {
1226
- /** 要向群内追加的菜单 */
1227
- menu_tree: ChatMenuTree
1228
- }
1229
-
1230
- export interface CreateImChatMenuTreeResponse {
1231
- /** 追加后群内现有菜单 */
1232
- menu_tree?: ChatMenuTree
1233
- }
1234
-
1235
- export interface DeleteImChatMenuTreeRequest {
1236
- /** 要删除的一级菜单ID列表 */
1237
- chat_menu_top_level_ids: string[]
1238
- }
1239
-
1240
- export interface DeleteImChatMenuTreeResponse {
1241
- /** 群内现有菜单 */
1242
- menu_tree?: ChatMenuTree
1243
- }
1244
-
1245
- export interface PatchImChatMenuItemRequest {
1246
- /** 修改的字段 */
1247
- update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[]
1248
- /** 元信息 */
1249
- chat_menu_item: ChatMenuItem
1250
- }
1251
-
1252
- export interface PatchImChatMenuItemResponse {
1253
- chat_menu_item?: ChatMenuItem
1254
- }
1255
-
1256
- export interface SortImChatMenuTreeRequest {
1257
- /** 一级菜单id列表 */
1258
- chat_menu_top_level_ids: string[]
1259
- }
1260
-
1261
- export interface SortImChatMenuTreeResponse {
1262
- /** 排序后群内菜单 */
1263
- menu_tree?: ChatMenuTree
1264
- }
1265
-
1266
- export interface GetImChatMenuTreeResponse {
1267
- /** 群内所有菜单 */
1268
- menu_tree?: ChatMenuTree
1269
- }
1270
-
1271
- export interface CreateImAppFeedCardRequest {
1272
- /** 应用消息卡片 */
1273
- app_feed_card?: OpenAppFeedCard
1274
- /** 用户 ID */
1275
- user_ids?: string[]
1276
- }
1277
-
1278
- export interface CreateImAppFeedCardQuery {
1279
- /** 用户 ID 类型 */
1280
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1281
- }
1282
-
1283
- export interface CreateImAppFeedCardResponse {
1284
- /** 失败的卡片 */
1285
- failed_cards?: OpenFailedUserAppFeedCardItem[]
1286
- /** 卡片业务 ID */
1287
- biz_id?: string
1288
- }
1289
-
1290
- export interface UpdateImAppFeedCardBatchRequest {
1291
- /** 应用消息卡片 */
1292
- feed_cards?: UserOpenAppFeedCardUpdater[]
1293
- }
1294
-
1295
- export interface UpdateImAppFeedCardBatchQuery {
1296
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1297
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
1298
- }
1299
-
1300
- export interface UpdateImAppFeedCardBatchResponse {
1301
- /** 失败的卡片 */
1302
- failed_cards?: OpenFailedUserAppFeedCardItem[]
1303
- }
1304
-
1305
- export interface DeleteImAppFeedCardBatchRequest {
1306
- /** 应用消息卡片 */
1307
- feed_cards?: UserOpenAppFeedCardDeleter[]
1308
- }
1309
-
1310
- export interface DeleteImAppFeedCardBatchQuery {
1311
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1312
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
1313
- }
1314
-
1315
- export interface DeleteImAppFeedCardBatchResponse {
1316
- /** 失败的卡片 */
1317
- failed_cards?: OpenFailedUserAppFeedCardItem[]
1318
- }
1319
-
1320
- export interface BotTimeSentiveImFeedCardRequest {
1321
- /** 临时置顶状态,true-打开,false-关闭 */
1322
- time_sensitive: boolean
1323
- /** 用户id 列表 */
1324
- user_ids: string[]
1325
- }
1326
-
1327
- export interface BotTimeSentiveImFeedCardQuery {
1328
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1329
- user_id_type: 'open_id' | 'user_id' | 'union_id'
1330
- }
1331
-
1332
- export interface BotTimeSentiveImFeedCardResponse {
1333
- /** 失败原因 */
1334
- failed_user_reasons?: FailedReason[]
1335
- }
1336
-
1337
- export interface UpdateImChatButtonRequest {
1338
- /** 用户 ID 列表 */
1339
- user_ids?: string[]
1340
- /** 群 ID */
1341
- chat_id: string
1342
- /** 按钮 */
1343
- buttons?: OpenAppFeedCardButtons
1344
- }
10
+ export namespace Im {
11
+ export interface Methods {
12
+ message: Message.Methods
13
+ thread: Thread.Methods
14
+ batchMessage: BatchMessage.Methods
15
+ image: Image.Methods
16
+ file: File.Methods
17
+ pin: Pin.Methods
18
+ urlPreview: UrlPreview.Methods
19
+ chat: Chat.Methods
20
+ appFeedCard: AppFeedCard.Methods
21
+ feedCard: FeedCard.Methods
22
+ chatButton: ChatButton.Methods
23
+ bizEntityTagRelation: BizEntityTagRelation.Methods
24
+ tag: Tag.Methods
25
+ }
1345
26
 
1346
- export interface UpdateImChatButtonQuery {
1347
- /** 用户 ID 类型 */
1348
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1349
- }
27
+ export namespace Message {
28
+ export interface Methods {
29
+ resource: Resource.Methods
30
+ reaction: Reaction.Methods
31
+ /**
32
+ * 发送消息
33
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create
34
+ */
35
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
36
+ /**
37
+ * 回复消息
38
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply
39
+ */
40
+ reply(message_id: string, body: ReplyRequest): Promise<ReplyResponse>
41
+ /**
42
+ * 编辑消息
43
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update
44
+ */
45
+ update(message_id: string, body: UpdateRequest): Promise<UpdateResponse>
46
+ /**
47
+ * 转发消息
48
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward
49
+ */
50
+ forward(message_id: string, body: ForwardRequest, query?: ForwardQuery): Promise<ForwardResponse>
51
+ /**
52
+ * 合并转发消息
53
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward
54
+ */
55
+ mergeForward(body: MergeForwardRequest, query?: MergeForwardQuery): Promise<MergeForwardResponse>
56
+ /**
57
+ * 撤回消息
58
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete
59
+ */
60
+ delete(message_id: string): Promise<void>
61
+ /**
62
+ * 添加跟随气泡
63
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/push_follow_up
64
+ */
65
+ pushFollowUp(message_id: string, body: PushFollowUpRequest): Promise<void>
66
+ /**
67
+ * 查询消息已读信息
68
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users
69
+ */
70
+ readUsers(message_id: string, query?: ReadUsersQuery): Paginated<Lark.ReadUser>
71
+ /**
72
+ * 获取会话历史消息
73
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list
74
+ */
75
+ list(query?: ListQuery): Paginated<Lark.Message>
76
+ /**
77
+ * 获取指定消息的内容
78
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get
79
+ */
80
+ get(message_id: string, query?: GetQuery): Promise<GetResponse>
81
+ /**
82
+ * 发送应用内加急
83
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_app
84
+ */
85
+ urgentApp(message_id: string, body: UrgentAppRequest, query?: UrgentAppQuery): Promise<UrgentAppResponse>
86
+ /**
87
+ * 发送短信加急
88
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_sms
89
+ */
90
+ urgentSms(message_id: string, body: UrgentSmsRequest, query?: UrgentSmsQuery): Promise<UrgentSmsResponse>
91
+ /**
92
+ * 发送电话加急
93
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_phone
94
+ */
95
+ urgentPhone(message_id: string, body: UrgentPhoneRequest, query?: UrgentPhoneQuery): Promise<UrgentPhoneResponse>
96
+ /**
97
+ * 更新应用发送的消息卡片
98
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch
99
+ */
100
+ patch(message_id: string, body: PatchRequest): Promise<void>
101
+ }
102
+
103
+ export interface CreateRequest {
104
+ /** 依据receive_id_type的值,填写对应的消息接收者id */
105
+ receive_id: string
106
+ /** 消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
107
+ msg_type: string
108
+ /** 消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,具体格式说明参考:[发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json)<b>请求体大小限制</b>:- 文本消息请求体最大不能超过150KB- 卡片及富文本消息请求体最大不能超过30KB */
109
+ content: string
110
+ /** 由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
111
+ uuid?: string
112
+ }
113
+
114
+ export interface CreateQuery {
115
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
116
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id'
117
+ }
118
+
119
+ export interface CreateResponse {
120
+ /** 消息id open_message_id */
121
+ message_id?: string
122
+ /** 根消息id open_message_id */
123
+ root_id?: string
124
+ /** 父消息的id open_message_id */
125
+ parent_id?: string
126
+ /** 消息所属的话题 ID */
127
+ thread_id?: string
128
+ /** 消息类型 text post card image等等 */
129
+ msg_type?: string
130
+ /** 消息生成的时间戳(毫秒) */
131
+ create_time?: string
132
+ /** 消息更新的时间戳 */
133
+ update_time?: string
134
+ /** 消息是否被撤回 */
135
+ deleted?: boolean
136
+ /** 消息是否被更新 */
137
+ updated?: boolean
138
+ /** 所属的群 */
139
+ chat_id?: string
140
+ /** 发送者,可以是用户或应用 */
141
+ sender?: Lark.Sender
142
+ /** 消息内容,json结构 */
143
+ body?: Lark.MessageBody
144
+ /** 被艾特的人或应用的id */
145
+ mentions?: Lark.Mention[]
146
+ /** 合并消息的上一层级消息id open_message_id */
147
+ upper_message_id?: string
148
+ }
149
+
150
+ export interface ReplyRequest {
151
+ /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
152
+ content: string
153
+ /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
154
+ msg_type: string
155
+ /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
156
+ reply_in_thread?: boolean
157
+ /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
158
+ uuid?: string
159
+ }
160
+
161
+ export interface ReplyResponse {
162
+ /** 消息id open_message_id */
163
+ message_id?: string
164
+ /** 根消息id open_message_id */
165
+ root_id?: string
166
+ /** 父消息的id open_message_id */
167
+ parent_id?: string
168
+ /** 消息所属的话题 ID */
169
+ thread_id?: string
170
+ /** 消息类型 text post card image等等 */
171
+ msg_type?: string
172
+ /** 消息生成的时间戳(毫秒) */
173
+ create_time?: string
174
+ /** 消息更新的时间戳 */
175
+ update_time?: string
176
+ /** 消息是否被撤回 */
177
+ deleted?: boolean
178
+ /** 消息是否被更新 */
179
+ updated?: boolean
180
+ /** 所属的群 */
181
+ chat_id?: string
182
+ /** 发送者,可以是用户或应用 */
183
+ sender?: Lark.Sender
184
+ /** 消息内容,json结构 */
185
+ body?: Lark.MessageBody
186
+ /** 被艾特的人或应用的id */
187
+ mentions?: Lark.Mention[]
188
+ /** 合并消息的上一层级消息id open_message_id */
189
+ upper_message_id?: string
190
+ }
191
+
192
+ export interface UpdateRequest {
193
+ /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
194
+ msg_type: string
195
+ /** 消息内容,JSON 格式 */
196
+ content: string
197
+ }
198
+
199
+ export interface UpdateResponse {
200
+ /** 消息id open_message_id */
201
+ message_id?: string
202
+ /** 根消息id open_message_id */
203
+ root_id?: string
204
+ /** 父消息的id open_message_id */
205
+ parent_id?: string
206
+ /** 消息所属的话题 ID */
207
+ thread_id?: string
208
+ /** 消息类型 text post card image等等 */
209
+ msg_type?: string
210
+ /** 消息生成的时间戳(毫秒) */
211
+ create_time?: string
212
+ /** 消息更新的时间戳 */
213
+ update_time?: string
214
+ /** 消息是否被撤回 */
215
+ deleted?: boolean
216
+ /** 消息是否被更新 */
217
+ updated?: boolean
218
+ /** 所属的群 */
219
+ chat_id?: string
220
+ /** 发送者,可以是用户或应用 */
221
+ sender?: Lark.Sender
222
+ /** 消息内容,json结构 */
223
+ body?: Lark.MessageBody
224
+ /** 被艾特的人或应用的id */
225
+ mentions?: Lark.Mention[]
226
+ /** 合并消息的上一层级消息id open_message_id */
227
+ upper_message_id?: string
228
+ }
229
+
230
+ export interface ForwardRequest {
231
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
232
+ receive_id: string
233
+ }
234
+
235
+ export interface ForwardQuery {
236
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
237
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
238
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
239
+ uuid?: string
240
+ }
241
+
242
+ export interface ForwardResponse {
243
+ /** 消息id open_message_id */
244
+ message_id?: string
245
+ /** 根消息id open_message_id */
246
+ root_id?: string
247
+ /** 父消息的id open_message_id */
248
+ parent_id?: string
249
+ /** 消息所属的话题 ID */
250
+ thread_id?: string
251
+ /** 消息类型 text post card image等等 */
252
+ msg_type?: string
253
+ /** 消息生成的时间戳(毫秒) */
254
+ create_time?: string
255
+ /** 消息更新的时间戳 */
256
+ update_time?: string
257
+ /** 消息是否被撤回 */
258
+ deleted?: boolean
259
+ /** 消息是否被更新 */
260
+ updated?: boolean
261
+ /** 所属的群 */
262
+ chat_id?: string
263
+ /** 发送者,可以是用户或应用 */
264
+ sender?: Lark.Sender
265
+ /** 消息内容,json结构 */
266
+ body?: Lark.MessageBody
267
+ /** 被艾特的人或应用的id */
268
+ mentions?: Lark.Mention[]
269
+ /** 合并消息的上一层级消息id open_message_id */
270
+ upper_message_id?: string
271
+ }
272
+
273
+ export interface MergeForwardRequest {
274
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
275
+ receive_id: string
276
+ /** 要转发的消息ID列表 */
277
+ message_id_list: string[]
278
+ }
279
+
280
+ export interface MergeForwardQuery {
281
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
282
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
283
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
284
+ uuid?: string
285
+ }
286
+
287
+ export interface MergeForwardResponse {
288
+ /** 合并转发生成的新消息 */
289
+ message?: Lark.Message
290
+ /** 无效的消息ID列表 */
291
+ invalid_message_id_list?: string[]
292
+ }
293
+
294
+ export interface PushFollowUpRequest {
295
+ /** follow up列表 */
296
+ follow_ups: Lark.FollowUp[]
297
+ }
298
+
299
+ export interface ReadUsersQuery extends Pagination {
300
+ /** 此次调用中使用的用户ID的类型 */
301
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
302
+ }
303
+
304
+ export interface ListQuery extends Pagination {
305
+ /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
306
+ container_id_type: string
307
+ /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
308
+ container_id: string
309
+ /** 历史信息的起始时间(秒级时间戳) */
310
+ start_time?: string
311
+ /** 历史信息的结束时间(秒级时间戳) */
312
+ end_time?: string
313
+ /** 消息排序方式 */
314
+ sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc'
315
+ }
316
+
317
+ export interface GetQuery {
318
+ /** 此次调用中使用的用户ID的类型 */
319
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
320
+ }
321
+
322
+ export interface GetResponse {
323
+ /** message[] */
324
+ items?: Lark.Message[]
325
+ }
326
+
327
+ export interface UrgentAppRequest {
328
+ /** 该字段标识目标用户的id类型 */
329
+ user_id_list: string[]
330
+ }
331
+
332
+ export interface UrgentAppQuery {
333
+ /** 此次调用中使用的用户ID的类型 */
334
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
335
+ }
336
+
337
+ export interface UrgentAppResponse {
338
+ /** 无效的用户id */
339
+ invalid_user_id_list: string[]
340
+ }
341
+
342
+ export interface UrgentSmsRequest {
343
+ /** 该字段标识目标用户的id类型 */
344
+ user_id_list: string[]
345
+ }
346
+
347
+ export interface UrgentSmsQuery {
348
+ /** 此次调用中使用的用户ID的类型 */
349
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
350
+ }
351
+
352
+ export interface UrgentSmsResponse {
353
+ /** 无效的用户id */
354
+ invalid_user_id_list: string[]
355
+ }
356
+
357
+ export interface UrgentPhoneRequest {
358
+ /** 该字段标识目标用户的id类型 */
359
+ user_id_list: string[]
360
+ }
361
+
362
+ export interface UrgentPhoneQuery {
363
+ /** 此次调用中使用的用户ID的类型 */
364
+ user_id_type: 'user_id' | 'union_id' | 'open_id'
365
+ }
366
+
367
+ export interface UrgentPhoneResponse {
368
+ /** 无效的用户id */
369
+ invalid_user_id_list: string[]
370
+ }
371
+
372
+ export interface PatchRequest {
373
+ /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
374
+ content: string
375
+ }
376
+
377
+ export namespace Resource {
378
+ export interface Methods {
379
+ /**
380
+ * 获取消息中的资源文件
381
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get
382
+ */
383
+ get(message_id: string, file_key: string, query?: GetQuery): Promise<ArrayBuffer>
384
+ }
385
+
386
+ export interface GetQuery {
387
+ /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
388
+ type: string
389
+ }
390
+ }
391
+
392
+ export namespace Reaction {
393
+ export interface Methods {
394
+ /**
395
+ * 添加消息表情回复
396
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create
397
+ */
398
+ create(message_id: string, body: CreateRequest): Promise<CreateResponse>
399
+ /**
400
+ * 获取消息表情回复
401
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list
402
+ */
403
+ list(message_id: string, query?: ListQuery): Paginated<Lark.MessageReaction>
404
+ /**
405
+ * 删除消息表情回复
406
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete
407
+ */
408
+ delete(message_id: string, reaction_id: string): Promise<DeleteResponse>
409
+ }
410
+
411
+ export interface CreateRequest {
412
+ /** reaction资源类型 */
413
+ reaction_type: Lark.Emoji
414
+ }
415
+
416
+ export interface CreateResponse {
417
+ /** reaction资源ID */
418
+ reaction_id?: string
419
+ /** 添加reaction的操作人 */
420
+ operator?: Lark.Operator
421
+ /** reaction动作的的unix timestamp(单位:ms) */
422
+ action_time?: string
423
+ /** reaction资源类型 */
424
+ reaction_type?: Lark.Emoji
425
+ }
426
+
427
+ export interface ListQuery extends Pagination {
428
+ /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
429
+ reaction_type?: string
430
+ /** 当操作人为用户时返回用户ID的类型 */
431
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
432
+ }
433
+
434
+ export interface DeleteResponse {
435
+ /** reaction资源ID */
436
+ reaction_id?: string
437
+ /** 添加reaction的操作人 */
438
+ operator?: Lark.Operator
439
+ /** reaction动作的的unix timestamp(单位:ms) */
440
+ action_time?: string
441
+ /** reaction资源类型 */
442
+ reaction_type?: Lark.Emoji
443
+ }
444
+ }
445
+ }
1350
446
 
1351
- export interface UpdateImChatButtonResponse {
1352
- /** 失败的用户 */
1353
- failed_user_reasons?: FailedReason[]
1354
- }
447
+ export namespace Thread {
448
+ export interface Methods {
449
+ /**
450
+ * 转发话题
451
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/thread/forward
452
+ */
453
+ forward(thread_id: string, body: ForwardRequest, query?: ForwardQuery): Promise<ForwardResponse>
454
+ }
455
+
456
+ export interface ForwardRequest {
457
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
458
+ receive_id: string
459
+ }
460
+
461
+ export interface ForwardQuery {
462
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
463
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id'
464
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
465
+ uuid?: string
466
+ }
467
+
468
+ export interface ForwardResponse {
469
+ /** 消息id open_message_id */
470
+ message_id?: string
471
+ /** 根消息id open_message_id */
472
+ root_id?: string
473
+ /** 父消息的id open_message_id */
474
+ parent_id?: string
475
+ /** 消息所属的话题 ID */
476
+ thread_id?: string
477
+ /** 消息类型 text post card image等等 */
478
+ msg_type?: string
479
+ /** 消息生成的时间戳(毫秒) */
480
+ create_time?: string
481
+ /** 消息更新的时间戳 */
482
+ update_time?: string
483
+ /** 消息是否被撤回 */
484
+ deleted?: boolean
485
+ /** 消息是否被更新 */
486
+ updated?: boolean
487
+ /** 所属的群 */
488
+ chat_id?: string
489
+ /** 发送者,可以是用户或应用 */
490
+ sender?: Lark.Sender
491
+ /** 消息内容,json结构 */
492
+ body?: Lark.MessageBody
493
+ /** 被艾特的人或应用的id */
494
+ mentions?: Lark.Mention[]
495
+ /** 合并消息的上一层级消息id open_message_id */
496
+ upper_message_id?: string
497
+ }
498
+ }
1355
499
 
1356
- export interface PatchImFeedCardRequest {
1357
- /** 临时置顶状态,true-打开,false-关闭 */
1358
- time_sensitive: boolean
1359
- /** 用户id 列表 */
1360
- user_ids: string[]
1361
- }
500
+ export namespace BatchMessage {
501
+ export interface Methods {
502
+ /**
503
+ * 批量撤回消息
504
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete
505
+ */
506
+ delete(batch_message_id: string): Promise<void>
507
+ /**
508
+ * 查询批量消息推送和阅读人数
509
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user
510
+ */
511
+ readUser(batch_message_id: string): Promise<ReadUserResponse>
512
+ /**
513
+ * 查询批量消息整体进度
514
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/get_progress
515
+ */
516
+ getProgress(batch_message_id: string): Promise<GetProgressResponse>
517
+ }
518
+
519
+ export interface ReadUserResponse {
520
+ read_user?: Lark.BatchMessageReadUser
521
+ }
522
+
523
+ export interface GetProgressResponse {
524
+ /** 消息发送进度 */
525
+ batch_message_send_progress?: Lark.BatchMessageSendProgress
526
+ /** 消息撤回进度 */
527
+ batch_message_recall_progress?: Lark.BatchMessageRecallProgress
528
+ }
529
+ }
1362
530
 
1363
- export interface PatchImFeedCardQuery {
1364
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1365
- user_id_type: 'open_id' | 'user_id' | 'union_id'
1366
- }
531
+ export namespace Image {
532
+ export interface Methods {
533
+ /**
534
+ * 上传图片
535
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create
536
+ */
537
+ create(form: CreateForm): Promise<CreateResponse>
538
+ /**
539
+ * 下载图片
540
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/get
541
+ */
542
+ get(image_key: string): Promise<ArrayBuffer>
543
+ }
544
+
545
+ export interface CreateForm {
546
+ /** 图片类型 */
547
+ image_type: 'message' | 'avatar'
548
+ /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
549
+ image: Blob
550
+ }
551
+
552
+ export interface CreateResponse {
553
+ /** 图片的key */
554
+ image_key?: string
555
+ }
556
+ }
1367
557
 
1368
- export interface PatchImFeedCardResponse {
1369
- /** 失败原因 */
1370
- failed_user_reasons?: FailedReason[]
1371
- }
558
+ export namespace File {
559
+ export interface Methods {
560
+ /**
561
+ * 上传文件
562
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create
563
+ */
564
+ create(form: CreateForm): Promise<CreateResponse>
565
+ /**
566
+ * 下载文件
567
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/get
568
+ */
569
+ get(file_key: string): Promise<ArrayBuffer>
570
+ }
571
+
572
+ export interface CreateForm {
573
+ /** 文件类型 */
574
+ file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream'
575
+ /** 带后缀的文件名 */
576
+ file_name: string
577
+ /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
578
+ duration?: number
579
+ /** 文件内容 */
580
+ file: Blob
581
+ }
582
+
583
+ export interface CreateResponse {
584
+ /** 文件的key */
585
+ file_key?: string
586
+ }
587
+ }
1372
588
 
1373
- export interface GetImBizEntityTagRelationQuery {
1374
- /** 业务类型 */
1375
- tag_biz_type: 'chat'
1376
- /** 业务实体id */
1377
- biz_entity_id: string
1378
- }
589
+ export namespace Pin {
590
+ export interface Methods {
591
+ /**
592
+ * Pin 消息
593
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create
594
+ */
595
+ create(body: CreateRequest): Promise<CreateResponse>
596
+ /**
597
+ * 移除 Pin 消息
598
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete
599
+ */
600
+ delete(message_id: string): Promise<void>
601
+ /**
602
+ * 获取群内 Pin 消息
603
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list
604
+ */
605
+ list(query?: ListQuery): Paginated<Lark.Pin>
606
+ }
607
+
608
+ export interface CreateRequest {
609
+ /** 待Pin的消息ID */
610
+ message_id: string
611
+ }
612
+
613
+ export interface CreateResponse {
614
+ pin?: Lark.Pin
615
+ }
616
+
617
+ export interface ListQuery extends Pagination {
618
+ /** 待获取Pin消息的Chat ID */
619
+ chat_id: string
620
+ /** Pin信息的起始时间(毫秒级时间戳) */
621
+ start_time?: string
622
+ /** Pin信息的结束时间(毫秒级时间戳) */
623
+ end_time?: string
624
+ }
625
+ }
1379
626
 
1380
- export interface GetImBizEntityTagRelationResponse {
1381
- /** 标签内容及绑定时间 */
1382
- tag_info_with_bind_versions?: TagInfoWithBindVersion[]
1383
- }
627
+ export namespace UrlPreview {
628
+ export interface Methods {
629
+ /**
630
+ * 更新 URL 预览
631
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/url_preview/batch_update
632
+ */
633
+ batchUpdate(body: BatchUpdateRequest): Promise<void>
634
+ }
635
+
636
+ export interface BatchUpdateRequest {
637
+ /** URL预览的token列表 */
638
+ preview_tokens: string[]
639
+ /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
640
+ open_ids?: string[]
641
+ }
642
+ }
1384
643
 
1385
- export interface CreateImTagRequest {
1386
- /** 创建标签 */
1387
- create_tag: CreateTag
1388
- }
644
+ export namespace Chat {
645
+ export interface Methods {
646
+ moderation: Moderation.Methods
647
+ topNotice: TopNotice.Methods
648
+ managers: Managers.Methods
649
+ members: Members.Methods
650
+ announcement: Announcement.Methods
651
+ tab: Tab.Methods
652
+ menuTree: MenuTree.Methods
653
+ menuItem: MenuItem.Methods
654
+ /**
655
+ * 创建群
656
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
657
+ */
658
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
659
+ /**
660
+ * 解散群
661
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete
662
+ */
663
+ delete(chat_id: string): Promise<void>
664
+ /**
665
+ * 更新群信息
666
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update
667
+ */
668
+ update(chat_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<void>
669
+ /**
670
+ * 获取群信息
671
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get
672
+ */
673
+ get(chat_id: string, query?: GetQuery): Promise<GetResponse>
674
+ /**
675
+ * 获取用户或机器人所在的群列表
676
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list
677
+ */
678
+ list(query?: ListQuery): Paginated<Lark.ListChat>
679
+ /**
680
+ * 搜索对用户或机器人可见的群列表
681
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search
682
+ */
683
+ search(query?: SearchQuery): Paginated<Lark.ListChat>
684
+ /**
685
+ * 获取群分享链接
686
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link
687
+ */
688
+ link(chat_id: string, body: LinkRequest): Promise<LinkResponse>
689
+ }
690
+
691
+ export interface CreateRequest {
692
+ /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
693
+ avatar?: string
694
+ /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
695
+ name?: string
696
+ /** 群描述 */
697
+ description?: string
698
+ /** 群国际化名称 */
699
+ i18n_names?: Lark.I18nNames
700
+ /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
701
+ owner_id?: string
702
+ /** 创建群时邀请的群成员,id 类型为 user_id_type */
703
+ user_id_list?: string[]
704
+ /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
705
+ bot_id_list?: string[]
706
+ /** 群消息模式 */
707
+ group_message_type?: 'chat' | 'thread'
708
+ /** 群模式**可选值有**:- `group`:群组 */
709
+ chat_mode?: string
710
+ /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
711
+ chat_type?: string
712
+ /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
713
+ join_message_visibility?: string
714
+ /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
715
+ leave_message_visibility?: string
716
+ /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
717
+ membership_approval?: string
718
+ /** 防泄密模式设置 */
719
+ restricted_mode_setting?: Lark.RestrictedModeSetting
720
+ /** 谁可以加急 */
721
+ urgent_setting?: 'only_owner' | 'all_members'
722
+ /** 谁可以发起视频会议 */
723
+ video_conference_setting?: 'only_owner' | 'all_members'
724
+ /** 谁可以编辑群信息 */
725
+ edit_permission?: 'only_owner' | 'all_members'
726
+ /** 隐藏群成员人数设置 */
727
+ hide_member_count_setting?: 'all_members' | 'only_owner'
728
+ }
729
+
730
+ export interface CreateQuery {
731
+ /** 此次调用中使用的用户ID的类型 */
732
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
733
+ /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
734
+ set_bot_manager?: boolean
735
+ /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
736
+ uuid?: string
737
+ }
738
+
739
+ export interface CreateResponse {
740
+ /** 群ID */
741
+ chat_id?: string
742
+ /** 群头像URL */
743
+ avatar?: string
744
+ /** 群名称 */
745
+ name?: string
746
+ /** 群描述 */
747
+ description?: string
748
+ /** 群国际化名称 */
749
+ i18n_names?: Lark.I18nNames
750
+ /** 群主 ID */
751
+ owner_id?: string
752
+ /** 群主 ID 类型 */
753
+ owner_id_type?: string
754
+ /** 谁可以加急 */
755
+ urgent_setting?: 'only_owner' | 'all_members'
756
+ /** 谁可以发起视频会议 */
757
+ video_conference_setting?: 'only_owner' | 'all_members'
758
+ /** 加user/bot入群权限(all_members/only_owner) */
759
+ add_member_permission?: string
760
+ /** 群分享权限(allowed/not_allowed) */
761
+ share_card_permission?: string
762
+ /** at所有人权限(all_members/only_owner) */
763
+ at_all_permission?: string
764
+ /** 群编辑权限(all_members/only_owner) */
765
+ edit_permission?: string
766
+ /** 群消息模式 */
767
+ group_message_type?: string
768
+ /** 群模式 */
769
+ chat_mode?: string
770
+ /** 群类型 */
771
+ chat_type?: string
772
+ /** 优先级最高的一个群tag */
773
+ chat_tag?: string
774
+ /** 是否是外部群 */
775
+ external?: boolean
776
+ /** tenant key */
777
+ tenant_key?: string
778
+ /** 入群消息可见性 */
779
+ join_message_visibility?: string
780
+ /** 出群消息可见性 */
781
+ leave_message_visibility?: string
782
+ /** 加群审批 */
783
+ membership_approval?: string
784
+ /** 发言权限 */
785
+ moderation_permission?: string
786
+ /** 防泄密模式设置 */
787
+ restricted_mode_setting?: Lark.RestrictedModeSetting
788
+ /** 隐藏群成员人数设置 */
789
+ hide_member_count_setting?: 'all_members' | 'only_owner'
790
+ }
791
+
792
+ export interface UpdateRequest {
793
+ /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
794
+ avatar?: string
795
+ /** 群名称 */
796
+ name?: string
797
+ /** 群描述 */
798
+ description?: string
799
+ /** 群国际化名称 */
800
+ i18n_names?: Lark.I18nNames
801
+ /** 加 user/bot 入群权限(all_members/only_owner) */
802
+ add_member_permission?: string
803
+ /** 群分享权限(allowed/not_allowed) */
804
+ share_card_permission?: string
805
+ /** at 所有人权限(all_members/only_owner) */
806
+ at_all_permission?: string
807
+ /** 群编辑权限(all_members/only_owner) */
808
+ edit_permission?: string
809
+ /** 新群主 ID */
810
+ owner_id?: string
811
+ /** 入群消息可见性(only_owner/all_members/not_anyone) */
812
+ join_message_visibility?: string
813
+ /** 出群消息可见性(only_owner/all_members/not_anyone) */
814
+ leave_message_visibility?: string
815
+ /** 加群审批(no_approval_required/approval_required) */
816
+ membership_approval?: string
817
+ /** 防泄密模式设置 */
818
+ restricted_mode_setting?: Lark.RestrictedModeSetting
819
+ /** 群类型 */
820
+ chat_type?: string
821
+ /** 群消息模式 */
822
+ group_message_type?: 'chat' | 'thread'
823
+ /** 谁可以加急 */
824
+ urgent_setting?: 'only_owner' | 'all_members'
825
+ /** 谁可以发起视频会议 */
826
+ video_conference_setting?: 'only_owner' | 'all_members'
827
+ /** 隐藏群成员人数设置 */
828
+ hide_member_count_setting?: 'all_members' | 'only_owner'
829
+ }
830
+
831
+ export interface UpdateQuery {
832
+ /** 此次调用中使用的用户ID的类型 */
833
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
834
+ }
835
+
836
+ export interface GetQuery {
837
+ /** 此次调用中使用的用户ID的类型 */
838
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
839
+ }
840
+
841
+ export interface GetResponse {
842
+ /** 群头像URL */
843
+ avatar?: string
844
+ /** 群名称 */
845
+ name?: string
846
+ /** 群描述 */
847
+ description?: string
848
+ /** 群国际化名称 */
849
+ i18n_names?: Lark.I18nNames
850
+ /** 加user/bot入群权限(all_members/only_owner) */
851
+ add_member_permission?: string
852
+ /** 群分享权限(allowed/not_allowed) */
853
+ share_card_permission?: string
854
+ /** at所有人权限(all_members/only_owner) */
855
+ at_all_permission?: string
856
+ /** 群编辑权限(all_members/only_owner) */
857
+ edit_permission?: string
858
+ /** 群主ID的类型(open_id/user_id/union_id) */
859
+ owner_id_type?: string
860
+ /** 群主ID */
861
+ owner_id?: string
862
+ /** 用户管理员列表 */
863
+ user_manager_id_list?: string[]
864
+ /** 机器人管理员列表 */
865
+ bot_manager_id_list?: string[]
866
+ /** 群消息模式 */
867
+ group_message_type?: string
868
+ /** 群模式 */
869
+ chat_mode?: string
870
+ /** 群类型 */
871
+ chat_type?: string
872
+ /** 优先级最高的一个群tag */
873
+ chat_tag?: string
874
+ /** 入群消息可见性 */
875
+ join_message_visibility?: string
876
+ /** 出群消息可见性 */
877
+ leave_message_visibility?: string
878
+ /** 加群审批 */
879
+ membership_approval?: string
880
+ /** 发言权限 */
881
+ moderation_permission?: string
882
+ /** 是否是外部群 */
883
+ external?: boolean
884
+ /** tenant key */
885
+ tenant_key?: string
886
+ /** 群成员人数 */
887
+ user_count?: string
888
+ /** 群机器人数 */
889
+ bot_count?: string
890
+ /** 防泄密模式设置 */
891
+ restricted_mode_setting?: Lark.RestrictedModeSetting
892
+ /** 谁可以加急 */
893
+ urgent_setting?: 'only_owner' | 'all_members'
894
+ /** 谁可以发起视频会议 */
895
+ video_conference_setting?: 'only_owner' | 'all_members'
896
+ /** 隐藏群成员人数设置 */
897
+ hide_member_count_setting?: 'all_members' | 'only_owner'
898
+ /** 群状态 */
899
+ chat_status?: 'normal' | 'dissolved' | 'dissolved_save'
900
+ }
901
+
902
+ export interface ListQuery extends Pagination {
903
+ /** 此次调用中使用的用户ID的类型 */
904
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
905
+ /** 群组排序方式 */
906
+ sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc'
907
+ }
908
+
909
+ export interface SearchQuery extends Pagination {
910
+ /** 此次调用中使用的用户ID的类型 */
911
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
912
+ /** 关键词。注意:如果query为空值将返回空的结果 */
913
+ query?: string
914
+ }
915
+
916
+ export interface LinkRequest {
917
+ /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
918
+ validity_period?: 'week' | 'year' | 'permanently'
919
+ }
920
+
921
+ export interface LinkResponse {
922
+ /** 群分享链接 */
923
+ share_link?: string
924
+ /** 分享链接过期时间戳(秒级) */
925
+ expire_time?: string
926
+ /** 分享链接是否永久有效 */
927
+ is_permanent?: boolean
928
+ }
929
+
930
+ export namespace Moderation {
931
+ export interface Methods {
932
+ /**
933
+ * 更新群发言权限
934
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update
935
+ */
936
+ update(chat_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<void>
937
+ /**
938
+ * 获取群成员发言权限
939
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get
940
+ */
941
+ get(chat_id: string, query?: GetQuery): Promise<GetResponse>
942
+ }
943
+
944
+ export interface UpdateRequest {
945
+ /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
946
+ moderation_setting?: string
947
+ /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
948
+ moderator_added_list?: string[]
949
+ /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
950
+ moderator_removed_list?: string[]
951
+ }
952
+
953
+ export interface UpdateQuery {
954
+ /** 此次调用中使用的用户ID的类型 */
955
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
956
+ }
957
+
958
+ export interface GetQuery extends Pagination {
959
+ /** 此次调用中使用的用户ID的类型 */
960
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
961
+ }
962
+
963
+ export interface GetResponse {
964
+ /** 群发言模式 */
965
+ moderation_setting?: string
966
+ /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
967
+ page_token?: string
968
+ /** 是否还有更多项 */
969
+ has_more?: boolean
970
+ /** 可发言用户列表 */
971
+ items?: Lark.ListModerator[]
972
+ }
973
+ }
974
+
975
+ export namespace TopNotice {
976
+ export interface Methods {
977
+ /**
978
+ * 更新群置顶
979
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice
980
+ */
981
+ putTopNotice(chat_id: string, body: PutTopNoticeRequest): Promise<void>
982
+ /**
983
+ * 撤销群置顶
984
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice
985
+ */
986
+ deleteTopNotice(chat_id: string): Promise<void>
987
+ }
988
+
989
+ export interface PutTopNoticeRequest {
990
+ /** 要进行发布的群置顶 */
991
+ chat_top_notice: Lark.ChatTopNotice[]
992
+ }
993
+ }
994
+
995
+ export namespace Managers {
996
+ export interface Methods {
997
+ /**
998
+ * 指定群管理员
999
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers
1000
+ */
1001
+ addManagers(chat_id: string, body: AddManagersRequest, query?: AddManagersQuery): Promise<AddManagersResponse>
1002
+ /**
1003
+ * 删除群管理员
1004
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers
1005
+ */
1006
+ deleteManagers(chat_id: string, body: DeleteManagersRequest, query?: DeleteManagersQuery): Promise<DeleteManagersResponse>
1007
+ }
1008
+
1009
+ export interface AddManagersRequest {
1010
+ /** 要增加的 manager_id */
1011
+ manager_ids?: string[]
1012
+ }
1013
+
1014
+ export interface AddManagersQuery {
1015
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1016
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1017
+ }
1018
+
1019
+ export interface AddManagersResponse {
1020
+ /** 群目前的管理员id */
1021
+ chat_managers?: string[]
1022
+ /** 群目前的管理员bot id */
1023
+ chat_bot_managers?: string[]
1024
+ }
1025
+
1026
+ export interface DeleteManagersRequest {
1027
+ /** 要删除的 manager_id */
1028
+ manager_ids?: string[]
1029
+ }
1030
+
1031
+ export interface DeleteManagersQuery {
1032
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1033
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1034
+ }
1035
+
1036
+ export interface DeleteManagersResponse {
1037
+ /** 群目前的管理员id */
1038
+ chat_managers?: string[]
1039
+ /** 群目前的管理员bot id */
1040
+ chat_bot_managers?: string[]
1041
+ }
1042
+ }
1043
+
1044
+ export namespace Members {
1045
+ export interface Methods {
1046
+ /**
1047
+ * 将用户或机器人拉入群聊
1048
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create
1049
+ */
1050
+ create(chat_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
1051
+ /**
1052
+ * 用户或机器人主动加入群聊
1053
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join
1054
+ */
1055
+ meJoin(chat_id: string): Promise<void>
1056
+ /**
1057
+ * 将用户或机器人移出群聊
1058
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete
1059
+ */
1060
+ delete(chat_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<DeleteResponse>
1061
+ /**
1062
+ * 获取群成员列表
1063
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get
1064
+ */
1065
+ get(chat_id: string, query?: GetQuery): Promise<GetResponse>
1066
+ /**
1067
+ * 判断用户或机器人是否在群里
1068
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat
1069
+ */
1070
+ isInChat(chat_id: string): Promise<IsInChatResponse>
1071
+ }
1072
+
1073
+ export interface CreateRequest {
1074
+ /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
1075
+ id_list?: string[]
1076
+ }
1077
+
1078
+ export interface CreateQuery {
1079
+ /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
1080
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1081
+ /** 出现不可用ID后的处理方式 0/1/2 */
1082
+ succeed_type?: 0 | 1 | 2
1083
+ }
1084
+
1085
+ export interface CreateResponse {
1086
+ /** ID无效的成员列表 */
1087
+ invalid_id_list?: string[]
1088
+ /** ID不存在的成员列表 */
1089
+ not_existed_id_list?: string[]
1090
+ /** 等待群主或管理员审批的成员ID列表 */
1091
+ pending_approval_id_list?: string[]
1092
+ }
1093
+
1094
+ export interface DeleteRequest {
1095
+ /** 成员列表 */
1096
+ id_list?: string[]
1097
+ }
1098
+
1099
+ export interface DeleteQuery {
1100
+ /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
1101
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1102
+ }
1103
+
1104
+ export interface DeleteResponse {
1105
+ /** 无效成员列表 */
1106
+ invalid_id_list?: string[]
1107
+ }
1108
+
1109
+ export interface GetQuery extends Pagination {
1110
+ /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
1111
+ member_id_type?: 'user_id' | 'union_id' | 'open_id'
1112
+ }
1113
+
1114
+ export interface GetResponse {
1115
+ /** member列表 */
1116
+ items?: Lark.ListMember[]
1117
+ /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token */
1118
+ page_token?: string
1119
+ /** 是否还有更多项 */
1120
+ has_more?: boolean
1121
+ /** 成员总数 */
1122
+ member_total?: number
1123
+ }
1124
+
1125
+ export interface IsInChatResponse {
1126
+ /** 用户或者机器人是否在群中 */
1127
+ is_in_chat?: boolean
1128
+ }
1129
+ }
1130
+
1131
+ export namespace Announcement {
1132
+ export interface Methods {
1133
+ /**
1134
+ * 更新群公告信息
1135
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch
1136
+ */
1137
+ patch(chat_id: string, body: PatchRequest): Promise<void>
1138
+ /**
1139
+ * 获取群公告信息
1140
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get
1141
+ */
1142
+ get(chat_id: string, query?: GetQuery): Promise<GetResponse>
1143
+ }
1144
+
1145
+ export interface PatchRequest {
1146
+ /** 文档当前版本号 int64 类型,get 接口会返回 */
1147
+ revision: string
1148
+ /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
1149
+ requests?: string[]
1150
+ }
1151
+
1152
+ export interface GetQuery {
1153
+ /** 此次调用中使用的用户ID的类型 */
1154
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1155
+ }
1156
+
1157
+ export interface GetResponse {
1158
+ /** CCM 文档序列化信息 */
1159
+ content?: string
1160
+ /** 文档当前版本号 纯数字 */
1161
+ revision?: string
1162
+ /** 文档生成的时间戳(秒) */
1163
+ create_time?: string
1164
+ /** 消息更新的时间戳(秒) */
1165
+ update_time?: string
1166
+ /** 文档所有者id类型, open_id/user_id/union_id/app_id */
1167
+ owner_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1168
+ /** 文档所有者id */
1169
+ owner_id?: string
1170
+ /** 文档最新修改者id类型, open_id/user_id/union_id/app_id */
1171
+ modifier_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id'
1172
+ /** 文档最新修改者id */
1173
+ modifier_id?: string
1174
+ }
1175
+ }
1176
+
1177
+ export namespace Tab {
1178
+ export interface Methods {
1179
+ /**
1180
+ * 添加会话标签页
1181
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create
1182
+ */
1183
+ create(chat_id: string, body: CreateRequest): Promise<CreateResponse>
1184
+ /**
1185
+ * 删除会话标签页
1186
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs
1187
+ */
1188
+ deleteTabs(chat_id: string, body: DeleteTabsRequest): Promise<DeleteTabsResponse>
1189
+ /**
1190
+ * 更新会话标签页
1191
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs
1192
+ */
1193
+ updateTabs(chat_id: string, body: UpdateTabsRequest): Promise<UpdateTabsResponse>
1194
+ /**
1195
+ * 会话标签页排序
1196
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs
1197
+ */
1198
+ sortTabs(chat_id: string, body: SortTabsRequest): Promise<SortTabsResponse>
1199
+ /**
1200
+ * 拉取会话标签页
1201
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs
1202
+ */
1203
+ listTabs(chat_id: string): Promise<ListTabsResponse>
1204
+ }
1205
+
1206
+ export interface CreateRequest {
1207
+ /** 会话标签页 */
1208
+ chat_tabs: Lark.ChatTab[]
1209
+ }
1210
+
1211
+ export interface CreateResponse {
1212
+ /** 群标签列表 */
1213
+ chat_tabs?: Lark.ChatTab[]
1214
+ }
1215
+
1216
+ export interface DeleteTabsRequest {
1217
+ /** 会话标签页id列表 */
1218
+ tab_ids: string[]
1219
+ }
1220
+
1221
+ export interface DeleteTabsResponse {
1222
+ /** 群标签列表 */
1223
+ chat_tabs?: Lark.ChatTab[]
1224
+ }
1225
+
1226
+ export interface UpdateTabsRequest {
1227
+ /** 会话标签页 */
1228
+ chat_tabs?: Lark.ChatTab[]
1229
+ }
1230
+
1231
+ export interface UpdateTabsResponse {
1232
+ /** 群标签列表 */
1233
+ chat_tabs?: Lark.ChatTab[]
1234
+ }
1235
+
1236
+ export interface SortTabsRequest {
1237
+ /** 会话标签页ID列表 */
1238
+ tab_ids?: string[]
1239
+ }
1240
+
1241
+ export interface SortTabsResponse {
1242
+ /** 群标签列表 */
1243
+ chat_tabs?: Lark.ChatTab[]
1244
+ }
1245
+
1246
+ export interface ListTabsResponse {
1247
+ /** 会话标签页 */
1248
+ chat_tabs?: Lark.ChatTab[]
1249
+ }
1250
+ }
1251
+
1252
+ export namespace MenuTree {
1253
+ export interface Methods {
1254
+ /**
1255
+ * 添加群菜单
1256
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create
1257
+ */
1258
+ create(chat_id: string, body: CreateRequest): Promise<CreateResponse>
1259
+ /**
1260
+ * 删除群菜单
1261
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete
1262
+ */
1263
+ delete(chat_id: string, body: DeleteRequest): Promise<DeleteResponse>
1264
+ /**
1265
+ * 排序群菜单
1266
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort
1267
+ */
1268
+ sort(chat_id: string, body: SortRequest): Promise<SortResponse>
1269
+ /**
1270
+ * 获取群菜单
1271
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get
1272
+ */
1273
+ get(chat_id: string): Promise<GetResponse>
1274
+ }
1275
+
1276
+ export interface CreateRequest {
1277
+ /** 要向群内追加的菜单 */
1278
+ menu_tree: Lark.ChatMenuTree
1279
+ }
1280
+
1281
+ export interface CreateResponse {
1282
+ /** 追加后群内现有菜单 */
1283
+ menu_tree?: Lark.ChatMenuTree
1284
+ }
1285
+
1286
+ export interface DeleteRequest {
1287
+ /** 要删除的一级菜单ID列表 */
1288
+ chat_menu_top_level_ids: string[]
1289
+ }
1290
+
1291
+ export interface DeleteResponse {
1292
+ /** 群内现有菜单 */
1293
+ menu_tree?: Lark.ChatMenuTree
1294
+ }
1295
+
1296
+ export interface SortRequest {
1297
+ /** 一级菜单id列表 */
1298
+ chat_menu_top_level_ids: string[]
1299
+ }
1300
+
1301
+ export interface SortResponse {
1302
+ /** 排序后群内菜单 */
1303
+ menu_tree?: Lark.ChatMenuTree
1304
+ }
1305
+
1306
+ export interface GetResponse {
1307
+ /** 群内所有菜单 */
1308
+ menu_tree?: Lark.ChatMenuTree
1309
+ }
1310
+ }
1311
+
1312
+ export namespace MenuItem {
1313
+ export interface Methods {
1314
+ /**
1315
+ * 修改群菜单元信息
1316
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch
1317
+ */
1318
+ patch(chat_id: string, menu_item_id: string, body: PatchRequest): Promise<PatchResponse>
1319
+ }
1320
+
1321
+ export interface PatchRequest {
1322
+ /** 修改的字段 */
1323
+ update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[]
1324
+ /** 元信息 */
1325
+ chat_menu_item: Lark.ChatMenuItem
1326
+ }
1327
+
1328
+ export interface PatchResponse {
1329
+ chat_menu_item?: Lark.ChatMenuItem
1330
+ }
1331
+ }
1332
+ }
1389
1333
 
1390
- export interface CreateImTagResponse {
1391
- /** 创建的tagid */
1392
- id?: string
1393
- /** 创建失败原因 */
1394
- create_tag_fail_reason?: CreateTagFailReason
1395
- }
1334
+ export namespace AppFeedCard {
1335
+ export interface Methods {
1336
+ batch: Batch.Methods
1337
+ /**
1338
+ * 创建应用消息流卡片
1339
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card/create
1340
+ */
1341
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
1342
+ }
1343
+
1344
+ export interface CreateRequest {
1345
+ /** 应用消息卡片 */
1346
+ app_feed_card?: Lark.OpenAppFeedCard
1347
+ /** 用户 ID */
1348
+ user_ids?: string[]
1349
+ }
1350
+
1351
+ export interface CreateQuery {
1352
+ /** 用户 ID 类型 */
1353
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1354
+ }
1355
+
1356
+ export interface CreateResponse {
1357
+ /** 失败的卡片 */
1358
+ failed_cards?: Lark.OpenFailedUserAppFeedCardItem[]
1359
+ /** 卡片业务 ID */
1360
+ biz_id?: string
1361
+ }
1362
+
1363
+ export namespace Batch {
1364
+ export interface Methods {
1365
+ /**
1366
+ * 更新应用消息流卡片
1367
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/update
1368
+ */
1369
+ update(body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
1370
+ /**
1371
+ * 删除应用消息流卡片
1372
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/delete
1373
+ */
1374
+ delete(body: DeleteRequest, query?: DeleteQuery): Promise<DeleteResponse>
1375
+ }
1376
+
1377
+ export interface UpdateRequest {
1378
+ /** 应用消息卡片 */
1379
+ feed_cards?: Lark.UserOpenAppFeedCardUpdater[]
1380
+ }
1381
+
1382
+ export interface UpdateQuery {
1383
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1384
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
1385
+ }
1386
+
1387
+ export interface UpdateResponse {
1388
+ /** 失败的卡片 */
1389
+ failed_cards?: Lark.OpenFailedUserAppFeedCardItem[]
1390
+ }
1391
+
1392
+ export interface DeleteRequest {
1393
+ /** 应用消息卡片 */
1394
+ feed_cards?: Lark.UserOpenAppFeedCardDeleter[]
1395
+ }
1396
+
1397
+ export interface DeleteQuery {
1398
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1399
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
1400
+ }
1401
+
1402
+ export interface DeleteResponse {
1403
+ /** 失败的卡片 */
1404
+ failed_cards?: Lark.OpenFailedUserAppFeedCardItem[]
1405
+ }
1406
+ }
1407
+ }
1396
1408
 
1397
- export interface PatchImTagRequest {
1398
- /** 编辑标签 */
1399
- patch_tag?: PatchTag
1400
- }
1409
+ export namespace FeedCard {
1410
+ export interface Methods {
1411
+ /**
1412
+ * 机器人单聊即时提醒
1413
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/bot_time_sentive
1414
+ */
1415
+ botTimeSentive(body: BotTimeSentiveRequest, query?: BotTimeSentiveQuery): Promise<BotTimeSentiveResponse>
1416
+ /**
1417
+ * 即时提醒
1418
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/patch
1419
+ */
1420
+ patch(feed_card_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>
1421
+ }
1422
+
1423
+ export interface BotTimeSentiveRequest {
1424
+ /** 临时置顶状态,true-打开,false-关闭 */
1425
+ time_sensitive: boolean
1426
+ /** 用户id 列表 */
1427
+ user_ids: string[]
1428
+ }
1429
+
1430
+ export interface BotTimeSentiveQuery {
1431
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1432
+ user_id_type: 'open_id' | 'user_id' | 'union_id'
1433
+ }
1434
+
1435
+ export interface BotTimeSentiveResponse {
1436
+ /** 失败原因 */
1437
+ failed_user_reasons?: Lark.FailedReason[]
1438
+ }
1439
+
1440
+ export interface PatchRequest {
1441
+ /** 临时置顶状态,true-打开,false-关闭 */
1442
+ time_sensitive: boolean
1443
+ /** 用户id 列表 */
1444
+ user_ids: string[]
1445
+ }
1446
+
1447
+ export interface PatchQuery {
1448
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1449
+ user_id_type: 'open_id' | 'user_id' | 'union_id'
1450
+ }
1451
+
1452
+ export interface PatchResponse {
1453
+ /** 失败原因 */
1454
+ failed_user_reasons?: Lark.FailedReason[]
1455
+ }
1456
+ }
1401
1457
 
1402
- export interface PatchImTagResponse {
1403
- /** 编辑后的taginfo */
1404
- tag_info?: TagInfo
1405
- /** 修改失败原因 */
1406
- patch_tag_fail_reason?: PatchTagFailReason
1407
- }
1458
+ export namespace ChatButton {
1459
+ export interface Methods {
1460
+ /**
1461
+ * 更新消息流卡片按钮
1462
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/chat_button/update
1463
+ */
1464
+ update(body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
1465
+ }
1466
+
1467
+ export interface UpdateRequest {
1468
+ /** 用户 ID 列表 */
1469
+ user_ids?: string[]
1470
+ /** 群 ID */
1471
+ chat_id: string
1472
+ /** 按钮 */
1473
+ buttons?: Lark.OpenAppFeedCardButtons
1474
+ }
1475
+
1476
+ export interface UpdateQuery {
1477
+ /** 用户 ID 类型 */
1478
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1479
+ }
1480
+
1481
+ export interface UpdateResponse {
1482
+ /** 失败的用户 */
1483
+ failed_user_reasons?: Lark.FailedReason[]
1484
+ }
1485
+ }
1408
1486
 
1409
- export interface CreateImBizEntityTagRelationRequest {
1410
- /** 业务类型 */
1411
- tag_biz_type: 'chat'
1412
- /** 业务实体id */
1413
- biz_entity_id: string
1414
- /** 标签id */
1415
- tag_ids?: string[]
1416
- }
1487
+ export namespace BizEntityTagRelation {
1488
+ export interface Methods {
1489
+ /**
1490
+ * 查询实体与标签的绑定关系
1491
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/get
1492
+ */
1493
+ get(query?: GetQuery): Promise<GetResponse>
1494
+ /**
1495
+ * 绑定标签到群
1496
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/create
1497
+ */
1498
+ create(body: CreateRequest): Promise<void>
1499
+ /**
1500
+ * 解绑标签与群
1501
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/update
1502
+ */
1503
+ update(body: UpdateRequest): Promise<void>
1504
+ }
1505
+
1506
+ export interface GetQuery {
1507
+ /** 业务类型 */
1508
+ tag_biz_type: 'chat'
1509
+ /** 业务实体id */
1510
+ biz_entity_id: string
1511
+ }
1512
+
1513
+ export interface GetResponse {
1514
+ /** 标签内容及绑定时间 */
1515
+ tag_info_with_bind_versions?: Lark.TagInfoWithBindVersion[]
1516
+ }
1517
+
1518
+ export interface CreateRequest {
1519
+ /** 业务类型 */
1520
+ tag_biz_type: 'chat'
1521
+ /** 业务实体id */
1522
+ biz_entity_id: string
1523
+ /** 标签id */
1524
+ tag_ids?: string[]
1525
+ }
1526
+
1527
+ export interface UpdateRequest {
1528
+ /** 业务类型 */
1529
+ tag_biz_type: 'chat'
1530
+ /** 业务实体id */
1531
+ biz_entity_id: string
1532
+ /** 标签id */
1533
+ tag_ids?: string[]
1534
+ }
1535
+ }
1417
1536
 
1418
- export interface UpdateImBizEntityTagRelationRequest {
1419
- /** 业务类型 */
1420
- tag_biz_type: 'chat'
1421
- /** 业务实体id */
1422
- biz_entity_id: string
1423
- /** 标签id */
1424
- tag_ids?: string[]
1537
+ export namespace Tag {
1538
+ export interface Methods {
1539
+ /**
1540
+ * 创建标签
1541
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/create
1542
+ */
1543
+ create(body: CreateRequest): Promise<CreateResponse>
1544
+ /**
1545
+ * 修改标签
1546
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/patch
1547
+ */
1548
+ patch(tag_id: string, body: PatchRequest): Promise<PatchResponse>
1549
+ }
1550
+
1551
+ export interface CreateRequest {
1552
+ /** 创建标签 */
1553
+ create_tag: Lark.CreateTag
1554
+ }
1555
+
1556
+ export interface CreateResponse {
1557
+ /** 创建的tagid */
1558
+ id?: string
1559
+ /** 创建失败原因 */
1560
+ create_tag_fail_reason?: Lark.CreateTagFailReason
1561
+ }
1562
+
1563
+ export interface PatchRequest {
1564
+ /** 编辑标签 */
1565
+ patch_tag?: Lark.PatchTag
1566
+ }
1567
+
1568
+ export interface PatchResponse {
1569
+ /** 编辑后的taginfo */
1570
+ tag_info?: Lark.TagInfo
1571
+ /** 修改失败原因 */
1572
+ patch_tag_fail_reason?: Lark.PatchTagFailReason
1573
+ }
1574
+ }
1425
1575
  }
1426
1576
 
1427
1577
  Internal.define({
1428
1578
  '/im/v1/messages': {
1429
- POST: 'createImMessage',
1430
- GET: { name: 'listImMessage', pagination: { argIndex: 0 } },
1579
+ POST: 'im.message.create',
1580
+ GET: { name: 'im.message.list', pagination: { argIndex: 0 } },
1431
1581
  },
1432
1582
  '/im/v1/messages/{message_id}/reply': {
1433
- POST: 'replyImMessage',
1583
+ POST: 'im.message.reply',
1434
1584
  },
1435
1585
  '/im/v1/messages/{message_id}': {
1436
- PUT: 'updateImMessage',
1437
- DELETE: 'deleteImMessage',
1438
- GET: 'getImMessage',
1439
- PATCH: 'patchImMessage',
1586
+ PUT: 'im.message.update',
1587
+ DELETE: 'im.message.delete',
1588
+ GET: 'im.message.get',
1589
+ PATCH: 'im.message.patch',
1440
1590
  },
1441
1591
  '/im/v1/messages/{message_id}/forward': {
1442
- POST: 'forwardImMessage',
1592
+ POST: 'im.message.forward',
1443
1593
  },
1444
1594
  '/im/v1/messages/merge_forward': {
1445
- POST: 'mergeForwardImMessage',
1595
+ POST: 'im.message.mergeForward',
1446
1596
  },
1447
1597
  '/im/v1/threads/{thread_id}/forward': {
1448
- POST: 'forwardImThread',
1598
+ POST: 'im.thread.forward',
1449
1599
  },
1450
1600
  '/im/v1/messages/{message_id}/push_follow_up': {
1451
- POST: 'pushFollowUpImMessage',
1601
+ POST: 'im.message.pushFollowUp',
1452
1602
  },
1453
1603
  '/im/v1/messages/{message_id}/read_users': {
1454
- GET: { name: 'readUsersImMessage', pagination: { argIndex: 1 } },
1604
+ GET: { name: 'im.message.readUsers', pagination: { argIndex: 1 } },
1455
1605
  },
1456
1606
  '/im/v1/messages/{message_id}/resources/{file_key}': {
1457
- GET: { name: 'getImMessageResource', type: 'binary' },
1607
+ GET: { name: 'im.message.resource.get', type: 'binary' },
1458
1608
  },
1459
1609
  '/im/v1/batch_messages/{batch_message_id}': {
1460
- DELETE: 'deleteImBatchMessage',
1610
+ DELETE: 'im.batchMessage.delete',
1461
1611
  },
1462
1612
  '/im/v1/batch_messages/{batch_message_id}/read_user': {
1463
- GET: 'readUserImBatchMessage',
1613
+ GET: 'im.batchMessage.readUser',
1464
1614
  },
1465
1615
  '/im/v1/batch_messages/{batch_message_id}/get_progress': {
1466
- GET: 'getProgressImBatchMessage',
1616
+ GET: 'im.batchMessage.getProgress',
1467
1617
  },
1468
1618
  '/im/v1/images': {
1469
- POST: { name: 'createImImage', multipart: true },
1619
+ POST: { name: 'im.image.create', multipart: true },
1470
1620
  },
1471
1621
  '/im/v1/images/{image_key}': {
1472
- GET: { name: 'getImImage', type: 'binary' },
1622
+ GET: { name: 'im.image.get', type: 'binary' },
1473
1623
  },
1474
1624
  '/im/v1/files': {
1475
- POST: { name: 'createImFile', multipart: true },
1625
+ POST: { name: 'im.file.create', multipart: true },
1476
1626
  },
1477
1627
  '/im/v1/files/{file_key}': {
1478
- GET: { name: 'getImFile', type: 'binary' },
1628
+ GET: { name: 'im.file.get', type: 'binary' },
1479
1629
  },
1480
1630
  '/im/v1/messages/{message_id}/urgent_app': {
1481
- PATCH: 'urgentAppImMessage',
1631
+ PATCH: 'im.message.urgentApp',
1482
1632
  },
1483
1633
  '/im/v1/messages/{message_id}/urgent_sms': {
1484
- PATCH: 'urgentSmsImMessage',
1634
+ PATCH: 'im.message.urgentSms',
1485
1635
  },
1486
1636
  '/im/v1/messages/{message_id}/urgent_phone': {
1487
- PATCH: 'urgentPhoneImMessage',
1637
+ PATCH: 'im.message.urgentPhone',
1488
1638
  },
1489
1639
  '/im/v1/messages/{message_id}/reactions': {
1490
- POST: 'createImMessageReaction',
1491
- GET: { name: 'listImMessageReaction', pagination: { argIndex: 1 } },
1640
+ POST: 'im.message.reaction.create',
1641
+ GET: { name: 'im.message.reaction.list', pagination: { argIndex: 1 } },
1492
1642
  },
1493
1643
  '/im/v1/messages/{message_id}/reactions/{reaction_id}': {
1494
- DELETE: 'deleteImMessageReaction',
1644
+ DELETE: 'im.message.reaction.delete',
1495
1645
  },
1496
1646
  '/im/v1/pins': {
1497
- POST: 'createImPin',
1498
- GET: { name: 'listImPin', pagination: { argIndex: 0 } },
1647
+ POST: 'im.pin.create',
1648
+ GET: { name: 'im.pin.list', pagination: { argIndex: 0 } },
1499
1649
  },
1500
1650
  '/im/v1/pins/{message_id}': {
1501
- DELETE: 'deleteImPin',
1651
+ DELETE: 'im.pin.delete',
1502
1652
  },
1503
1653
  '/im/v2/url_previews/batch_update': {
1504
- POST: 'batchUpdateImUrlPreview',
1654
+ POST: 'im.urlPreview.batchUpdate',
1505
1655
  },
1506
1656
  '/im/v1/chats': {
1507
- POST: 'createImChat',
1508
- GET: { name: 'listImChat', pagination: { argIndex: 0 } },
1657
+ POST: 'im.chat.create',
1658
+ GET: { name: 'im.chat.list', pagination: { argIndex: 0 } },
1509
1659
  },
1510
1660
  '/im/v1/chats/{chat_id}': {
1511
- DELETE: 'deleteImChat',
1512
- PUT: 'updateImChat',
1513
- GET: 'getImChat',
1661
+ DELETE: 'im.chat.delete',
1662
+ PUT: 'im.chat.update',
1663
+ GET: 'im.chat.get',
1514
1664
  },
1515
1665
  '/im/v1/chats/{chat_id}/moderation': {
1516
- PUT: 'updateImChatModeration',
1517
- GET: 'getImChatModeration',
1666
+ PUT: 'im.chat.moderation.update',
1667
+ GET: 'im.chat.moderation.get',
1518
1668
  },
1519
1669
  '/im/v1/chats/{chat_id}/top_notice/put_top_notice': {
1520
- POST: 'putTopNoticeImChatTopNotice',
1670
+ POST: 'im.chat.topNotice.putTopNotice',
1521
1671
  },
1522
1672
  '/im/v1/chats/{chat_id}/top_notice/delete_top_notice': {
1523
- POST: 'deleteTopNoticeImChatTopNotice',
1673
+ POST: 'im.chat.topNotice.deleteTopNotice',
1524
1674
  },
1525
1675
  '/im/v1/chats/search': {
1526
- GET: { name: 'searchImChat', pagination: { argIndex: 0 } },
1676
+ GET: { name: 'im.chat.search', pagination: { argIndex: 0 } },
1527
1677
  },
1528
1678
  '/im/v1/chats/{chat_id}/link': {
1529
- POST: 'linkImChat',
1679
+ POST: 'im.chat.link',
1530
1680
  },
1531
1681
  '/im/v1/chats/{chat_id}/managers/add_managers': {
1532
- POST: 'addManagersImChatManagers',
1682
+ POST: 'im.chat.managers.addManagers',
1533
1683
  },
1534
1684
  '/im/v1/chats/{chat_id}/managers/delete_managers': {
1535
- POST: 'deleteManagersImChatManagers',
1685
+ POST: 'im.chat.managers.deleteManagers',
1536
1686
  },
1537
1687
  '/im/v1/chats/{chat_id}/members': {
1538
- POST: 'createImChatMembers',
1539
- DELETE: 'deleteImChatMembers',
1540
- GET: 'getImChatMembers',
1688
+ POST: 'im.chat.members.create',
1689
+ DELETE: 'im.chat.members.delete',
1690
+ GET: 'im.chat.members.get',
1541
1691
  },
1542
1692
  '/im/v1/chats/{chat_id}/members/me_join': {
1543
- PATCH: 'meJoinImChatMembers',
1693
+ PATCH: 'im.chat.members.meJoin',
1544
1694
  },
1545
1695
  '/im/v1/chats/{chat_id}/members/is_in_chat': {
1546
- GET: 'isInChatImChatMembers',
1696
+ GET: 'im.chat.members.isInChat',
1547
1697
  },
1548
1698
  '/im/v1/chats/{chat_id}/announcement': {
1549
- PATCH: 'patchImChatAnnouncement',
1550
- GET: 'getImChatAnnouncement',
1699
+ PATCH: 'im.chat.announcement.patch',
1700
+ GET: 'im.chat.announcement.get',
1551
1701
  },
1552
1702
  '/im/v1/chats/{chat_id}/chat_tabs': {
1553
- POST: 'createImChatTab',
1703
+ POST: 'im.chat.tab.create',
1554
1704
  },
1555
1705
  '/im/v1/chats/{chat_id}/chat_tabs/delete_tabs': {
1556
- DELETE: 'deleteTabsImChatTab',
1706
+ DELETE: 'im.chat.tab.deleteTabs',
1557
1707
  },
1558
1708
  '/im/v1/chats/{chat_id}/chat_tabs/update_tabs': {
1559
- POST: 'updateTabsImChatTab',
1709
+ POST: 'im.chat.tab.updateTabs',
1560
1710
  },
1561
1711
  '/im/v1/chats/{chat_id}/chat_tabs/sort_tabs': {
1562
- POST: 'sortTabsImChatTab',
1712
+ POST: 'im.chat.tab.sortTabs',
1563
1713
  },
1564
1714
  '/im/v1/chats/{chat_id}/chat_tabs/list_tabs': {
1565
- GET: 'listTabsImChatTab',
1715
+ GET: 'im.chat.tab.listTabs',
1566
1716
  },
1567
1717
  '/im/v1/chats/{chat_id}/menu_tree': {
1568
- POST: 'createImChatMenuTree',
1569
- DELETE: 'deleteImChatMenuTree',
1570
- GET: 'getImChatMenuTree',
1718
+ POST: 'im.chat.menuTree.create',
1719
+ DELETE: 'im.chat.menuTree.delete',
1720
+ GET: 'im.chat.menuTree.get',
1571
1721
  },
1572
1722
  '/im/v1/chats/{chat_id}/menu_items/{menu_item_id}': {
1573
- PATCH: 'patchImChatMenuItem',
1723
+ PATCH: 'im.chat.menuItem.patch',
1574
1724
  },
1575
1725
  '/im/v1/chats/{chat_id}/menu_tree/sort': {
1576
- POST: 'sortImChatMenuTree',
1726
+ POST: 'im.chat.menuTree.sort',
1577
1727
  },
1578
1728
  '/im/v2/app_feed_card': {
1579
- POST: 'createImAppFeedCard',
1729
+ POST: 'im.appFeedCard.create',
1580
1730
  },
1581
1731
  '/im/v2/app_feed_card/batch': {
1582
- PUT: 'updateImAppFeedCardBatch',
1583
- DELETE: 'deleteImAppFeedCardBatch',
1732
+ PUT: 'im.appFeedCard.batch.update',
1733
+ DELETE: 'im.appFeedCard.batch.delete',
1584
1734
  },
1585
1735
  '/im/v2/feed_cards/bot_time_sentive': {
1586
- PATCH: 'botTimeSentiveImFeedCard',
1736
+ PATCH: 'im.feedCard.botTimeSentive',
1587
1737
  },
1588
1738
  '/im/v2/chat_button': {
1589
- PUT: 'updateImChatButton',
1739
+ PUT: 'im.chatButton.update',
1590
1740
  },
1591
1741
  '/im/v2/feed_cards/{feed_card_id}': {
1592
- PATCH: 'patchImFeedCard',
1742
+ PATCH: 'im.feedCard.patch',
1593
1743
  },
1594
1744
  '/im/v2/biz_entity_tag_relation': {
1595
- GET: 'getImBizEntityTagRelation',
1596
- POST: 'createImBizEntityTagRelation',
1597
- PUT: 'updateImBizEntityTagRelation',
1745
+ GET: 'im.bizEntityTagRelation.get',
1746
+ POST: 'im.bizEntityTagRelation.create',
1747
+ PUT: 'im.bizEntityTagRelation.update',
1598
1748
  },
1599
1749
  '/im/v2/tags': {
1600
- POST: 'createImTag',
1750
+ POST: 'im.tag.create',
1601
1751
  },
1602
1752
  '/im/v2/tags/{tag_id}': {
1603
- PATCH: 'patchImTag',
1753
+ PATCH: 'im.tag.patch',
1604
1754
  },
1605
1755
  })