@larksuiteoapi/node-sdk 1.1.0 → 1.2.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.
- package/es/index.js +835 -185
- package/lib/index.js +835 -185
- package/package.json +1 -1
- package/types/index.d.ts +1062 -199
package/types/index.d.ts
CHANGED
|
@@ -980,7 +980,7 @@ declare abstract class Client$1 {
|
|
|
980
980
|
}>;
|
|
981
981
|
};
|
|
982
982
|
/**
|
|
983
|
-
*
|
|
983
|
+
* 应用
|
|
984
984
|
*/
|
|
985
985
|
applicationAppVersion: {
|
|
986
986
|
/**
|
|
@@ -1112,6 +1112,257 @@ declare abstract class Client$1 {
|
|
|
1112
1112
|
} | undefined;
|
|
1113
1113
|
} | undefined;
|
|
1114
1114
|
}>;
|
|
1115
|
+
listWithIterator: (payload?: {
|
|
1116
|
+
params: {
|
|
1117
|
+
lang: "zh_cn" | "en_us" | "ja_jp";
|
|
1118
|
+
page_size?: number;
|
|
1119
|
+
page_token?: string;
|
|
1120
|
+
order?: number;
|
|
1121
|
+
user_id_type?: "user_id" | "union_id" | "open_id";
|
|
1122
|
+
};
|
|
1123
|
+
path: {
|
|
1124
|
+
app_id: string;
|
|
1125
|
+
};
|
|
1126
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
1127
|
+
[Symbol.asyncIterator](): AsyncGenerator<{
|
|
1128
|
+
items?: {
|
|
1129
|
+
app_id: string;
|
|
1130
|
+
version?: string | undefined;
|
|
1131
|
+
version_id: string;
|
|
1132
|
+
app_name?: string | undefined;
|
|
1133
|
+
avatar_url?: string | undefined;
|
|
1134
|
+
description?: string | undefined;
|
|
1135
|
+
scopes?: {
|
|
1136
|
+
scope: string;
|
|
1137
|
+
description?: string | undefined;
|
|
1138
|
+
level?: number | undefined;
|
|
1139
|
+
}[] | undefined;
|
|
1140
|
+
back_home_url?: string | undefined;
|
|
1141
|
+
i18n?: {
|
|
1142
|
+
i18n_key: "zh_cn" | "en_us" | "ja_jp";
|
|
1143
|
+
name?: string | undefined;
|
|
1144
|
+
description?: string | undefined;
|
|
1145
|
+
help_use?: string | undefined;
|
|
1146
|
+
}[] | undefined;
|
|
1147
|
+
common_categories?: string[] | undefined;
|
|
1148
|
+
events?: string[] | undefined;
|
|
1149
|
+
status?: number | undefined;
|
|
1150
|
+
create_time?: string | undefined;
|
|
1151
|
+
publish_time?: string | undefined;
|
|
1152
|
+
ability?: {
|
|
1153
|
+
gadget?: {
|
|
1154
|
+
enable_pc_mode?: number | undefined;
|
|
1155
|
+
schema_urls?: string[] | undefined;
|
|
1156
|
+
pc_use_mobile_pkg?: boolean | undefined;
|
|
1157
|
+
pc_version?: string | undefined;
|
|
1158
|
+
mobile_version?: string | undefined;
|
|
1159
|
+
mobile_min_lark_version?: string | undefined;
|
|
1160
|
+
pc_min_lark_version?: string | undefined;
|
|
1161
|
+
} | undefined;
|
|
1162
|
+
web_app?: {
|
|
1163
|
+
pc_url?: string | undefined;
|
|
1164
|
+
mobile_url?: string | undefined;
|
|
1165
|
+
} | undefined;
|
|
1166
|
+
bot?: {
|
|
1167
|
+
card_request_url?: string | undefined;
|
|
1168
|
+
} | undefined;
|
|
1169
|
+
workplace_widgets?: {
|
|
1170
|
+
min_lark_version?: string | undefined;
|
|
1171
|
+
}[] | undefined;
|
|
1172
|
+
navigate?: {
|
|
1173
|
+
pc?: {
|
|
1174
|
+
version?: string | undefined;
|
|
1175
|
+
image_url?: string | undefined;
|
|
1176
|
+
hover_image_url?: string | undefined;
|
|
1177
|
+
} | undefined;
|
|
1178
|
+
mobile?: {
|
|
1179
|
+
version?: string | undefined;
|
|
1180
|
+
image_url?: string | undefined;
|
|
1181
|
+
hover_image_url?: string | undefined;
|
|
1182
|
+
} | undefined;
|
|
1183
|
+
} | undefined;
|
|
1184
|
+
cloud_doc?: {
|
|
1185
|
+
space_url?: string | undefined;
|
|
1186
|
+
i18n?: {
|
|
1187
|
+
i18n_key: "zh_cn" | "en_us" | "ja_jp";
|
|
1188
|
+
name?: string | undefined;
|
|
1189
|
+
read_description?: string | undefined;
|
|
1190
|
+
write_description?: string | undefined;
|
|
1191
|
+
}[] | undefined;
|
|
1192
|
+
icon_url?: string | undefined;
|
|
1193
|
+
mode?: number | undefined;
|
|
1194
|
+
} | undefined;
|
|
1195
|
+
docs_blocks?: {
|
|
1196
|
+
block_type_id?: string | undefined;
|
|
1197
|
+
i18n?: {
|
|
1198
|
+
i18n_key?: "zh_cn" | "en_us" | "ja_jp" | undefined;
|
|
1199
|
+
name?: string | undefined;
|
|
1200
|
+
}[] | undefined;
|
|
1201
|
+
mobile_icon_url?: string | undefined;
|
|
1202
|
+
pc_icon_url?: string | undefined;
|
|
1203
|
+
}[] | undefined;
|
|
1204
|
+
message_action?: {
|
|
1205
|
+
pc_app_link?: string | undefined;
|
|
1206
|
+
mobile_app_link?: string | undefined;
|
|
1207
|
+
i18n?: {
|
|
1208
|
+
i18n_key?: "zh_cn" | "en_us" | "ja_jp" | undefined;
|
|
1209
|
+
name?: string | undefined;
|
|
1210
|
+
}[] | undefined;
|
|
1211
|
+
} | undefined;
|
|
1212
|
+
plus_menu?: {
|
|
1213
|
+
pc_app_link?: string | undefined;
|
|
1214
|
+
mobile_app_link?: string | undefined;
|
|
1215
|
+
} | undefined;
|
|
1216
|
+
} | undefined;
|
|
1217
|
+
remark?: {
|
|
1218
|
+
remark?: string | undefined;
|
|
1219
|
+
update_remark?: string | undefined;
|
|
1220
|
+
visibility?: {
|
|
1221
|
+
is_all?: boolean | undefined;
|
|
1222
|
+
visible_list?: {
|
|
1223
|
+
open_ids?: string[] | undefined;
|
|
1224
|
+
department_ids?: string[] | undefined;
|
|
1225
|
+
} | undefined;
|
|
1226
|
+
invisible_list?: {
|
|
1227
|
+
open_ids?: string[] | undefined;
|
|
1228
|
+
department_ids?: string[] | undefined;
|
|
1229
|
+
} | undefined;
|
|
1230
|
+
} | undefined;
|
|
1231
|
+
} | undefined;
|
|
1232
|
+
}[] | undefined;
|
|
1233
|
+
} | null, void, unknown>;
|
|
1234
|
+
}>;
|
|
1235
|
+
/**
|
|
1236
|
+
* {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_version&apiName=list&version=v6 click to debug }
|
|
1237
|
+
*
|
|
1238
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=application&resource=application.app_version&version=v6 document }
|
|
1239
|
+
*
|
|
1240
|
+
* 获取应用版本列表
|
|
1241
|
+
*/
|
|
1242
|
+
list: (payload?: {
|
|
1243
|
+
params: {
|
|
1244
|
+
lang: "zh_cn" | "en_us" | "ja_jp";
|
|
1245
|
+
page_size?: number;
|
|
1246
|
+
page_token?: string;
|
|
1247
|
+
order?: number;
|
|
1248
|
+
user_id_type?: "user_id" | "union_id" | "open_id";
|
|
1249
|
+
};
|
|
1250
|
+
path: {
|
|
1251
|
+
app_id: string;
|
|
1252
|
+
};
|
|
1253
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
1254
|
+
code?: number | undefined;
|
|
1255
|
+
msg?: string | undefined;
|
|
1256
|
+
data?: {
|
|
1257
|
+
items?: {
|
|
1258
|
+
app_id: string;
|
|
1259
|
+
version?: string | undefined;
|
|
1260
|
+
version_id: string;
|
|
1261
|
+
app_name?: string | undefined;
|
|
1262
|
+
avatar_url?: string | undefined;
|
|
1263
|
+
description?: string | undefined;
|
|
1264
|
+
scopes?: {
|
|
1265
|
+
scope: string;
|
|
1266
|
+
description?: string | undefined;
|
|
1267
|
+
level?: number | undefined;
|
|
1268
|
+
}[] | undefined;
|
|
1269
|
+
back_home_url?: string | undefined;
|
|
1270
|
+
i18n?: {
|
|
1271
|
+
i18n_key: "zh_cn" | "en_us" | "ja_jp";
|
|
1272
|
+
name?: string | undefined;
|
|
1273
|
+
description?: string | undefined;
|
|
1274
|
+
help_use?: string | undefined;
|
|
1275
|
+
}[] | undefined;
|
|
1276
|
+
common_categories?: string[] | undefined;
|
|
1277
|
+
events?: string[] | undefined;
|
|
1278
|
+
status?: number | undefined;
|
|
1279
|
+
create_time?: string | undefined;
|
|
1280
|
+
publish_time?: string | undefined;
|
|
1281
|
+
ability?: {
|
|
1282
|
+
gadget?: {
|
|
1283
|
+
enable_pc_mode?: number | undefined;
|
|
1284
|
+
schema_urls?: string[] | undefined;
|
|
1285
|
+
pc_use_mobile_pkg?: boolean | undefined;
|
|
1286
|
+
pc_version?: string | undefined;
|
|
1287
|
+
mobile_version?: string | undefined;
|
|
1288
|
+
mobile_min_lark_version?: string | undefined;
|
|
1289
|
+
pc_min_lark_version?: string | undefined;
|
|
1290
|
+
} | undefined;
|
|
1291
|
+
web_app?: {
|
|
1292
|
+
pc_url?: string | undefined;
|
|
1293
|
+
mobile_url?: string | undefined;
|
|
1294
|
+
} | undefined;
|
|
1295
|
+
bot?: {
|
|
1296
|
+
card_request_url?: string | undefined;
|
|
1297
|
+
} | undefined;
|
|
1298
|
+
workplace_widgets?: {
|
|
1299
|
+
min_lark_version?: string | undefined;
|
|
1300
|
+
}[] | undefined;
|
|
1301
|
+
navigate?: {
|
|
1302
|
+
pc?: {
|
|
1303
|
+
version?: string | undefined;
|
|
1304
|
+
image_url?: string | undefined;
|
|
1305
|
+
hover_image_url?: string | undefined;
|
|
1306
|
+
} | undefined;
|
|
1307
|
+
mobile?: {
|
|
1308
|
+
version?: string | undefined;
|
|
1309
|
+
image_url?: string | undefined;
|
|
1310
|
+
hover_image_url?: string | undefined;
|
|
1311
|
+
} | undefined;
|
|
1312
|
+
} | undefined;
|
|
1313
|
+
cloud_doc?: {
|
|
1314
|
+
space_url?: string | undefined;
|
|
1315
|
+
i18n?: {
|
|
1316
|
+
i18n_key: "zh_cn" | "en_us" | "ja_jp";
|
|
1317
|
+
name?: string | undefined;
|
|
1318
|
+
read_description?: string | undefined;
|
|
1319
|
+
write_description?: string | undefined;
|
|
1320
|
+
}[] | undefined;
|
|
1321
|
+
icon_url?: string | undefined;
|
|
1322
|
+
mode?: number | undefined;
|
|
1323
|
+
} | undefined;
|
|
1324
|
+
docs_blocks?: {
|
|
1325
|
+
block_type_id?: string | undefined;
|
|
1326
|
+
i18n?: {
|
|
1327
|
+
i18n_key?: "zh_cn" | "en_us" | "ja_jp" | undefined;
|
|
1328
|
+
name?: string | undefined;
|
|
1329
|
+
}[] | undefined;
|
|
1330
|
+
mobile_icon_url?: string | undefined;
|
|
1331
|
+
pc_icon_url?: string | undefined;
|
|
1332
|
+
}[] | undefined;
|
|
1333
|
+
message_action?: {
|
|
1334
|
+
pc_app_link?: string | undefined;
|
|
1335
|
+
mobile_app_link?: string | undefined;
|
|
1336
|
+
i18n?: {
|
|
1337
|
+
i18n_key?: "zh_cn" | "en_us" | "ja_jp" | undefined;
|
|
1338
|
+
name?: string | undefined;
|
|
1339
|
+
}[] | undefined;
|
|
1340
|
+
} | undefined;
|
|
1341
|
+
plus_menu?: {
|
|
1342
|
+
pc_app_link?: string | undefined;
|
|
1343
|
+
mobile_app_link?: string | undefined;
|
|
1344
|
+
} | undefined;
|
|
1345
|
+
} | undefined;
|
|
1346
|
+
remark?: {
|
|
1347
|
+
remark?: string | undefined;
|
|
1348
|
+
update_remark?: string | undefined;
|
|
1349
|
+
visibility?: {
|
|
1350
|
+
is_all?: boolean | undefined;
|
|
1351
|
+
visible_list?: {
|
|
1352
|
+
open_ids?: string[] | undefined;
|
|
1353
|
+
department_ids?: string[] | undefined;
|
|
1354
|
+
} | undefined;
|
|
1355
|
+
invisible_list?: {
|
|
1356
|
+
open_ids?: string[] | undefined;
|
|
1357
|
+
department_ids?: string[] | undefined;
|
|
1358
|
+
} | undefined;
|
|
1359
|
+
} | undefined;
|
|
1360
|
+
} | undefined;
|
|
1361
|
+
}[] | undefined;
|
|
1362
|
+
page_token?: string | undefined;
|
|
1363
|
+
has_more?: boolean | undefined;
|
|
1364
|
+
} | undefined;
|
|
1365
|
+
}>;
|
|
1115
1366
|
/**
|
|
1116
1367
|
* {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_version&apiName=patch&version=v6 click to debug }
|
|
1117
1368
|
*
|
|
@@ -1406,7 +1657,7 @@ declare abstract class Client$1 {
|
|
|
1406
1657
|
form: {
|
|
1407
1658
|
form_content: string;
|
|
1408
1659
|
};
|
|
1409
|
-
node_list
|
|
1660
|
+
node_list: Array<{
|
|
1410
1661
|
id: string;
|
|
1411
1662
|
name?: string;
|
|
1412
1663
|
node_type?: "AND" | "OR" | "SEQUENTIAL";
|
|
@@ -1501,6 +1752,38 @@ declare abstract class Client$1 {
|
|
|
1501
1752
|
}>;
|
|
1502
1753
|
} | undefined;
|
|
1503
1754
|
}>;
|
|
1755
|
+
listWithIterator: (payload?: {
|
|
1756
|
+
params?: {
|
|
1757
|
+
page_size?: number;
|
|
1758
|
+
page_token?: string;
|
|
1759
|
+
locale?: string;
|
|
1760
|
+
};
|
|
1761
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
1762
|
+
[Symbol.asyncIterator](): AsyncGenerator<{} | null, void, unknown>;
|
|
1763
|
+
}>;
|
|
1764
|
+
/**
|
|
1765
|
+
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=approval&apiName=list&version=v4 click to debug }
|
|
1766
|
+
*
|
|
1767
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=approval&resource=approval&version=v4 document }
|
|
1768
|
+
*/
|
|
1769
|
+
list: (payload?: {
|
|
1770
|
+
params?: {
|
|
1771
|
+
page_size?: number;
|
|
1772
|
+
page_token?: string;
|
|
1773
|
+
locale?: string;
|
|
1774
|
+
};
|
|
1775
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
1776
|
+
code?: number | undefined;
|
|
1777
|
+
msg?: string | undefined;
|
|
1778
|
+
data?: {
|
|
1779
|
+
items?: {
|
|
1780
|
+
approval_code: string;
|
|
1781
|
+
approval_name?: string | undefined;
|
|
1782
|
+
}[] | undefined;
|
|
1783
|
+
page_token?: string | undefined;
|
|
1784
|
+
has_more: boolean;
|
|
1785
|
+
} | undefined;
|
|
1786
|
+
}>;
|
|
1504
1787
|
/**
|
|
1505
1788
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=approval&apiName=subscribe&version=v4 click to debug }
|
|
1506
1789
|
*
|
|
@@ -1653,7 +1936,7 @@ declare abstract class Client$1 {
|
|
|
1653
1936
|
create: (payload?: {
|
|
1654
1937
|
data: {
|
|
1655
1938
|
approval_code: string;
|
|
1656
|
-
status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELED" | "DELETED" | "HIDDEN";
|
|
1939
|
+
status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELED" | "DELETED" | "HIDDEN" | "TERMINATED";
|
|
1657
1940
|
extra?: string;
|
|
1658
1941
|
instance_id: string;
|
|
1659
1942
|
links: {
|
|
@@ -1699,6 +1982,8 @@ declare abstract class Client$1 {
|
|
|
1699
1982
|
}>;
|
|
1700
1983
|
display_method?: "BROWSER" | "SIDEBAR" | "NORMAL" | "TRUSTEESHIP";
|
|
1701
1984
|
exclude_statistics?: boolean;
|
|
1985
|
+
node_id?: string;
|
|
1986
|
+
node_name?: string;
|
|
1702
1987
|
}>;
|
|
1703
1988
|
cc_list?: Array<{
|
|
1704
1989
|
cc_id: string;
|
|
@@ -1738,7 +2023,7 @@ declare abstract class Client$1 {
|
|
|
1738
2023
|
data?: {
|
|
1739
2024
|
data?: {
|
|
1740
2025
|
approval_code: string;
|
|
1741
|
-
status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELED" | "DELETED" | "HIDDEN";
|
|
2026
|
+
status: "PENDING" | "APPROVED" | "REJECTED" | "CANCELED" | "DELETED" | "HIDDEN" | "TERMINATED";
|
|
1742
2027
|
extra?: string | undefined;
|
|
1743
2028
|
instance_id: string;
|
|
1744
2029
|
links: {
|
|
@@ -1784,6 +2069,8 @@ declare abstract class Client$1 {
|
|
|
1784
2069
|
}[] | undefined;
|
|
1785
2070
|
display_method?: "BROWSER" | "SIDEBAR" | "NORMAL" | "TRUSTEESHIP" | undefined;
|
|
1786
2071
|
exclude_statistics?: boolean | undefined;
|
|
2072
|
+
node_id?: string | undefined;
|
|
2073
|
+
node_name?: string | undefined;
|
|
1787
2074
|
}[] | undefined;
|
|
1788
2075
|
cc_list?: {
|
|
1789
2076
|
cc_id: string;
|
|
@@ -1899,7 +2186,7 @@ declare abstract class Client$1 {
|
|
|
1899
2186
|
/**
|
|
1900
2187
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=add_sign&version=v4 click to debug }
|
|
1901
2188
|
*
|
|
1902
|
-
* {@link https://open.feishu.cn/
|
|
2189
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=add_sign&project=approval&resource=instance&version=v4 document }
|
|
1903
2190
|
*/
|
|
1904
2191
|
addSign: (payload?: {
|
|
1905
2192
|
data: {
|
|
@@ -2015,7 +2302,7 @@ declare abstract class Client$1 {
|
|
|
2015
2302
|
*
|
|
2016
2303
|
* 获取单个审批实例详情
|
|
2017
2304
|
*
|
|
2018
|
-
* 通过审批实例 Instance Code 获取审批实例详情。Instance Code 由 [批量获取审批实例](/
|
|
2305
|
+
* 通过审批实例 Instance Code 获取审批实例详情。Instance Code 由 [批量获取审批实例](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list) 接口获取。
|
|
2019
2306
|
*/
|
|
2020
2307
|
get: (payload?: {
|
|
2021
2308
|
params?: {
|
|
@@ -2134,7 +2421,7 @@ declare abstract class Client$1 {
|
|
|
2134
2421
|
/**
|
|
2135
2422
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=preview&version=v4 click to debug }
|
|
2136
2423
|
*
|
|
2137
|
-
* {@link https://open.feishu.cn/
|
|
2424
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=preview&project=approval&resource=instance&version=v4 document }
|
|
2138
2425
|
*/
|
|
2139
2426
|
preview: (payload?: {
|
|
2140
2427
|
data: {
|
|
@@ -2800,7 +3087,7 @@ declare abstract class Client$1 {
|
|
|
2800
3087
|
*/
|
|
2801
3088
|
attendance: {
|
|
2802
3089
|
/**
|
|
2803
|
-
*
|
|
3090
|
+
* 假勤审批
|
|
2804
3091
|
*/
|
|
2805
3092
|
approvalInfo: {
|
|
2806
3093
|
/**
|
|
@@ -3050,6 +3337,8 @@ declare abstract class Client$1 {
|
|
|
3050
3337
|
remedy_period_custom_date?: number | undefined;
|
|
3051
3338
|
punch_type?: number | undefined;
|
|
3052
3339
|
effect_time?: string | undefined;
|
|
3340
|
+
fixshift_effect_time?: string | undefined;
|
|
3341
|
+
member_effect_time?: string | undefined;
|
|
3053
3342
|
rest_clockIn_need_approval?: boolean | undefined;
|
|
3054
3343
|
clockIn_need_photo?: boolean | undefined;
|
|
3055
3344
|
} | undefined;
|
|
@@ -3166,6 +3455,8 @@ declare abstract class Client$1 {
|
|
|
3166
3455
|
remedy_period_custom_date?: number | undefined;
|
|
3167
3456
|
punch_type?: number | undefined;
|
|
3168
3457
|
effect_time?: string | undefined;
|
|
3458
|
+
fixshift_effect_time?: string | undefined;
|
|
3459
|
+
member_effect_time?: string | undefined;
|
|
3169
3460
|
rest_clockIn_need_approval?: boolean | undefined;
|
|
3170
3461
|
clockIn_need_photo?: boolean | undefined;
|
|
3171
3462
|
} | undefined;
|
|
@@ -3813,7 +4104,7 @@ declare abstract class Client$1 {
|
|
|
3813
4104
|
}>;
|
|
3814
4105
|
};
|
|
3815
4106
|
/**
|
|
3816
|
-
*
|
|
4107
|
+
* 考勤记录
|
|
3817
4108
|
*/
|
|
3818
4109
|
userFlow: {
|
|
3819
4110
|
/**
|
|
@@ -4070,7 +4361,7 @@ declare abstract class Client$1 {
|
|
|
4070
4361
|
}>;
|
|
4071
4362
|
};
|
|
4072
4363
|
/**
|
|
4073
|
-
*
|
|
4364
|
+
* 考勤统计
|
|
4074
4365
|
*/
|
|
4075
4366
|
userStatsField: {
|
|
4076
4367
|
/**
|
|
@@ -4113,7 +4404,7 @@ declare abstract class Client$1 {
|
|
|
4113
4404
|
}>;
|
|
4114
4405
|
};
|
|
4115
4406
|
/**
|
|
4116
|
-
*
|
|
4407
|
+
* 考勤统计
|
|
4117
4408
|
*/
|
|
4118
4409
|
userStatsView: {
|
|
4119
4410
|
/**
|
|
@@ -4313,7 +4604,7 @@ declare abstract class Client$1 {
|
|
|
4313
4604
|
*
|
|
4314
4605
|
* 通知补卡审批发起
|
|
4315
4606
|
*
|
|
4316
|
-
* 对于只使用飞书考勤系统而未使用飞书审批系统的企业,可以通过该接口,将在三方审批系统中发起的补卡审批数据,写入到飞书考勤系统中,状态为审批中。写入后可以由[通知审批状态更新](/
|
|
4607
|
+
* 对于只使用飞书考勤系统而未使用飞书审批系统的企业,可以通过该接口,将在三方审批系统中发起的补卡审批数据,写入到飞书考勤系统中,状态为审批中。写入后可以由[通知审批状态更新](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/approval_info/process) 进行状态更新
|
|
4317
4608
|
*/
|
|
4318
4609
|
create: (payload?: {
|
|
4319
4610
|
data: {
|
|
@@ -4545,6 +4836,9 @@ declare abstract class Client$1 {
|
|
|
4545
4836
|
id: string;
|
|
4546
4837
|
father_id?: string;
|
|
4547
4838
|
}>;
|
|
4839
|
+
images?: Array<{
|
|
4840
|
+
token: string;
|
|
4841
|
+
}>;
|
|
4548
4842
|
};
|
|
4549
4843
|
outer_info?: {
|
|
4550
4844
|
provider: string;
|
|
@@ -4619,8 +4913,10 @@ declare abstract class Client$1 {
|
|
|
4619
4913
|
name?: string | undefined;
|
|
4620
4914
|
father_id?: string | undefined;
|
|
4621
4915
|
}[] | undefined;
|
|
4916
|
+
images?: {
|
|
4917
|
+
token: string;
|
|
4918
|
+
}[] | undefined;
|
|
4622
4919
|
} | undefined;
|
|
4623
|
-
categories?: string[] | undefined;
|
|
4624
4920
|
statistics?: {
|
|
4625
4921
|
like_count: number;
|
|
4626
4922
|
dislike_count: number;
|
|
@@ -4694,6 +4990,9 @@ declare abstract class Client$1 {
|
|
|
4694
4990
|
id: string;
|
|
4695
4991
|
father_id?: string;
|
|
4696
4992
|
}>;
|
|
4993
|
+
images?: Array<{
|
|
4994
|
+
token: string;
|
|
4995
|
+
}>;
|
|
4697
4996
|
};
|
|
4698
4997
|
rich_text?: string;
|
|
4699
4998
|
};
|
|
@@ -4767,8 +5066,10 @@ declare abstract class Client$1 {
|
|
|
4767
5066
|
name?: string | undefined;
|
|
4768
5067
|
father_id?: string | undefined;
|
|
4769
5068
|
}[] | undefined;
|
|
5069
|
+
images?: {
|
|
5070
|
+
token: string;
|
|
5071
|
+
}[] | undefined;
|
|
4770
5072
|
} | undefined;
|
|
4771
|
-
categories?: string[] | undefined;
|
|
4772
5073
|
statistics?: {
|
|
4773
5074
|
like_count: number;
|
|
4774
5075
|
dislike_count: number;
|
|
@@ -4846,6 +5147,9 @@ declare abstract class Client$1 {
|
|
|
4846
5147
|
id: string;
|
|
4847
5148
|
father_id?: string;
|
|
4848
5149
|
}>;
|
|
5150
|
+
images?: Array<{
|
|
5151
|
+
token: string;
|
|
5152
|
+
}>;
|
|
4849
5153
|
};
|
|
4850
5154
|
outer_info?: {
|
|
4851
5155
|
provider: string;
|
|
@@ -4918,8 +5222,10 @@ declare abstract class Client$1 {
|
|
|
4918
5222
|
name?: string | undefined;
|
|
4919
5223
|
father_id?: string | undefined;
|
|
4920
5224
|
}[] | undefined;
|
|
5225
|
+
images?: {
|
|
5226
|
+
token: string;
|
|
5227
|
+
}[] | undefined;
|
|
4921
5228
|
} | undefined;
|
|
4922
|
-
categories?: string[] | undefined;
|
|
4923
5229
|
statistics?: {
|
|
4924
5230
|
like_count: number;
|
|
4925
5231
|
dislike_count: number;
|
|
@@ -5014,8 +5320,10 @@ declare abstract class Client$1 {
|
|
|
5014
5320
|
name?: string | undefined;
|
|
5015
5321
|
father_id?: string | undefined;
|
|
5016
5322
|
}[] | undefined;
|
|
5323
|
+
images?: {
|
|
5324
|
+
token: string;
|
|
5325
|
+
}[] | undefined;
|
|
5017
5326
|
} | undefined;
|
|
5018
|
-
categories?: string[] | undefined;
|
|
5019
5327
|
statistics?: {
|
|
5020
5328
|
like_count: number;
|
|
5021
5329
|
dislike_count: number;
|
|
@@ -5122,8 +5430,10 @@ declare abstract class Client$1 {
|
|
|
5122
5430
|
name?: string | undefined;
|
|
5123
5431
|
father_id?: string | undefined;
|
|
5124
5432
|
}[] | undefined;
|
|
5433
|
+
images?: {
|
|
5434
|
+
token: string;
|
|
5435
|
+
}[] | undefined;
|
|
5125
5436
|
} | undefined;
|
|
5126
|
-
categories?: string[] | undefined;
|
|
5127
5437
|
statistics?: {
|
|
5128
5438
|
like_count: number;
|
|
5129
5439
|
dislike_count: number;
|
|
@@ -5214,8 +5524,10 @@ declare abstract class Client$1 {
|
|
|
5214
5524
|
name?: string | undefined;
|
|
5215
5525
|
father_id?: string | undefined;
|
|
5216
5526
|
}[] | undefined;
|
|
5527
|
+
images?: {
|
|
5528
|
+
token: string;
|
|
5529
|
+
}[] | undefined;
|
|
5217
5530
|
} | undefined;
|
|
5218
|
-
categories?: string[] | undefined;
|
|
5219
5531
|
statistics?: {
|
|
5220
5532
|
like_count: number;
|
|
5221
5533
|
dislike_count: number;
|
|
@@ -5321,8 +5633,10 @@ declare abstract class Client$1 {
|
|
|
5321
5633
|
name?: string | undefined;
|
|
5322
5634
|
father_id?: string | undefined;
|
|
5323
5635
|
}[] | undefined;
|
|
5636
|
+
images?: {
|
|
5637
|
+
token: string;
|
|
5638
|
+
}[] | undefined;
|
|
5324
5639
|
} | undefined;
|
|
5325
|
-
categories?: string[] | undefined;
|
|
5326
5640
|
statistics?: {
|
|
5327
5641
|
like_count: number;
|
|
5328
5642
|
dislike_count: number;
|
|
@@ -5415,8 +5729,10 @@ declare abstract class Client$1 {
|
|
|
5415
5729
|
name?: string | undefined;
|
|
5416
5730
|
father_id?: string | undefined;
|
|
5417
5731
|
}[] | undefined;
|
|
5732
|
+
images?: {
|
|
5733
|
+
token: string;
|
|
5734
|
+
}[] | undefined;
|
|
5418
5735
|
} | undefined;
|
|
5419
|
-
categories?: string[] | undefined;
|
|
5420
5736
|
statistics?: {
|
|
5421
5737
|
like_count: number;
|
|
5422
5738
|
dislike_count: number;
|
|
@@ -5489,6 +5805,9 @@ declare abstract class Client$1 {
|
|
|
5489
5805
|
id: string;
|
|
5490
5806
|
father_id?: string;
|
|
5491
5807
|
}>;
|
|
5808
|
+
images?: Array<{
|
|
5809
|
+
token: string;
|
|
5810
|
+
}>;
|
|
5492
5811
|
};
|
|
5493
5812
|
outer_info?: {
|
|
5494
5813
|
provider: string;
|
|
@@ -5564,8 +5883,10 @@ declare abstract class Client$1 {
|
|
|
5564
5883
|
name?: string | undefined;
|
|
5565
5884
|
father_id?: string | undefined;
|
|
5566
5885
|
}[] | undefined;
|
|
5886
|
+
images?: {
|
|
5887
|
+
token: string;
|
|
5888
|
+
}[] | undefined;
|
|
5567
5889
|
} | undefined;
|
|
5568
|
-
categories?: string[] | undefined;
|
|
5569
5890
|
statistics?: {
|
|
5570
5891
|
like_count: number;
|
|
5571
5892
|
dislike_count: number;
|
|
@@ -5579,9 +5900,39 @@ declare abstract class Client$1 {
|
|
|
5579
5900
|
} | undefined;
|
|
5580
5901
|
}>;
|
|
5581
5902
|
};
|
|
5903
|
+
/**
|
|
5904
|
+
* file
|
|
5905
|
+
*/
|
|
5906
|
+
file: {
|
|
5907
|
+
/**
|
|
5908
|
+
* {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=download&version=v1 click to debug }
|
|
5909
|
+
*
|
|
5910
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=baike&resource=file&version=v1 document }
|
|
5911
|
+
*/
|
|
5912
|
+
download: (payload?: {
|
|
5913
|
+
path?: {
|
|
5914
|
+
file_token?: string;
|
|
5915
|
+
};
|
|
5916
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
5917
|
+
writeFile: (filePath: string) => Promise<void>;
|
|
5918
|
+
}>;
|
|
5919
|
+
/**
|
|
5920
|
+
* {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=upload&version=v1 click to debug }
|
|
5921
|
+
*
|
|
5922
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=upload&project=baike&resource=file&version=v1 document }
|
|
5923
|
+
*/
|
|
5924
|
+
upload: (payload?: {
|
|
5925
|
+
data: {
|
|
5926
|
+
name: string;
|
|
5927
|
+
file: Buffer;
|
|
5928
|
+
};
|
|
5929
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
5930
|
+
file_token?: string | undefined;
|
|
5931
|
+
} | {}>;
|
|
5932
|
+
};
|
|
5582
5933
|
};
|
|
5583
5934
|
/**
|
|
5584
|
-
*
|
|
5935
|
+
* 云文档-电子表格
|
|
5585
5936
|
*/
|
|
5586
5937
|
bitable: {
|
|
5587
5938
|
/**
|
|
@@ -6323,6 +6674,7 @@ declare abstract class Client$1 {
|
|
|
6323
6674
|
location?: {
|
|
6324
6675
|
input_type: "only_mobile" | "not_limit";
|
|
6325
6676
|
} | undefined;
|
|
6677
|
+
formula_expression?: string | undefined;
|
|
6326
6678
|
} | undefined;
|
|
6327
6679
|
description?: {
|
|
6328
6680
|
disable_sync?: boolean | undefined;
|
|
@@ -6364,6 +6716,7 @@ declare abstract class Client$1 {
|
|
|
6364
6716
|
location?: {
|
|
6365
6717
|
input_type: "only_mobile" | "not_limit";
|
|
6366
6718
|
} | undefined;
|
|
6719
|
+
formula_expression?: string | undefined;
|
|
6367
6720
|
} | undefined;
|
|
6368
6721
|
description?: {
|
|
6369
6722
|
disable_sync?: boolean | undefined;
|
|
@@ -6438,6 +6791,7 @@ declare abstract class Client$1 {
|
|
|
6438
6791
|
location?: {
|
|
6439
6792
|
input_type: "only_mobile" | "not_limit";
|
|
6440
6793
|
} | undefined;
|
|
6794
|
+
formula_expression?: string | undefined;
|
|
6441
6795
|
} | undefined;
|
|
6442
6796
|
description?: {
|
|
6443
6797
|
disable_sync?: boolean | undefined;
|
|
@@ -6502,6 +6856,7 @@ declare abstract class Client$1 {
|
|
|
6502
6856
|
location?: {
|
|
6503
6857
|
input_type: "only_mobile" | "not_limit";
|
|
6504
6858
|
} | undefined;
|
|
6859
|
+
formula_expression?: string | undefined;
|
|
6505
6860
|
} | undefined;
|
|
6506
6861
|
description?: {
|
|
6507
6862
|
disable_sync?: boolean | undefined;
|
|
@@ -6548,6 +6903,7 @@ declare abstract class Client$1 {
|
|
|
6548
6903
|
location?: {
|
|
6549
6904
|
input_type: "only_mobile" | "not_limit";
|
|
6550
6905
|
} | undefined;
|
|
6906
|
+
formula_expression?: string | undefined;
|
|
6551
6907
|
} | undefined;
|
|
6552
6908
|
description?: {
|
|
6553
6909
|
disable_sync?: boolean | undefined;
|
|
@@ -6590,6 +6946,7 @@ declare abstract class Client$1 {
|
|
|
6590
6946
|
location?: {
|
|
6591
6947
|
input_type: "only_mobile" | "not_limit";
|
|
6592
6948
|
} | undefined;
|
|
6949
|
+
formula_expression?: string | undefined;
|
|
6593
6950
|
} | undefined;
|
|
6594
6951
|
description?: {
|
|
6595
6952
|
disable_sync?: boolean | undefined;
|
|
@@ -7555,7 +7912,7 @@ declare abstract class Client$1 {
|
|
|
7555
7912
|
*/
|
|
7556
7913
|
block: {
|
|
7557
7914
|
/**
|
|
7558
|
-
*
|
|
7915
|
+
* entity
|
|
7559
7916
|
*/
|
|
7560
7917
|
entity: {
|
|
7561
7918
|
/**
|
|
@@ -7637,7 +7994,7 @@ declare abstract class Client$1 {
|
|
|
7637
7994
|
}>;
|
|
7638
7995
|
};
|
|
7639
7996
|
/**
|
|
7640
|
-
*
|
|
7997
|
+
* message
|
|
7641
7998
|
*/
|
|
7642
7999
|
message: {
|
|
7643
8000
|
/**
|
|
@@ -7645,9 +8002,9 @@ declare abstract class Client$1 {
|
|
|
7645
8002
|
*
|
|
7646
8003
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/block-v2/message/create document }
|
|
7647
8004
|
*
|
|
7648
|
-
* Block
|
|
8005
|
+
* Block消息推送
|
|
7649
8006
|
*
|
|
7650
|
-
* 根据BlockID
|
|
8007
|
+
* 根据BlockID向指定用户列表推送消息。
|
|
7651
8008
|
*/
|
|
7652
8009
|
create: (payload?: {
|
|
7653
8010
|
data: {
|
|
@@ -8339,9 +8696,9 @@ declare abstract class Client$1 {
|
|
|
8339
8696
|
*
|
|
8340
8697
|
* 获取日程参与人列表
|
|
8341
8698
|
*
|
|
8342
|
-
* 获取日程的参与人列表,若参与者列表中有群组,请使用 [获取参与人群成员列表](/
|
|
8699
|
+
* 获取日程的参与人列表,若参与者列表中有群组,请使用 [获取参与人群成员列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list) 。
|
|
8343
8700
|
*
|
|
8344
|
-
* - 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](/
|
|
8701
|
+
* - 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 当前身份必须有权限查看日程的参与人列表。
|
|
8345
8702
|
*/
|
|
8346
8703
|
list: (payload?: {
|
|
8347
8704
|
params?: {
|
|
@@ -8559,6 +8916,7 @@ declare abstract class Client$1 {
|
|
|
8559
8916
|
status?: "tentative" | "confirmed" | "cancelled" | undefined;
|
|
8560
8917
|
is_exception?: boolean | undefined;
|
|
8561
8918
|
recurring_event_id?: string | undefined;
|
|
8919
|
+
create_time?: string | undefined;
|
|
8562
8920
|
schemas?: {
|
|
8563
8921
|
ui_name?: string | undefined;
|
|
8564
8922
|
ui_status?: "unknown" | "hide" | "readonly" | "editable" | undefined;
|
|
@@ -8600,7 +8958,7 @@ declare abstract class Client$1 {
|
|
|
8600
8958
|
*
|
|
8601
8959
|
* 该接口用于以当前身份(应用 / 用户)获取日历上的一个日程。;身份由 Header Authorization 的 Token 类型决定。
|
|
8602
8960
|
*
|
|
8603
|
-
* - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](/
|
|
8961
|
+
* - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;- [例外日程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/introduction#71c5ec78)可通过event_id的非0时间戳后缀,来获取修改的重复性日程的哪一天日程的时间信息。
|
|
8604
8962
|
*/
|
|
8605
8963
|
get: (payload?: {
|
|
8606
8964
|
path: {
|
|
@@ -8649,6 +9007,7 @@ declare abstract class Client$1 {
|
|
|
8649
9007
|
status?: "tentative" | "confirmed" | "cancelled" | undefined;
|
|
8650
9008
|
is_exception?: boolean | undefined;
|
|
8651
9009
|
recurring_event_id?: string | undefined;
|
|
9010
|
+
create_time?: string | undefined;
|
|
8652
9011
|
schemas?: {
|
|
8653
9012
|
ui_name?: string | undefined;
|
|
8654
9013
|
ui_status?: "unknown" | "hide" | "readonly" | "editable" | undefined;
|
|
@@ -8666,7 +9025,7 @@ declare abstract class Client$1 {
|
|
|
8666
9025
|
*
|
|
8667
9026
|
* 该接口用于以当前身份(应用 / 用户)获取日历下的日程列表。;身份由 Header Authorization 的 Token 类型决定。
|
|
8668
9027
|
*
|
|
8669
|
-
* - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](/
|
|
9028
|
+
* - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- 调用时首先使用 page_token 分页拉取存量数据,之后使用 sync_token 增量同步变更数据。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
|
|
8670
9029
|
*/
|
|
8671
9030
|
list: (payload?: {
|
|
8672
9031
|
params?: {
|
|
@@ -8725,6 +9084,7 @@ declare abstract class Client$1 {
|
|
|
8725
9084
|
status?: "tentative" | "confirmed" | "cancelled" | undefined;
|
|
8726
9085
|
is_exception?: boolean | undefined;
|
|
8727
9086
|
recurring_event_id?: string | undefined;
|
|
9087
|
+
create_time?: string | undefined;
|
|
8728
9088
|
schemas?: {
|
|
8729
9089
|
ui_name?: string | undefined;
|
|
8730
9090
|
ui_status?: "unknown" | "hide" | "readonly" | "editable" | undefined;
|
|
@@ -8832,6 +9192,7 @@ declare abstract class Client$1 {
|
|
|
8832
9192
|
status?: "tentative" | "confirmed" | "cancelled" | undefined;
|
|
8833
9193
|
is_exception?: boolean | undefined;
|
|
8834
9194
|
recurring_event_id?: string | undefined;
|
|
9195
|
+
create_time?: string | undefined;
|
|
8835
9196
|
schemas?: {
|
|
8836
9197
|
ui_name?: string | undefined;
|
|
8837
9198
|
ui_status?: "unknown" | "hide" | "readonly" | "editable" | undefined;
|
|
@@ -8925,7 +9286,7 @@ declare abstract class Client$1 {
|
|
|
8925
9286
|
*
|
|
8926
9287
|
* 该接口用于以用户身份搜索某日历下的相关日程。;;身份由 Header Authorization 的 Token 类型决定。
|
|
8927
9288
|
*
|
|
8928
|
-
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](/
|
|
9289
|
+
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。
|
|
8929
9290
|
*/
|
|
8930
9291
|
search: (payload?: {
|
|
8931
9292
|
data: {
|
|
@@ -9015,7 +9376,7 @@ declare abstract class Client$1 {
|
|
|
9015
9376
|
*
|
|
9016
9377
|
* 该接口用于以用户身份订阅指定日历下的日程变更事件。
|
|
9017
9378
|
*
|
|
9018
|
-
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](/
|
|
9379
|
+
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。
|
|
9019
9380
|
*/
|
|
9020
9381
|
subscription: (payload?: {
|
|
9021
9382
|
path: {
|
|
@@ -9035,7 +9396,7 @@ declare abstract class Client$1 {
|
|
|
9035
9396
|
*
|
|
9036
9397
|
* 该接口用于以用户身份取消订阅指定日历下的日程变更事件。
|
|
9037
9398
|
*
|
|
9038
|
-
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](/
|
|
9399
|
+
* 当前身份必须对日历有reader、writer或owner权限(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。
|
|
9039
9400
|
*/
|
|
9040
9401
|
unsubscription: (payload?: {
|
|
9041
9402
|
path: {
|
|
@@ -9333,7 +9694,7 @@ declare abstract class Client$1 {
|
|
|
9333
9694
|
}>;
|
|
9334
9695
|
};
|
|
9335
9696
|
/**
|
|
9336
|
-
*
|
|
9697
|
+
* 部门管理
|
|
9337
9698
|
*/
|
|
9338
9699
|
department: {
|
|
9339
9700
|
childrenWithIterator: (payload?: {
|
|
@@ -9382,7 +9743,7 @@ declare abstract class Client$1 {
|
|
|
9382
9743
|
*
|
|
9383
9744
|
* 获取子部门列表
|
|
9384
9745
|
*
|
|
9385
|
-
* 通过部门ID获取部门的子部门列表。[常见问题答疑](/
|
|
9746
|
+
* 通过部门ID获取部门的子部门列表。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9386
9747
|
*
|
|
9387
9748
|
* - 使用 user_access_token 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,最多1000个部门对该用户可见。;;- 使用 ; tenant_access_token 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0,会检验应用是否有全员通讯录权限,如果是非0 部门ID,则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码,有权限则返回部门下子部门列表(根据fetch_child决定是否递归)。
|
|
9388
9749
|
*/
|
|
@@ -9436,7 +9797,7 @@ declare abstract class Client$1 {
|
|
|
9436
9797
|
*
|
|
9437
9798
|
* 创建部门
|
|
9438
9799
|
*
|
|
9439
|
-
* 该接口用于向通讯录中创建部门。[常见问题答疑](/
|
|
9800
|
+
* 该接口用于向通讯录中创建部门。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9440
9801
|
*
|
|
9441
9802
|
* 只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门,则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。
|
|
9442
9803
|
*/
|
|
@@ -9500,7 +9861,7 @@ declare abstract class Client$1 {
|
|
|
9500
9861
|
*
|
|
9501
9862
|
* 删除部门
|
|
9502
9863
|
*
|
|
9503
|
-
* 该接口用于向通讯录中删除部门。[常见问题答疑](/
|
|
9864
|
+
* 该接口用于向通讯录中删除部门。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9504
9865
|
*
|
|
9505
9866
|
* 应用需要同时拥有待删除部门及其父部门的通讯录授权。应用商店应用无权限调用该接口。
|
|
9506
9867
|
*/
|
|
@@ -9523,7 +9884,7 @@ declare abstract class Client$1 {
|
|
|
9523
9884
|
*
|
|
9524
9885
|
* 获取单个部门信息
|
|
9525
9886
|
*
|
|
9526
|
-
* 该接口用于向通讯录获取单个部门信息。[常见问题答疑](/
|
|
9887
|
+
* 该接口用于向通讯录获取单个部门信息。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9527
9888
|
*
|
|
9528
9889
|
* 使用tenant_access_token时,应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息,则需要拥有全员权限。;使用user_access_token时,用户需要有待查询部门的可见性,如果需要获取根部门信息,则要求员工可见所有人。
|
|
9529
9890
|
*/
|
|
@@ -9607,7 +9968,7 @@ declare abstract class Client$1 {
|
|
|
9607
9968
|
*
|
|
9608
9969
|
* 获取部门信息列表
|
|
9609
9970
|
*
|
|
9610
|
-
* 该接口用于获取当前部门子部门列表。[常见问题答疑](/
|
|
9971
|
+
* 该接口用于获取当前部门子部门列表。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9611
9972
|
*
|
|
9612
9973
|
* - 使用 user_access_token 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,只筛查最多1000个部门的可见性。;;- 使用 ; tenant_access_token 则基于应用的通讯录权限范围进行权限校验与过滤。由于 ; parent_department_id 是非必填参数,填与不填存在<b>两种数据权限校验与返回</b>情况:;<br> <br>1、请求设置了 ; parent_department_id 为A(根部门0),会检验A是否在通讯录权限内,若在( parent_department_id=0 时会校验是否为全员权限),则返回部门下子部门列表(根据fetch_child决定是否递归),否则返回无部门通讯录权限错误码。;<br> <br>2、请求未带 ; parent_department_id 参数,如通讯录范围为全员权限,只返回根部门ID(部门ID为0),否则返回根据通讯录范围配置的部门ID及子部门(根据 ; fetch_child 决定是否递归)。
|
|
9613
9974
|
*/
|
|
@@ -9693,7 +10054,7 @@ declare abstract class Client$1 {
|
|
|
9693
10054
|
*
|
|
9694
10055
|
* 获取父部门信息
|
|
9695
10056
|
*
|
|
9696
|
-
* 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。[常见问题答疑](/
|
|
10057
|
+
* 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9697
10058
|
*
|
|
9698
10059
|
* 使用tenant_access_token时,该接口只返回可见性范围内的父部门信息;;例如:A >>B>>C>>D四级部门,通讯录权限只到B,那么查询D部门的parent,会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息
|
|
9699
10060
|
*/
|
|
@@ -9743,7 +10104,7 @@ declare abstract class Client$1 {
|
|
|
9743
10104
|
*
|
|
9744
10105
|
* 修改部分部门信息
|
|
9745
10106
|
*
|
|
9746
|
-
* 该接口用于更新通讯录中部门的信息中的任一个字段。[常见问题答疑](/
|
|
10107
|
+
* 该接口用于更新通讯录中部门的信息中的任一个字段。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9747
10108
|
*
|
|
9748
10109
|
* 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。
|
|
9749
10110
|
*/
|
|
@@ -9821,7 +10182,7 @@ declare abstract class Client$1 {
|
|
|
9821
10182
|
*
|
|
9822
10183
|
* 搜索部门
|
|
9823
10184
|
*
|
|
9824
|
-
* 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。[常见问题答疑](/
|
|
10185
|
+
* 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9825
10186
|
*
|
|
9826
10187
|
* 部门存在,但用户搜索不到并不一定是搜索有问题,可能是管理员在后台配置了权限控制,导致用户无法搜索到该部门
|
|
9827
10188
|
*/
|
|
@@ -9895,7 +10256,7 @@ declare abstract class Client$1 {
|
|
|
9895
10256
|
*
|
|
9896
10257
|
* 更新部门所有信息
|
|
9897
10258
|
*
|
|
9898
|
-
* 该接口用于更新当前部门所有信息。[常见问题答疑](/
|
|
10259
|
+
* 该接口用于更新当前部门所有信息。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
9899
10260
|
*
|
|
9900
10261
|
* - 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。;; - 没有填写的字段会被置为空值(order字段除外)。
|
|
9901
10262
|
*/
|
|
@@ -10116,7 +10477,7 @@ declare abstract class Client$1 {
|
|
|
10116
10477
|
*
|
|
10117
10478
|
* 创建用户组
|
|
10118
10479
|
*
|
|
10119
|
-
* 使用该接口创建用户组,请注意创建用户组时应用的通讯录权限范围需为“全部员工”,否则会创建失败,[点击了解通讯录权限范围](/
|
|
10480
|
+
* 使用该接口创建用户组,请注意创建用户组时应用的通讯录权限范围需为“全部员工”,否则会创建失败,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10120
10481
|
*/
|
|
10121
10482
|
create: (payload?: {
|
|
10122
10483
|
data: {
|
|
@@ -10139,7 +10500,7 @@ declare abstract class Client$1 {
|
|
|
10139
10500
|
*
|
|
10140
10501
|
* 删除用户组
|
|
10141
10502
|
*
|
|
10142
|
-
* 通过该接口可删除企业中的用户组,请注意删除用户组时应用的通讯录权限范围需为“全部员工”,否则会删除失败,[点击了解通讯录权限范围](/
|
|
10503
|
+
* 通过该接口可删除企业中的用户组,请注意删除用户组时应用的通讯录权限范围需为“全部员工”,否则会删除失败,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10143
10504
|
*/
|
|
10144
10505
|
delete: (payload?: {
|
|
10145
10506
|
path: {
|
|
@@ -10157,7 +10518,7 @@ declare abstract class Client$1 {
|
|
|
10157
10518
|
*
|
|
10158
10519
|
* 查询用户组
|
|
10159
10520
|
*
|
|
10160
|
-
* 根据用户组 ID 查询某个用户组的基本信息,支持查询普通用户组和动态用户组。请确保应用的通讯录权限范围里包括该用户组或者是“全部员工”,[点击了解通讯录权限范围](/
|
|
10521
|
+
* 根据用户组 ID 查询某个用户组的基本信息,支持查询普通用户组和动态用户组。请确保应用的通讯录权限范围里包括该用户组或者是“全部员工”,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10161
10522
|
*/
|
|
10162
10523
|
get: (payload?: {
|
|
10163
10524
|
path: {
|
|
@@ -10183,7 +10544,7 @@ declare abstract class Client$1 {
|
|
|
10183
10544
|
*
|
|
10184
10545
|
* 查询用户所属用户组
|
|
10185
10546
|
*
|
|
10186
|
-
* 通过该接口可查询该用户所属的用户组列表,可分别查询普通用户组和动态用户组。如果应用的通讯录权限范围是“全部员工”,则可获取该员工所属的全部用户组列表。如果应用的通讯录权限范围不是“全部员工”,则仅可获取通讯录权限范围内该员工所属的用户组。[点击了解通讯录权限范围](/
|
|
10547
|
+
* 通过该接口可查询该用户所属的用户组列表,可分别查询普通用户组和动态用户组。如果应用的通讯录权限范围是“全部员工”,则可获取该员工所属的全部用户组列表。如果应用的通讯录权限范围不是“全部员工”,则仅可获取通讯录权限范围内该员工所属的用户组。[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10187
10548
|
*/
|
|
10188
10549
|
memberBelong: (payload?: {
|
|
10189
10550
|
params: {
|
|
@@ -10209,7 +10570,7 @@ declare abstract class Client$1 {
|
|
|
10209
10570
|
*
|
|
10210
10571
|
* 更新用户组
|
|
10211
10572
|
*
|
|
10212
|
-
* 使用该接口更新用户组信息,请注意更新用户组时应用的通讯录权限范围需为“全部员工”,否则会更新失败。[点击了解通讯录权限范围](/
|
|
10573
|
+
* 使用该接口更新用户组信息,请注意更新用户组时应用的通讯录权限范围需为“全部员工”,否则会更新失败。[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10213
10574
|
*/
|
|
10214
10575
|
patch: (payload?: {
|
|
10215
10576
|
data?: {
|
|
@@ -10240,7 +10601,7 @@ declare abstract class Client$1 {
|
|
|
10240
10601
|
*
|
|
10241
10602
|
* 查询用户组列表
|
|
10242
10603
|
*
|
|
10243
|
-
* 通过该接口可查询企业的用户组列表,可分别查询普通用户组或动态用户组。如果应用的通讯录权限范围是“全部员工”,则可获取企业全部用户组列表。如果应用的通讯录权限范围不是“全部员工”,则仅可获取通讯录权限范围内的用户组。[点击了解通讯录权限范围](/
|
|
10604
|
+
* 通过该接口可查询企业的用户组列表,可分别查询普通用户组或动态用户组。如果应用的通讯录权限范围是“全部员工”,则可获取企业全部用户组列表。如果应用的通讯录权限范围不是“全部员工”,则仅可获取通讯录权限范围内的用户组。[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10244
10605
|
*/
|
|
10245
10606
|
simplelist: (payload?: {
|
|
10246
10607
|
params?: {
|
|
@@ -10275,7 +10636,7 @@ declare abstract class Client$1 {
|
|
|
10275
10636
|
*
|
|
10276
10637
|
* 添加用户组成员
|
|
10277
10638
|
*
|
|
10278
|
-
* 向用户组中添加成员(目前成员仅支持用户,未来会支持部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员添加到通讯录权限范围的用户组中,[点击了解通讯录权限范围](/
|
|
10639
|
+
* 向用户组中添加成员(目前成员仅支持用户,未来会支持部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员添加到通讯录权限范围的用户组中,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10279
10640
|
*/
|
|
10280
10641
|
add: (payload?: {
|
|
10281
10642
|
data: {
|
|
@@ -10298,7 +10659,7 @@ declare abstract class Client$1 {
|
|
|
10298
10659
|
*
|
|
10299
10660
|
* 批量添加用户组成员
|
|
10300
10661
|
*
|
|
10301
|
-
* 向普通用户组中批量添加成员(目前仅支持添加用户,暂不支持添加部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员添加到通讯录权限范围的用户组中,[点击了解通讯录权限范围](/
|
|
10662
|
+
* 向普通用户组中批量添加成员(目前仅支持添加用户,暂不支持添加部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员添加到通讯录权限范围的用户组中,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10302
10663
|
*
|
|
10303
10664
|
* 请求体中的member_type,目前仅支持user, 未来将支持department。
|
|
10304
10665
|
*/
|
|
@@ -10330,7 +10691,7 @@ declare abstract class Client$1 {
|
|
|
10330
10691
|
*
|
|
10331
10692
|
* 批量移除用户组成员
|
|
10332
10693
|
*
|
|
10333
|
-
* 从普通用户组中批量移除成员 (目前仅支持移除用户,暂不支持移除部门)。如果应用的通讯录权限范围是“全部员工”,则可将任何成员移出任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员从通讯录权限范围的用户组中移除, [点击了解通讯录权限范围](/
|
|
10694
|
+
* 从普通用户组中批量移除成员 (目前仅支持移除用户,暂不支持移除部门)。如果应用的通讯录权限范围是“全部员工”,则可将任何成员移出任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员从通讯录权限范围的用户组中移除, [点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10334
10695
|
*
|
|
10335
10696
|
* 请求体中的member_type,目前仅支持user, 未来将支持department。
|
|
10336
10697
|
*/
|
|
@@ -10357,7 +10718,7 @@ declare abstract class Client$1 {
|
|
|
10357
10718
|
*
|
|
10358
10719
|
* 移除用户组成员
|
|
10359
10720
|
*
|
|
10360
|
-
* 从用户组中移除成员 (目前成员仅支持用户,未来会支持部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员移出任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员从通讯录权限范围的用户组中移除, [点击了解通讯录权限范围](/
|
|
10721
|
+
* 从用户组中移除成员 (目前成员仅支持用户,未来会支持部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员移出任何用户组。如果应用的通讯录权限范围不是“全部员工”,则仅可将通讯录权限范围中的成员从通讯录权限范围的用户组中移除, [点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10361
10722
|
*/
|
|
10362
10723
|
remove: (payload?: {
|
|
10363
10724
|
data: {
|
|
@@ -10380,7 +10741,7 @@ declare abstract class Client$1 {
|
|
|
10380
10741
|
*
|
|
10381
10742
|
* 查询用户组成员列表
|
|
10382
10743
|
*
|
|
10383
|
-
* 通过该接口可查询某个用户组的成员列表(支持查询成员中的用户和部门), 本接口支持普通用户组和动态用户组。如果应用的通讯录权限范围是“全部员工”,则可查询企业内任何用户组的成员列表。如果应用的通讯录权限范围不是“全部员工”,则仅可查询通讯录权限范围中的用户组的成员列表,[点击了解通讯录权限范围](/
|
|
10744
|
+
* 通过该接口可查询某个用户组的成员列表(支持查询成员中的用户和部门), 本接口支持普通用户组和动态用户组。如果应用的通讯录权限范围是“全部员工”,则可查询企业内任何用户组的成员列表。如果应用的通讯录权限范围不是“全部员工”,则仅可查询通讯录权限范围中的用户组的成员列表,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
10384
10745
|
*/
|
|
10385
10746
|
simplelist: (payload?: {
|
|
10386
10747
|
params?: {
|
|
@@ -10678,7 +11039,7 @@ declare abstract class Client$1 {
|
|
|
10678
11039
|
*
|
|
10679
11040
|
* 创建用户
|
|
10680
11041
|
*
|
|
10681
|
-
* 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](/
|
|
11042
|
+
* 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
10682
11043
|
*
|
|
10683
11044
|
* - 新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户,如果想要在根部门下新增用户,必须要有全员权限。;- 应用商店应用无权限调用此接口。;- 创建用户后,会给用户发送邀请短信/邮件,用户在操作同意后才可访问团队。;- 返回数据中不返回手机号,如果需要请重新查询用户信息获取手机号。
|
|
10684
11045
|
*/
|
|
@@ -10834,7 +11195,7 @@ declare abstract class Client$1 {
|
|
|
10834
11195
|
*
|
|
10835
11196
|
* 删除用户
|
|
10836
11197
|
*
|
|
10837
|
-
* 该接口向通讯录删除一个用户信息,可以理解为员工离职。[常见问题答疑](/
|
|
11198
|
+
* 该接口向通讯录删除一个用户信息,可以理解为员工离职。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
10838
11199
|
*
|
|
10839
11200
|
* 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。应用商店应用无权限调用接口。用户可以在删除员工时设置删除员工数据的接收者,如果不设置则由其leader接收,如果该员工没有leader,则会将该员工的数据删除。
|
|
10840
11201
|
*/
|
|
@@ -10960,7 +11321,7 @@ declare abstract class Client$1 {
|
|
|
10960
11321
|
*
|
|
10961
11322
|
* 获取部门直属用户列表
|
|
10962
11323
|
*
|
|
10963
|
-
* 基于部门ID获取部门直属用户列表。;[常见问题答疑](/
|
|
11324
|
+
* 基于部门ID获取部门直属用户列表。;[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN).
|
|
10964
11325
|
*
|
|
10965
11326
|
* - 使用 user_access_token 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;- 使用tenant_access_token,会根据应用通讯录的范围进行权限过滤。 如果请求的部门ID为0,则校验应用是否具有全员通讯录权限; 如果是非0的部门ID,则会验证应用是否具有该部门的通讯录权限。 无权限返回无权限错误码,有权限则返回对应部门下的直接用户列表。
|
|
10966
11327
|
*/
|
|
@@ -11064,7 +11425,7 @@ declare abstract class Client$1 {
|
|
|
11064
11425
|
*
|
|
11065
11426
|
* 获取单个用户信息
|
|
11066
11427
|
*
|
|
11067
|
-
* 该接口用于获取通讯录中[单个用户的信息](/
|
|
11428
|
+
* 该接口用于获取通讯录中[单个用户的信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/field-overview)。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
11068
11429
|
*/
|
|
11069
11430
|
get: (payload?: {
|
|
11070
11431
|
params?: {
|
|
@@ -11235,7 +11596,7 @@ declare abstract class Client$1 {
|
|
|
11235
11596
|
*
|
|
11236
11597
|
* 获取用户列表
|
|
11237
11598
|
*
|
|
11238
|
-
* 基于部门ID获取部门下直属用户列表。;[常见问题答疑](/
|
|
11599
|
+
* 基于部门ID获取部门下直属用户列表。;[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
11239
11600
|
*
|
|
11240
11601
|
* - 使用 user_access_token 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;- tenant_access_token 基于应用通讯录范围进行权限鉴定。由于 department_id 是非必填参数,填与不填存在<b>两种数据权限校验与返回</b>情况:<br>1、请求设置了 department_id ;(根部门为0),会检验所带部门ID是否具有通讯录权限(如果带上 ; department_id=0 会校验是否有全员权限),有则返回部门下直属的成员列表, 否则提示无部门权限的错误码返回。<br>2、请求未带 ; department_id 参数,则会返回权限范围内的独立用户(权限范围直接包含了某用户,则该用户视为权限范围内的独立用户)。
|
|
11241
11602
|
*/
|
|
@@ -11330,7 +11691,7 @@ declare abstract class Client$1 {
|
|
|
11330
11691
|
*
|
|
11331
11692
|
* 修改用户部分信息
|
|
11332
11693
|
*
|
|
11333
|
-
* 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。[常见问题答疑](/
|
|
11694
|
+
* 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
11334
11695
|
*/
|
|
11335
11696
|
patch: (payload?: {
|
|
11336
11697
|
data?: {
|
|
@@ -11481,7 +11842,7 @@ declare abstract class Client$1 {
|
|
|
11481
11842
|
*
|
|
11482
11843
|
* 更新用户所有信息
|
|
11483
11844
|
*
|
|
11484
|
-
* 该接口用于更新通讯录中用户的字段。[常见问题答疑](/
|
|
11845
|
+
* 该接口用于更新通讯录中用户的字段。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
|
|
11485
11846
|
*
|
|
11486
11847
|
* ;应用需要拥有待更新用户的通讯录授权,如果涉及到用户部门变更,还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。
|
|
11487
11848
|
*/
|
|
@@ -17745,7 +18106,7 @@ declare abstract class Client$1 {
|
|
|
17745
18106
|
}>;
|
|
17746
18107
|
};
|
|
17747
18108
|
/**
|
|
17748
|
-
*
|
|
18109
|
+
* 块
|
|
17749
18110
|
*/
|
|
17750
18111
|
documentBlockChildren: {
|
|
17751
18112
|
/**
|
|
@@ -22189,9 +22550,10 @@ declare abstract class Client$1 {
|
|
|
22189
22550
|
*/
|
|
22190
22551
|
create: (payload?: {
|
|
22191
22552
|
data: {
|
|
22192
|
-
file_extension: "docx" | "pdf" | "xlsx";
|
|
22553
|
+
file_extension: "docx" | "pdf" | "xlsx" | "csv";
|
|
22193
22554
|
token: string;
|
|
22194
22555
|
type: "doc" | "sheet" | "bitable" | "docx";
|
|
22556
|
+
sub_id?: string;
|
|
22195
22557
|
};
|
|
22196
22558
|
}, options?: IRequestOptions$1) => Promise<{
|
|
22197
22559
|
code?: number | undefined;
|
|
@@ -22237,7 +22599,7 @@ declare abstract class Client$1 {
|
|
|
22237
22599
|
msg?: string | undefined;
|
|
22238
22600
|
data?: {
|
|
22239
22601
|
result?: {
|
|
22240
|
-
file_extension: "docx" | "pdf" | "xlsx";
|
|
22602
|
+
file_extension: "docx" | "pdf" | "xlsx" | "csv";
|
|
22241
22603
|
type: "doc" | "sheet" | "bitable" | "docx";
|
|
22242
22604
|
file_name?: string | undefined;
|
|
22243
22605
|
file_token?: string | undefined;
|
|
@@ -22702,7 +23064,7 @@ declare abstract class Client$1 {
|
|
|
22702
23064
|
*
|
|
22703
23065
|
* 删除用户在云空间内的文件或者文件夹。文件或者文件夹被删除后,会进入用户回收站里。
|
|
22704
23066
|
*
|
|
22705
|
-
* 该接口不支持并发调用,且调用频率上限为5QPS。删除文件夹会异步执行并返回一个task_id,可以使用[task_check](/
|
|
23067
|
+
* 该接口不支持并发调用,且调用频率上限为5QPS。删除文件夹会异步执行并返回一个task_id,可以使用[task_check](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check)接口查询任务执行状态。
|
|
22706
23068
|
*
|
|
22707
23069
|
* 要删除文件需要确保应用具有下述两种权限之一:;1. 该应用是文件所有者并且具有该文件所在父文件夹的编辑权限。;2. 该应用并非文件所有者,但是是该文件所在父文件夹的所有者或者拥有该父文件夹的所有权限(full access)。
|
|
22708
23070
|
*/
|
|
@@ -22824,7 +23186,7 @@ declare abstract class Client$1 {
|
|
|
22824
23186
|
*
|
|
22825
23187
|
* 订阅云文档事件
|
|
22826
23188
|
*
|
|
22827
|
-
*
|
|
23189
|
+
* 该接口**仅支持文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a),事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
|
|
22828
23190
|
*/
|
|
22829
23191
|
subscribe: (payload?: {
|
|
22830
23192
|
params: {
|
|
@@ -22869,7 +23231,7 @@ declare abstract class Client$1 {
|
|
|
22869
23231
|
*
|
|
22870
23232
|
* 该接口支持调用频率上限为5QPS
|
|
22871
23233
|
*
|
|
22872
|
-
* 请不要使用这个接口上传大于20MB的文件,如果有这个需求可以尝试使用[分片上传接口](/
|
|
23234
|
+
* 请不要使用这个接口上传大于20MB的文件,如果有这个需求可以尝试使用[分片上传接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/multipart-upload-file-/introduction)。
|
|
22873
23235
|
*/
|
|
22874
23236
|
uploadAll: (payload?: {
|
|
22875
23237
|
data: {
|
|
@@ -22957,7 +23319,7 @@ declare abstract class Client$1 {
|
|
|
22957
23319
|
}>;
|
|
22958
23320
|
};
|
|
22959
23321
|
/**
|
|
22960
|
-
*
|
|
23322
|
+
* 文件
|
|
22961
23323
|
*/
|
|
22962
23324
|
fileStatistics: {
|
|
22963
23325
|
/**
|
|
@@ -23100,7 +23462,7 @@ declare abstract class Client$1 {
|
|
|
23100
23462
|
*
|
|
23101
23463
|
* 创建导入任务
|
|
23102
23464
|
*
|
|
23103
|
-
* 创建导入任务。支持导入为 doc、docx、sheet、bitable,参考[导入用户指南](/
|
|
23465
|
+
* 创建导入任务。支持导入为 doc、docx、sheet、bitable,参考[导入用户指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/import-user-guide)
|
|
23104
23466
|
*/
|
|
23105
23467
|
create: (payload?: {
|
|
23106
23468
|
data: {
|
|
@@ -23211,7 +23573,7 @@ declare abstract class Client$1 {
|
|
|
23211
23573
|
*
|
|
23212
23574
|
* 该接口支持调用频率上限为5QPS
|
|
23213
23575
|
*
|
|
23214
|
-
* 请不要使用这个接口上传大于20MB的文件,如果有这个需求可以尝试使用[分片上传接口](/
|
|
23576
|
+
* 请不要使用这个接口上传大于20MB的文件,如果有这个需求可以尝试使用[分片上传接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/multipart-upload-media/introduction)。
|
|
23215
23577
|
*/
|
|
23216
23578
|
uploadAll: (payload?: {
|
|
23217
23579
|
data: {
|
|
@@ -23301,7 +23663,7 @@ declare abstract class Client$1 {
|
|
|
23301
23663
|
}>;
|
|
23302
23664
|
};
|
|
23303
23665
|
/**
|
|
23304
|
-
*
|
|
23666
|
+
* 文件
|
|
23305
23667
|
*/
|
|
23306
23668
|
meta: {
|
|
23307
23669
|
/**
|
|
@@ -23414,7 +23776,7 @@ declare abstract class Client$1 {
|
|
|
23414
23776
|
*
|
|
23415
23777
|
* 该接口用于根据 filetoken 更新文档协作者的权限。
|
|
23416
23778
|
*
|
|
23417
|
-
* 该接口要求文档协作者已存在,如还未对文档协作者授权请先调用[「增加权限」 ](/
|
|
23779
|
+
* 该接口要求文档协作者已存在,如还未对文档协作者授权请先调用[「增加权限」 ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create)接口进行授权。
|
|
23418
23780
|
*/
|
|
23419
23781
|
update: (payload?: {
|
|
23420
23782
|
data: {
|
|
@@ -24072,7 +24434,95 @@ declare abstract class Client$1 {
|
|
|
24072
24434
|
/**
|
|
24073
24435
|
|
|
24074
24436
|
*/
|
|
24075
|
-
gray_test_open_sg: {
|
|
24437
|
+
gray_test_open_sg: {
|
|
24438
|
+
/**
|
|
24439
|
+
* moto
|
|
24440
|
+
*/
|
|
24441
|
+
moto: {
|
|
24442
|
+
/**
|
|
24443
|
+
* {@link https://open.feishu.cn/api-explorer?project=gray_test_open_sg&resource=moto&apiName=create&version=v1 click to debug }
|
|
24444
|
+
*
|
|
24445
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=gray_test_open_sg&resource=moto&version=v1 document }
|
|
24446
|
+
*/
|
|
24447
|
+
create: (payload?: {
|
|
24448
|
+
data?: {
|
|
24449
|
+
level?: string;
|
|
24450
|
+
body?: string;
|
|
24451
|
+
type?: string;
|
|
24452
|
+
};
|
|
24453
|
+
params?: {
|
|
24454
|
+
department_id_type?: string;
|
|
24455
|
+
user_id_type?: string;
|
|
24456
|
+
};
|
|
24457
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
24458
|
+
code?: number | undefined;
|
|
24459
|
+
msg?: string | undefined;
|
|
24460
|
+
data?: {
|
|
24461
|
+
moto?: {
|
|
24462
|
+
moto_id?: string | undefined;
|
|
24463
|
+
id?: string | undefined;
|
|
24464
|
+
user_name?: string | undefined;
|
|
24465
|
+
type?: string | undefined;
|
|
24466
|
+
} | undefined;
|
|
24467
|
+
} | undefined;
|
|
24468
|
+
}>;
|
|
24469
|
+
/**
|
|
24470
|
+
* {@link https://open.feishu.cn/api-explorer?project=gray_test_open_sg&resource=moto&apiName=get&version=v1 click to debug }
|
|
24471
|
+
*
|
|
24472
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=gray_test_open_sg&resource=moto&version=v1 document }
|
|
24473
|
+
*/
|
|
24474
|
+
get: (payload?: {
|
|
24475
|
+
params?: {
|
|
24476
|
+
body_level?: string;
|
|
24477
|
+
};
|
|
24478
|
+
path?: {
|
|
24479
|
+
moto_id?: string;
|
|
24480
|
+
};
|
|
24481
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
24482
|
+
code?: number | undefined;
|
|
24483
|
+
msg?: string | undefined;
|
|
24484
|
+
data?: {
|
|
24485
|
+
moto?: {
|
|
24486
|
+
moto_id?: string | undefined;
|
|
24487
|
+
id?: string | undefined;
|
|
24488
|
+
user_name?: string | undefined;
|
|
24489
|
+
type?: string | undefined;
|
|
24490
|
+
} | undefined;
|
|
24491
|
+
} | undefined;
|
|
24492
|
+
}>;
|
|
24493
|
+
listWithIterator: (payload?: {
|
|
24494
|
+
params?: {
|
|
24495
|
+
page_size?: number;
|
|
24496
|
+
page_token?: string;
|
|
24497
|
+
level?: number;
|
|
24498
|
+
};
|
|
24499
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
24500
|
+
[Symbol.asyncIterator](): AsyncGenerator<{
|
|
24501
|
+
items?: string[] | undefined;
|
|
24502
|
+
} | null, void, unknown>;
|
|
24503
|
+
}>;
|
|
24504
|
+
/**
|
|
24505
|
+
* {@link https://open.feishu.cn/api-explorer?project=gray_test_open_sg&resource=moto&apiName=list&version=v1 click to debug }
|
|
24506
|
+
*
|
|
24507
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=gray_test_open_sg&resource=moto&version=v1 document }
|
|
24508
|
+
*/
|
|
24509
|
+
list: (payload?: {
|
|
24510
|
+
params?: {
|
|
24511
|
+
page_size?: number;
|
|
24512
|
+
page_token?: string;
|
|
24513
|
+
level?: number;
|
|
24514
|
+
};
|
|
24515
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
24516
|
+
code?: number | undefined;
|
|
24517
|
+
msg?: string | undefined;
|
|
24518
|
+
data?: {
|
|
24519
|
+
items?: string[] | undefined;
|
|
24520
|
+
page_token?: string | undefined;
|
|
24521
|
+
has_more?: boolean | undefined;
|
|
24522
|
+
} | undefined;
|
|
24523
|
+
}>;
|
|
24524
|
+
};
|
|
24525
|
+
};
|
|
24076
24526
|
/**
|
|
24077
24527
|
* 服务台
|
|
24078
24528
|
*/
|
|
@@ -24211,7 +24661,7 @@ declare abstract class Client$1 {
|
|
|
24211
24661
|
}>;
|
|
24212
24662
|
};
|
|
24213
24663
|
/**
|
|
24214
|
-
*
|
|
24664
|
+
* 客服工作日程
|
|
24215
24665
|
*/
|
|
24216
24666
|
agentSchedule: {
|
|
24217
24667
|
/**
|
|
@@ -26068,7 +26518,7 @@ declare abstract class Client$1 {
|
|
|
26068
26518
|
/**
|
|
26069
26519
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=create&version=v1 click to debug }
|
|
26070
26520
|
*
|
|
26071
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26521
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/create document }
|
|
26072
26522
|
*
|
|
26073
26523
|
* 创建投递
|
|
26074
26524
|
*
|
|
@@ -26091,7 +26541,7 @@ declare abstract class Client$1 {
|
|
|
26091
26541
|
/**
|
|
26092
26542
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=get&version=v1 click to debug }
|
|
26093
26543
|
*
|
|
26094
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26544
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get document }
|
|
26095
26545
|
*
|
|
26096
26546
|
* 获取投递信息
|
|
26097
26547
|
*
|
|
@@ -26164,7 +26614,7 @@ declare abstract class Client$1 {
|
|
|
26164
26614
|
/**
|
|
26165
26615
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=list&version=v1 click to debug }
|
|
26166
26616
|
*
|
|
26167
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26617
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list document }
|
|
26168
26618
|
*
|
|
26169
26619
|
* 获取投递列表
|
|
26170
26620
|
*
|
|
@@ -26194,7 +26644,7 @@ declare abstract class Client$1 {
|
|
|
26194
26644
|
/**
|
|
26195
26645
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=offer&version=v1 click to debug }
|
|
26196
26646
|
*
|
|
26197
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26647
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/offer document }
|
|
26198
26648
|
*
|
|
26199
26649
|
* 获取 Offer 信息
|
|
26200
26650
|
*
|
|
@@ -26335,7 +26785,7 @@ declare abstract class Client$1 {
|
|
|
26335
26785
|
/**
|
|
26336
26786
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=terminate&version=v1 click to debug }
|
|
26337
26787
|
*
|
|
26338
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26788
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/terminate document }
|
|
26339
26789
|
*
|
|
26340
26790
|
* 终止投递
|
|
26341
26791
|
*
|
|
@@ -26358,7 +26808,7 @@ declare abstract class Client$1 {
|
|
|
26358
26808
|
/**
|
|
26359
26809
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=transfer_onboard&version=v1 click to debug }
|
|
26360
26810
|
*
|
|
26361
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
26811
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_onboard document }
|
|
26362
26812
|
*
|
|
26363
26813
|
* 操作候选人入职
|
|
26364
26814
|
*
|
|
@@ -26508,6 +26958,9 @@ declare abstract class Client$1 {
|
|
|
26508
26958
|
* 获取招聘系统中附件的元信息,比如文件名、创建时间、文件url等
|
|
26509
26959
|
*/
|
|
26510
26960
|
get: (payload?: {
|
|
26961
|
+
params?: {
|
|
26962
|
+
type?: number;
|
|
26963
|
+
};
|
|
26511
26964
|
path: {
|
|
26512
26965
|
attachment_id: string;
|
|
26513
26966
|
};
|
|
@@ -26682,7 +27135,7 @@ declare abstract class Client$1 {
|
|
|
26682
27135
|
/**
|
|
26683
27136
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=job&apiName=get&version=v1 click to debug }
|
|
26684
27137
|
*
|
|
26685
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/job/get
|
|
27138
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get document }
|
|
26686
27139
|
*
|
|
26687
27140
|
* 获取职位信息
|
|
26688
27141
|
*
|
|
@@ -26820,7 +27273,7 @@ declare abstract class Client$1 {
|
|
|
26820
27273
|
}>;
|
|
26821
27274
|
};
|
|
26822
27275
|
/**
|
|
26823
|
-
*
|
|
27276
|
+
* 职位
|
|
26824
27277
|
*/
|
|
26825
27278
|
jobManager: {
|
|
26826
27279
|
/**
|
|
@@ -26846,8 +27299,8 @@ declare abstract class Client$1 {
|
|
|
26846
27299
|
data?: {
|
|
26847
27300
|
info?: {
|
|
26848
27301
|
id?: string | undefined;
|
|
26849
|
-
recruiter_id
|
|
26850
|
-
hiring_manager_id_list
|
|
27302
|
+
recruiter_id: string;
|
|
27303
|
+
hiring_manager_id_list: Array<string>;
|
|
26851
27304
|
assistant_id_list?: string[] | undefined;
|
|
26852
27305
|
} | undefined;
|
|
26853
27306
|
} | undefined;
|
|
@@ -26860,7 +27313,7 @@ declare abstract class Client$1 {
|
|
|
26860
27313
|
/**
|
|
26861
27314
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=job_process&apiName=list&version=v1 click to debug }
|
|
26862
27315
|
*
|
|
26863
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/
|
|
27316
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list document }
|
|
26864
27317
|
*
|
|
26865
27318
|
* 获取招聘流程信息
|
|
26866
27319
|
*
|
|
@@ -27173,7 +27626,7 @@ declare abstract class Client$1 {
|
|
|
27173
27626
|
/**
|
|
27174
27627
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=talent&apiName=get&version=v1 click to debug }
|
|
27175
27628
|
*
|
|
27176
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
27629
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/get document }
|
|
27177
27630
|
*
|
|
27178
27631
|
* 获取人才信息
|
|
27179
27632
|
*
|
|
@@ -27259,6 +27712,12 @@ declare abstract class Client$1 {
|
|
|
27259
27712
|
} | undefined;
|
|
27260
27713
|
time?: string | undefined;
|
|
27261
27714
|
number?: string | undefined;
|
|
27715
|
+
customized_attachment?: {
|
|
27716
|
+
file_id?: string | undefined;
|
|
27717
|
+
file_name?: string | undefined;
|
|
27718
|
+
content_type?: string | undefined;
|
|
27719
|
+
file_size?: string | undefined;
|
|
27720
|
+
}[] | undefined;
|
|
27262
27721
|
} | undefined;
|
|
27263
27722
|
}[] | undefined;
|
|
27264
27723
|
modify_time?: string | undefined;
|
|
@@ -27302,6 +27761,12 @@ declare abstract class Client$1 {
|
|
|
27302
27761
|
} | undefined;
|
|
27303
27762
|
time?: string | undefined;
|
|
27304
27763
|
number?: string | undefined;
|
|
27764
|
+
customized_attachment?: {
|
|
27765
|
+
file_id?: string | undefined;
|
|
27766
|
+
file_name?: string | undefined;
|
|
27767
|
+
content_type?: string | undefined;
|
|
27768
|
+
file_size?: string | undefined;
|
|
27769
|
+
}[] | undefined;
|
|
27305
27770
|
} | undefined;
|
|
27306
27771
|
}[] | undefined;
|
|
27307
27772
|
}[] | undefined;
|
|
@@ -27343,6 +27808,12 @@ declare abstract class Client$1 {
|
|
|
27343
27808
|
} | undefined;
|
|
27344
27809
|
time?: string | undefined;
|
|
27345
27810
|
number?: string | undefined;
|
|
27811
|
+
customized_attachment?: {
|
|
27812
|
+
file_id?: string | undefined;
|
|
27813
|
+
file_name?: string | undefined;
|
|
27814
|
+
content_type?: string | undefined;
|
|
27815
|
+
file_size?: string | undefined;
|
|
27816
|
+
}[] | undefined;
|
|
27346
27817
|
} | undefined;
|
|
27347
27818
|
}[] | undefined;
|
|
27348
27819
|
}[] | undefined;
|
|
@@ -27383,6 +27854,12 @@ declare abstract class Client$1 {
|
|
|
27383
27854
|
} | undefined;
|
|
27384
27855
|
time?: string | undefined;
|
|
27385
27856
|
number?: string | undefined;
|
|
27857
|
+
customized_attachment?: {
|
|
27858
|
+
file_id?: string | undefined;
|
|
27859
|
+
file_name?: string | undefined;
|
|
27860
|
+
content_type?: string | undefined;
|
|
27861
|
+
file_size?: string | undefined;
|
|
27862
|
+
}[] | undefined;
|
|
27386
27863
|
} | undefined;
|
|
27387
27864
|
}[] | undefined;
|
|
27388
27865
|
}[] | undefined;
|
|
@@ -27420,6 +27897,12 @@ declare abstract class Client$1 {
|
|
|
27420
27897
|
} | undefined;
|
|
27421
27898
|
time?: string | undefined;
|
|
27422
27899
|
number?: string | undefined;
|
|
27900
|
+
customized_attachment?: {
|
|
27901
|
+
file_id?: string | undefined;
|
|
27902
|
+
file_name?: string | undefined;
|
|
27903
|
+
content_type?: string | undefined;
|
|
27904
|
+
file_size?: string | undefined;
|
|
27905
|
+
}[] | undefined;
|
|
27423
27906
|
} | undefined;
|
|
27424
27907
|
}[] | undefined;
|
|
27425
27908
|
}[] | undefined;
|
|
@@ -27457,6 +27940,12 @@ declare abstract class Client$1 {
|
|
|
27457
27940
|
} | undefined;
|
|
27458
27941
|
time?: string | undefined;
|
|
27459
27942
|
number?: string | undefined;
|
|
27943
|
+
customized_attachment?: {
|
|
27944
|
+
file_id?: string | undefined;
|
|
27945
|
+
file_name?: string | undefined;
|
|
27946
|
+
content_type?: string | undefined;
|
|
27947
|
+
file_size?: string | undefined;
|
|
27948
|
+
}[] | undefined;
|
|
27460
27949
|
} | undefined;
|
|
27461
27950
|
}[] | undefined;
|
|
27462
27951
|
}[] | undefined;
|
|
@@ -27493,6 +27982,12 @@ declare abstract class Client$1 {
|
|
|
27493
27982
|
} | undefined;
|
|
27494
27983
|
time?: string | undefined;
|
|
27495
27984
|
number?: string | undefined;
|
|
27985
|
+
customized_attachment?: {
|
|
27986
|
+
file_id?: string | undefined;
|
|
27987
|
+
file_name?: string | undefined;
|
|
27988
|
+
content_type?: string | undefined;
|
|
27989
|
+
file_size?: string | undefined;
|
|
27990
|
+
}[] | undefined;
|
|
27496
27991
|
} | undefined;
|
|
27497
27992
|
}[] | undefined;
|
|
27498
27993
|
}[] | undefined;
|
|
@@ -27529,6 +28024,12 @@ declare abstract class Client$1 {
|
|
|
27529
28024
|
} | undefined;
|
|
27530
28025
|
time?: string | undefined;
|
|
27531
28026
|
number?: string | undefined;
|
|
28027
|
+
customized_attachment?: {
|
|
28028
|
+
file_id?: string | undefined;
|
|
28029
|
+
file_name?: string | undefined;
|
|
28030
|
+
content_type?: string | undefined;
|
|
28031
|
+
file_size?: string | undefined;
|
|
28032
|
+
}[] | undefined;
|
|
27532
28033
|
} | undefined;
|
|
27533
28034
|
}[] | undefined;
|
|
27534
28035
|
}[] | undefined;
|
|
@@ -27578,6 +28079,12 @@ declare abstract class Client$1 {
|
|
|
27578
28079
|
} | undefined;
|
|
27579
28080
|
time?: string | undefined;
|
|
27580
28081
|
number?: string | undefined;
|
|
28082
|
+
customized_attachment?: {
|
|
28083
|
+
file_id?: string | undefined;
|
|
28084
|
+
file_name?: string | undefined;
|
|
28085
|
+
content_type?: string | undefined;
|
|
28086
|
+
file_size?: string | undefined;
|
|
28087
|
+
}[] | undefined;
|
|
27581
28088
|
} | undefined;
|
|
27582
28089
|
}[] | undefined;
|
|
27583
28090
|
}[] | undefined;
|
|
@@ -27642,7 +28149,7 @@ declare abstract class Client$1 {
|
|
|
27642
28149
|
*
|
|
27643
28150
|
* 批量撤回消息
|
|
27644
28151
|
*
|
|
27645
|
-
* 注意事项:;- 只能撤回通过[批量发送消息](/
|
|
28152
|
+
* 注意事项:;- 只能撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息,单条消息的撤回请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 路径参数**batch_message_id**为[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口返回值中的**message_id**字段,用于标识一次批量发送消息请求,格式为:**bm-xxx**;- 一次调用涉及大量消息,所以为异步接口,会有一定延迟。
|
|
27646
28153
|
*/
|
|
27647
28154
|
delete: (payload?: {
|
|
27648
28155
|
path: {
|
|
@@ -27662,7 +28169,7 @@ declare abstract class Client$1 {
|
|
|
27662
28169
|
*
|
|
27663
28170
|
* 查询批量消息整体进度
|
|
27664
28171
|
*
|
|
27665
|
-
* 注意事项:;* 该接口是[查询批量消息推送和阅读人数](/
|
|
28172
|
+
* 注意事项:;* 该接口是[查询批量消息推送和阅读人数](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)接口的加强版;* 该接口返回的数据为查询时刻的快照数据
|
|
27666
28173
|
*/
|
|
27667
28174
|
getProgress: (payload?: {
|
|
27668
28175
|
path: {
|
|
@@ -27692,7 +28199,7 @@ declare abstract class Client$1 {
|
|
|
27692
28199
|
*
|
|
27693
28200
|
* 查询批量消息推送和阅读人数
|
|
27694
28201
|
*
|
|
27695
|
-
* 注意事项:;- 只能查询通过[批量发送消息](/
|
|
28202
|
+
* 注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;- 该接口返回的数据为查询时刻的快照数据。
|
|
27696
28203
|
*/
|
|
27697
28204
|
readUser: (payload?: {
|
|
27698
28205
|
path: {
|
|
@@ -27722,7 +28229,7 @@ declare abstract class Client$1 {
|
|
|
27722
28229
|
*
|
|
27723
28230
|
* 获取会话中的群公告信息,公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
|
27724
28231
|
*
|
|
27725
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
28232
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
|
|
27726
28233
|
*/
|
|
27727
28234
|
get: (payload?: {
|
|
27728
28235
|
params?: {
|
|
@@ -27754,7 +28261,7 @@ declare abstract class Client$1 {
|
|
|
27754
28261
|
*
|
|
27755
28262
|
* 更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
|
27756
28263
|
*
|
|
27757
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
28264
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
|
|
27758
28265
|
*/
|
|
27759
28266
|
patch: (payload?: {
|
|
27760
28267
|
data: {
|
|
@@ -27783,7 +28290,7 @@ declare abstract class Client$1 {
|
|
|
27783
28290
|
*
|
|
27784
28291
|
* 创建群并设置群头像、群名、群描述等。
|
|
27785
28292
|
*
|
|
27786
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28293
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 本接口只支持创建群,如果需要拉用户或者机器人入群参考 [将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口;- 每次请求,最多拉 50 个用户或者 5 个机器人,并且群组最多容纳 15 个机器人; - 拉机器人入群请使用 ==app_id==
|
|
27787
28294
|
*/
|
|
27788
28295
|
create: (payload?: {
|
|
27789
28296
|
data?: {
|
|
@@ -27852,7 +28359,7 @@ declare abstract class Client$1 {
|
|
|
27852
28359
|
*
|
|
27853
28360
|
* 解散群组
|
|
27854
28361
|
*
|
|
27855
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
28362
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token,需要机器人是群的创建者且具备==更新应用所创建群的群信息==权限才可解散群;- 如果使用user_access_token,需要对应的用户是群主才可解散群
|
|
27856
28363
|
*/
|
|
27857
28364
|
delete: (payload?: {
|
|
27858
28365
|
path?: {
|
|
@@ -27872,7 +28379,7 @@ declare abstract class Client$1 {
|
|
|
27872
28379
|
*
|
|
27873
28380
|
* 获取群名称、群描述、群头像、群主 ID 等群基本信息。
|
|
27874
28381
|
*
|
|
27875
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28382
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群里(否则只会返回群名称、群头像等基本信息)
|
|
27876
28383
|
*/
|
|
27877
28384
|
get: (payload?: {
|
|
27878
28385
|
params?: {
|
|
@@ -27914,6 +28421,33 @@ declare abstract class Client$1 {
|
|
|
27914
28421
|
toolkit_ids?: string[] | undefined;
|
|
27915
28422
|
} | undefined;
|
|
27916
28423
|
}>;
|
|
28424
|
+
/**
|
|
28425
|
+
* {@link https://open.feishu.cn/api-explorer?project=im&resource=chat&apiName=link&version=v1 click to debug }
|
|
28426
|
+
*
|
|
28427
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link document }
|
|
28428
|
+
*
|
|
28429
|
+
* 获取群分享链接
|
|
28430
|
+
*
|
|
28431
|
+
* 获取指定群的分享链接
|
|
28432
|
+
*
|
|
28433
|
+
* 注意事项:;- 该接口遵守群分享权限管控;;- 单聊、密聊、团队群不支持分享群链接;;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用
|
|
28434
|
+
*/
|
|
28435
|
+
link: (payload?: {
|
|
28436
|
+
data?: {
|
|
28437
|
+
validity_period?: "week" | "year" | "permanently";
|
|
28438
|
+
};
|
|
28439
|
+
path: {
|
|
28440
|
+
chat_id: string;
|
|
28441
|
+
};
|
|
28442
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
28443
|
+
code?: number | undefined;
|
|
28444
|
+
msg?: string | undefined;
|
|
28445
|
+
data?: {
|
|
28446
|
+
share_link?: string | undefined;
|
|
28447
|
+
expire_time?: string | undefined;
|
|
28448
|
+
is_permanent?: boolean | undefined;
|
|
28449
|
+
} | undefined;
|
|
28450
|
+
}>;
|
|
27917
28451
|
listWithIterator: (payload?: {
|
|
27918
28452
|
params?: {
|
|
27919
28453
|
user_id_type?: "user_id" | "union_id" | "open_id";
|
|
@@ -27944,7 +28478,7 @@ declare abstract class Client$1 {
|
|
|
27944
28478
|
*
|
|
27945
28479
|
* 获取用户或者机器人所在群列表。
|
|
27946
28480
|
*
|
|
27947
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28481
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型,如果是获取机器人所在群列表该值可以不填;- 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL;- 获取的群列表不包含p2p单聊群
|
|
27948
28482
|
*/
|
|
27949
28483
|
list: (payload?: {
|
|
27950
28484
|
params?: {
|
|
@@ -28002,7 +28536,7 @@ declare abstract class Client$1 {
|
|
|
28002
28536
|
*
|
|
28003
28537
|
* 搜索对用户或机器人可见的群列表,包括:用户或机器人所在的群、对用户或机器人公开的群。;搜索可获得的群信息包括:群ID(chat_id)、群名称、群描述等。
|
|
28004
28538
|
*
|
|
28005
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28539
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
|
|
28006
28540
|
*/
|
|
28007
28541
|
search: (payload?: {
|
|
28008
28542
|
params?: {
|
|
@@ -28039,7 +28573,7 @@ declare abstract class Client$1 {
|
|
|
28039
28573
|
*
|
|
28040
28574
|
* 更新群头像、群名称、群描述、群配置、转让群主等。
|
|
28041
28575
|
*
|
|
28042
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
28576
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置:; - 群主/群管理员 或 创建群组且具备==更新应用所创建群的群信息==权限的机器人,可更新所有信息; - 不满足上述条件的群成员或机器人,仅可更新群头像、群名称、群描述、群国际化名称信息 ;- 若群开启了==仅群主和群管理员可编辑群信息==配置:; - 群主/群管理员 或 创建群组且具备==更新应用所创建群的群信息==权限的机器人,可更新所有信息; - 不满足上述条件的群成员或者机器人,任何群信息都不能修改
|
|
28043
28577
|
*/
|
|
28044
28578
|
update: (payload?: {
|
|
28045
28579
|
data?: {
|
|
@@ -28087,7 +28621,7 @@ declare abstract class Client$1 {
|
|
|
28087
28621
|
*
|
|
28088
28622
|
* 将用户或机器人指定为群管理员。
|
|
28089
28623
|
*
|
|
28090
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28624
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 指定机器人类型的管理员请使用 ==app_id==
|
|
28091
28625
|
*/
|
|
28092
28626
|
addManagers: (payload?: {
|
|
28093
28627
|
data?: {
|
|
@@ -28116,7 +28650,7 @@ declare abstract class Client$1 {
|
|
|
28116
28650
|
*
|
|
28117
28651
|
* 删除指定的群管理员(用户或机器人)
|
|
28118
28652
|
*
|
|
28119
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28653
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
|
|
28120
28654
|
*/
|
|
28121
28655
|
deleteManagers: (payload?: {
|
|
28122
28656
|
data?: {
|
|
@@ -28150,7 +28684,7 @@ declare abstract class Client$1 {
|
|
|
28150
28684
|
*
|
|
28151
28685
|
* 将用户或机器人拉入群聊。
|
|
28152
28686
|
*
|
|
28153
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28687
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 如需拉用户进群,需要机器人对用户有可见性; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时,仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时,所有群成员都可以拉用户或机器人进群; - 每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人; - 拉机器人入群请使用 ==app_id==
|
|
28154
28688
|
*/
|
|
28155
28689
|
create: (payload?: {
|
|
28156
28690
|
data?: {
|
|
@@ -28180,7 +28714,7 @@ declare abstract class Client$1 {
|
|
|
28180
28714
|
*
|
|
28181
28715
|
* 将用户或机器人移出群聊。
|
|
28182
28716
|
*
|
|
28183
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28717
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人;- 移除机器人请使用 ==app_id==
|
|
28184
28718
|
*/
|
|
28185
28719
|
delete: (payload?: {
|
|
28186
28720
|
data?: {
|
|
@@ -28228,7 +28762,7 @@ declare abstract class Client$1 {
|
|
|
28228
28762
|
*
|
|
28229
28763
|
* 如果用户在群中,则返回该群的成员列表。
|
|
28230
28764
|
*
|
|
28231
|
-
* 注意事项:; - 应用需要开启[机器人能力](/
|
|
28765
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size
|
|
28232
28766
|
*/
|
|
28233
28767
|
get: (payload?: {
|
|
28234
28768
|
params?: {
|
|
@@ -28283,7 +28817,7 @@ declare abstract class Client$1 {
|
|
|
28283
28817
|
*
|
|
28284
28818
|
* 用户或机器人主动加入群聊。
|
|
28285
28819
|
*
|
|
28286
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
28820
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 目前仅支持加入公开群
|
|
28287
28821
|
*/
|
|
28288
28822
|
meJoin: (payload?: {
|
|
28289
28823
|
path?: {
|
|
@@ -28296,7 +28830,7 @@ declare abstract class Client$1 {
|
|
|
28296
28830
|
}>;
|
|
28297
28831
|
};
|
|
28298
28832
|
/**
|
|
28299
|
-
*
|
|
28833
|
+
* 群组
|
|
28300
28834
|
*/
|
|
28301
28835
|
chatModeration: {
|
|
28302
28836
|
getWithIterator: (payload?: {
|
|
@@ -28568,7 +29102,7 @@ declare abstract class Client$1 {
|
|
|
28568
29102
|
}>;
|
|
28569
29103
|
};
|
|
28570
29104
|
/**
|
|
28571
|
-
*
|
|
29105
|
+
* 群组
|
|
28572
29106
|
*/
|
|
28573
29107
|
chatTopNotice: {
|
|
28574
29108
|
/**
|
|
@@ -28627,7 +29161,7 @@ declare abstract class Client$1 {
|
|
|
28627
29161
|
*
|
|
28628
29162
|
* 上传文件,可以上传视频,音频和常见的文件类型
|
|
28629
29163
|
*
|
|
28630
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29164
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 不允许上传空文件;- 示例代码中需要自行替换文件路径和鉴权Token
|
|
28631
29165
|
*/
|
|
28632
29166
|
create: (payload?: {
|
|
28633
29167
|
data: {
|
|
@@ -28648,7 +29182,7 @@ declare abstract class Client$1 {
|
|
|
28648
29182
|
*
|
|
28649
29183
|
* 下载文件接口,只能下载应用自己上传的文件
|
|
28650
29184
|
*
|
|
28651
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29185
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传的文件;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
|
|
28652
29186
|
*/
|
|
28653
29187
|
get: (payload?: {
|
|
28654
29188
|
path: {
|
|
@@ -28671,7 +29205,7 @@ declare abstract class Client$1 {
|
|
|
28671
29205
|
*
|
|
28672
29206
|
* 上传图片接口,可以上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片
|
|
28673
29207
|
*
|
|
28674
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29208
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 上传的图片大小不能超过10MB
|
|
28675
29209
|
*/
|
|
28676
29210
|
create: (payload?: {
|
|
28677
29211
|
data: {
|
|
@@ -28690,7 +29224,7 @@ declare abstract class Client$1 {
|
|
|
28690
29224
|
*
|
|
28691
29225
|
* 下载图片资源,只能下载应用自己上传且图片类型为message的图片
|
|
28692
29226
|
*
|
|
28693
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29227
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传且图片类型为message的图片,avatar类型暂不支持下载;;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
|
|
28694
29228
|
*/
|
|
28695
29229
|
get: (payload?: {
|
|
28696
29230
|
path: {
|
|
@@ -28701,7 +29235,7 @@ declare abstract class Client$1 {
|
|
|
28701
29235
|
}>;
|
|
28702
29236
|
};
|
|
28703
29237
|
/**
|
|
28704
|
-
*
|
|
29238
|
+
* 加急操作
|
|
28705
29239
|
*/
|
|
28706
29240
|
message: {
|
|
28707
29241
|
/**
|
|
@@ -28711,15 +29245,15 @@ declare abstract class Client$1 {
|
|
|
28711
29245
|
*
|
|
28712
29246
|
* 发送消息
|
|
28713
29247
|
*
|
|
28714
|
-
* 给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](/
|
|
29248
|
+
* 给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
|
|
28715
29249
|
*
|
|
28716
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29250
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 给用户发送消息,需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 给群组发送消息,需要机器人在群中;- 文本消息请求体最大不能超过150KB;- 卡片及富文本消息请求体最大不能超过30KB;- 消息卡片的 `update_multi`(是否为共享卡片)字段在卡片内容的`config`结构体中设置。详细参考文档[配置卡片属性](https://open.feishu.cn/document/ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN)
|
|
28717
29251
|
*/
|
|
28718
29252
|
create: (payload?: {
|
|
28719
29253
|
data: {
|
|
28720
29254
|
receive_id: string;
|
|
28721
|
-
content: string;
|
|
28722
29255
|
msg_type: string;
|
|
29256
|
+
content: string;
|
|
28723
29257
|
uuid?: string;
|
|
28724
29258
|
};
|
|
28725
29259
|
params: {
|
|
@@ -28766,7 +29300,7 @@ declare abstract class Client$1 {
|
|
|
28766
29300
|
*
|
|
28767
29301
|
* 机器人撤回机器人自己发送的消息或群主撤回群内消息。
|
|
28768
29302
|
*
|
|
28769
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29303
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内,自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息,则机器人必须是该群的群主、管理员 或者 创建者,且消息发送时间不超过1年;- 无法撤回通过「批量发送消息接口」发送的消息
|
|
28770
29304
|
*/
|
|
28771
29305
|
delete: (payload?: {
|
|
28772
29306
|
path: {
|
|
@@ -28786,7 +29320,7 @@ declare abstract class Client$1 {
|
|
|
28786
29320
|
*
|
|
28787
29321
|
* 通过 message_id 查询消息内容
|
|
28788
29322
|
*
|
|
28789
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29323
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 机器人必须在群组中
|
|
28790
29324
|
*/
|
|
28791
29325
|
get: (payload?: {
|
|
28792
29326
|
path: {
|
|
@@ -28870,13 +29404,13 @@ declare abstract class Client$1 {
|
|
|
28870
29404
|
/**
|
|
28871
29405
|
* {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=list&version=v1 click to debug }
|
|
28872
29406
|
*
|
|
28873
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
29407
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list document }
|
|
28874
29408
|
*
|
|
28875
29409
|
* 获取会话历史消息
|
|
28876
29410
|
*
|
|
28877
29411
|
* 获取会话(包括单聊、群组)的历史消息(聊天记录)。
|
|
28878
29412
|
*
|
|
28879
|
-
* - 需要开启[机器人能力](/
|
|
29413
|
+
* - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取消息时,机器人必须在群组中
|
|
28880
29414
|
*
|
|
28881
29415
|
* 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 ***获取群组中所有消息*** 权限
|
|
28882
29416
|
*/
|
|
@@ -28934,7 +29468,7 @@ declare abstract class Client$1 {
|
|
|
28934
29468
|
*
|
|
28935
29469
|
* 更新应用已发送的消息卡片内容。
|
|
28936
29470
|
*
|
|
28937
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29471
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 当前仅支持更新 **卡片消息**;- **不支持更新批量消息**;- 只支持对所有人都更新的[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN),也即需要在卡片的`config`属性中,显式声明`"update_multi":true`。<br>如果你只想更新特定人的消息卡片,必须要用户在卡片操作交互后触发,开发文档参考[「独享卡片」](https://open.feishu.cn/document/ukTMukTMukTM/uYjNwUjL2YDM14iN2ATN#49904b71);- 单条消息更新频控为**5QPS**
|
|
28938
29472
|
*/
|
|
28939
29473
|
patch: (payload?: {
|
|
28940
29474
|
data: {
|
|
@@ -28957,7 +29491,7 @@ declare abstract class Client$1 {
|
|
|
28957
29491
|
*
|
|
28958
29492
|
* 查询消息的已读信息。
|
|
28959
29493
|
*
|
|
28960
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29494
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能查询机器人自己发送,且发送时间不超过7天的消息;- 查询消息已读信息时机器人仍需要在会话内;- 本接口不支持查询批量消息
|
|
28961
29495
|
*/
|
|
28962
29496
|
readUsers: (payload?: {
|
|
28963
29497
|
params: {
|
|
@@ -28991,7 +29525,7 @@ declare abstract class Client$1 {
|
|
|
28991
29525
|
*
|
|
28992
29526
|
* 回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
|
|
28993
29527
|
*
|
|
28994
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29528
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 回复私聊消息,需要机器人对用户有可用性;- 回复群组消息,需要机器人在群中
|
|
28995
29529
|
*/
|
|
28996
29530
|
reply: (payload?: {
|
|
28997
29531
|
data: {
|
|
@@ -29043,7 +29577,7 @@ declare abstract class Client$1 {
|
|
|
29043
29577
|
*
|
|
29044
29578
|
* 对指定消息进行应用内加急。
|
|
29045
29579
|
*
|
|
29046
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29580
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
|
|
29047
29581
|
*/
|
|
29048
29582
|
urgentApp: (payload?: {
|
|
29049
29583
|
data: {
|
|
@@ -29071,7 +29605,7 @@ declare abstract class Client$1 {
|
|
|
29071
29605
|
*
|
|
29072
29606
|
* 对指定消息进行应用内加急与电话加急
|
|
29073
29607
|
*
|
|
29074
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29608
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
|
|
29075
29609
|
*
|
|
29076
29610
|
* 特别说明:;- 通过接口产生的电话加急将消耗企业的加急额度,请慎重调用。;- 通过租户管理后台-费用中心-短信/电话加急 可以查看当前额度。;- 默认接口限流为50 QPS,请谨慎调用。
|
|
29077
29611
|
*/
|
|
@@ -29101,7 +29635,7 @@ declare abstract class Client$1 {
|
|
|
29101
29635
|
*
|
|
29102
29636
|
* 对指定消息进行应用内加急与短信加急。
|
|
29103
29637
|
*
|
|
29104
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29638
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
|
|
29105
29639
|
*
|
|
29106
29640
|
* 特别说明:;- 通过接口产生的短信加急将消耗企业的加急额度,请慎重调用。;- 通过租户管理后台-费用中心-短信/电话加急 可以查看当前额度。;- 默认接口限流为50 QPS,请谨慎调用。
|
|
29107
29641
|
*/
|
|
@@ -29136,7 +29670,7 @@ declare abstract class Client$1 {
|
|
|
29136
29670
|
*
|
|
29137
29671
|
* 给指定消息添加指定类型的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
|
29138
29672
|
*
|
|
29139
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29673
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待添加reaction的消息要真实存在,不能被撤回;- 给消息添加reaction,需要reaction的发送方(机器人或者用户)在消息所在的会话内
|
|
29140
29674
|
*/
|
|
29141
29675
|
create: (payload?: {
|
|
29142
29676
|
data: {
|
|
@@ -29171,7 +29705,7 @@ declare abstract class Client$1 {
|
|
|
29171
29705
|
*
|
|
29172
29706
|
* 删除指定消息的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
|
29173
29707
|
*
|
|
29174
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29708
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能删除真实存在的reaction,并且删除reaction请求的操作者必须是reaction的原始添加者
|
|
29175
29709
|
*/
|
|
29176
29710
|
delete: (payload?: {
|
|
29177
29711
|
path: {
|
|
@@ -29215,7 +29749,7 @@ declare abstract class Client$1 {
|
|
|
29215
29749
|
*
|
|
29216
29750
|
* 获取指定消息的特定类型表情回复列表(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
|
29217
29751
|
*
|
|
29218
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29752
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待获取reaction信息的消息要真实存在,不能被撤回;- 获取消息的reaction,需要request的授权主体(机器人或者用户)在消息所在的会话内
|
|
29219
29753
|
*/
|
|
29220
29754
|
list: (payload?: {
|
|
29221
29755
|
params?: {
|
|
@@ -29248,7 +29782,7 @@ declare abstract class Client$1 {
|
|
|
29248
29782
|
}>;
|
|
29249
29783
|
};
|
|
29250
29784
|
/**
|
|
29251
|
-
*
|
|
29785
|
+
* 消息
|
|
29252
29786
|
*/
|
|
29253
29787
|
messageResource: {
|
|
29254
29788
|
/**
|
|
@@ -29260,7 +29794,7 @@ declare abstract class Client$1 {
|
|
|
29260
29794
|
*
|
|
29261
29795
|
* 获取消息中的资源文件,包括音频,视频,图片和文件,**暂不支持表情包资源下载**。当前仅支持 100M 以内的资源文件的下载。
|
|
29262
29796
|
*
|
|
29263
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
29797
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;- 请求的 file_key 和 message_id 需要匹配;- 暂不支持获取合并转发消息中的子消息的资源文件;- 获取群组消息时,应用必须拥有 获取群组中所有的消息 权限
|
|
29264
29798
|
*/
|
|
29265
29799
|
get: (payload?: {
|
|
29266
29800
|
params: {
|
|
@@ -29274,6 +29808,106 @@ declare abstract class Client$1 {
|
|
|
29274
29808
|
writeFile: (filePath: string) => Promise<void>;
|
|
29275
29809
|
}>;
|
|
29276
29810
|
};
|
|
29811
|
+
/**
|
|
29812
|
+
* 消息 - Pin
|
|
29813
|
+
*/
|
|
29814
|
+
pin: {
|
|
29815
|
+
/**
|
|
29816
|
+
* {@link https://open.feishu.cn/api-explorer?project=im&resource=pin&apiName=create&version=v1 click to debug }
|
|
29817
|
+
*
|
|
29818
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create document }
|
|
29819
|
+
*
|
|
29820
|
+
* Pin消息
|
|
29821
|
+
*
|
|
29822
|
+
* Pin一条指定的消息
|
|
29823
|
+
*/
|
|
29824
|
+
create: (payload?: {
|
|
29825
|
+
data: {
|
|
29826
|
+
message_id: string;
|
|
29827
|
+
};
|
|
29828
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
29829
|
+
code?: number | undefined;
|
|
29830
|
+
msg?: string | undefined;
|
|
29831
|
+
data?: {
|
|
29832
|
+
pin?: {
|
|
29833
|
+
message_id: string;
|
|
29834
|
+
chat_id?: string | undefined;
|
|
29835
|
+
operator_id?: string | undefined;
|
|
29836
|
+
operator_id_type?: string | undefined;
|
|
29837
|
+
create_time?: string | undefined;
|
|
29838
|
+
} | undefined;
|
|
29839
|
+
} | undefined;
|
|
29840
|
+
}>;
|
|
29841
|
+
/**
|
|
29842
|
+
* {@link https://open.feishu.cn/api-explorer?project=im&resource=pin&apiName=delete&version=v1 click to debug }
|
|
29843
|
+
*
|
|
29844
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete document }
|
|
29845
|
+
*
|
|
29846
|
+
* 移除Pin消息
|
|
29847
|
+
*
|
|
29848
|
+
* 移除一条指定消息的Pin
|
|
29849
|
+
*/
|
|
29850
|
+
delete: (payload?: {
|
|
29851
|
+
path: {
|
|
29852
|
+
message_id: string;
|
|
29853
|
+
};
|
|
29854
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
29855
|
+
code?: number | undefined;
|
|
29856
|
+
msg?: string | undefined;
|
|
29857
|
+
data?: {} | undefined;
|
|
29858
|
+
}>;
|
|
29859
|
+
listWithIterator: (payload?: {
|
|
29860
|
+
params: {
|
|
29861
|
+
chat_id: string;
|
|
29862
|
+
start_time?: string;
|
|
29863
|
+
end_time?: string;
|
|
29864
|
+
page_size?: number;
|
|
29865
|
+
page_token?: string;
|
|
29866
|
+
};
|
|
29867
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
29868
|
+
[Symbol.asyncIterator](): AsyncGenerator<{
|
|
29869
|
+
items?: {
|
|
29870
|
+
message_id: string;
|
|
29871
|
+
chat_id?: string | undefined;
|
|
29872
|
+
operator_id?: string | undefined;
|
|
29873
|
+
operator_id_type?: string | undefined;
|
|
29874
|
+
create_time?: string | undefined;
|
|
29875
|
+
}[] | undefined;
|
|
29876
|
+
} | null, void, unknown>;
|
|
29877
|
+
}>;
|
|
29878
|
+
/**
|
|
29879
|
+
* {@link https://open.feishu.cn/api-explorer?project=im&resource=pin&apiName=list&version=v1 click to debug }
|
|
29880
|
+
*
|
|
29881
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list document }
|
|
29882
|
+
*
|
|
29883
|
+
* 获取群内Pin消息
|
|
29884
|
+
*
|
|
29885
|
+
* 获取所在群内指定时间范围内的所有Pin消息
|
|
29886
|
+
*/
|
|
29887
|
+
list: (payload?: {
|
|
29888
|
+
params: {
|
|
29889
|
+
chat_id: string;
|
|
29890
|
+
start_time?: string;
|
|
29891
|
+
end_time?: string;
|
|
29892
|
+
page_size?: number;
|
|
29893
|
+
page_token?: string;
|
|
29894
|
+
};
|
|
29895
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
29896
|
+
code?: number | undefined;
|
|
29897
|
+
msg?: string | undefined;
|
|
29898
|
+
data?: {
|
|
29899
|
+
items?: {
|
|
29900
|
+
message_id: string;
|
|
29901
|
+
chat_id?: string | undefined;
|
|
29902
|
+
operator_id?: string | undefined;
|
|
29903
|
+
operator_id_type?: string | undefined;
|
|
29904
|
+
create_time?: string | undefined;
|
|
29905
|
+
}[] | undefined;
|
|
29906
|
+
has_more?: boolean | undefined;
|
|
29907
|
+
page_token?: string | undefined;
|
|
29908
|
+
} | undefined;
|
|
29909
|
+
}>;
|
|
29910
|
+
};
|
|
29277
29911
|
};
|
|
29278
29912
|
/**
|
|
29279
29913
|
* 邮箱
|
|
@@ -29712,7 +30346,8 @@ declare abstract class Client$1 {
|
|
|
29712
30346
|
data?: {
|
|
29713
30347
|
user_id?: string;
|
|
29714
30348
|
department_id?: string;
|
|
29715
|
-
|
|
30349
|
+
email?: string;
|
|
30350
|
+
type?: "USER" | "DEPARTMENT" | "MAIL_GROUP" | "PUBLIC_MAILBOX";
|
|
29716
30351
|
};
|
|
29717
30352
|
params?: {
|
|
29718
30353
|
user_id_type?: "user_id" | "union_id" | "open_id";
|
|
@@ -29728,7 +30363,8 @@ declare abstract class Client$1 {
|
|
|
29728
30363
|
permission_member_id?: string | undefined;
|
|
29729
30364
|
user_id?: string | undefined;
|
|
29730
30365
|
department_id?: string | undefined;
|
|
29731
|
-
|
|
30366
|
+
email?: string | undefined;
|
|
30367
|
+
type?: "DEPARTMENT" | "USER" | "MAIL_GROUP" | "PUBLIC_MAILBOX" | undefined;
|
|
29732
30368
|
} | undefined;
|
|
29733
30369
|
}>;
|
|
29734
30370
|
/**
|
|
@@ -29775,7 +30411,8 @@ declare abstract class Client$1 {
|
|
|
29775
30411
|
permission_member_id?: string | undefined;
|
|
29776
30412
|
user_id?: string | undefined;
|
|
29777
30413
|
department_id?: string | undefined;
|
|
29778
|
-
|
|
30414
|
+
email?: string | undefined;
|
|
30415
|
+
type?: "DEPARTMENT" | "USER" | "MAIL_GROUP" | "PUBLIC_MAILBOX" | undefined;
|
|
29779
30416
|
} | undefined;
|
|
29780
30417
|
}>;
|
|
29781
30418
|
listWithIterator: (payload?: {
|
|
@@ -29794,7 +30431,8 @@ declare abstract class Client$1 {
|
|
|
29794
30431
|
permission_member_id?: string | undefined;
|
|
29795
30432
|
user_id?: string | undefined;
|
|
29796
30433
|
department_id?: string | undefined;
|
|
29797
|
-
|
|
30434
|
+
email?: string | undefined;
|
|
30435
|
+
type?: "DEPARTMENT" | "USER" | "MAIL_GROUP" | "PUBLIC_MAILBOX" | undefined;
|
|
29798
30436
|
}[] | undefined;
|
|
29799
30437
|
} | null, void, unknown>;
|
|
29800
30438
|
}>;
|
|
@@ -29827,7 +30465,8 @@ declare abstract class Client$1 {
|
|
|
29827
30465
|
permission_member_id?: string | undefined;
|
|
29828
30466
|
user_id?: string | undefined;
|
|
29829
30467
|
department_id?: string | undefined;
|
|
29830
|
-
|
|
30468
|
+
email?: string | undefined;
|
|
30469
|
+
type?: "DEPARTMENT" | "USER" | "MAIL_GROUP" | "PUBLIC_MAILBOX" | undefined;
|
|
29831
30470
|
}[] | undefined;
|
|
29832
30471
|
} | undefined;
|
|
29833
30472
|
}>;
|
|
@@ -30416,7 +31055,7 @@ declare abstract class Client$1 {
|
|
|
30416
31055
|
*
|
|
30417
31056
|
* 根据OKR id批量获取OKR
|
|
30418
31057
|
*
|
|
30419
|
-
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="/
|
|
31058
|
+
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN">以应用身份访问OKR信息</md-perm>
|
|
30420
31059
|
*/
|
|
30421
31060
|
batchGet: (payload?: {
|
|
30422
31061
|
params: {
|
|
@@ -30516,7 +31155,7 @@ declare abstract class Client$1 {
|
|
|
30516
31155
|
*
|
|
30517
31156
|
* 获取OKR周期列表
|
|
30518
31157
|
*
|
|
30519
|
-
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="/
|
|
31158
|
+
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN">以应用身份访问OKR信息</md-perm>
|
|
30520
31159
|
*/
|
|
30521
31160
|
list: (payload?: {
|
|
30522
31161
|
params?: {
|
|
@@ -30916,7 +31555,7 @@ declare abstract class Client$1 {
|
|
|
30916
31555
|
*
|
|
30917
31556
|
* 根据用户的id获取OKR列表
|
|
30918
31557
|
*
|
|
30919
|
-
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="/
|
|
31558
|
+
* 使用<md-tag mode="inline" type="token-tenant">tenant_access_token</md-tag>需要额外申请权限<md-perm ;href="https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN">以应用身份访问OKR信息</md-perm>
|
|
30920
31559
|
*/
|
|
30921
31560
|
list: (payload?: {
|
|
30922
31561
|
params: {
|
|
@@ -31733,6 +32372,55 @@ declare abstract class Client$1 {
|
|
|
31733
32372
|
} | undefined;
|
|
31734
32373
|
} | undefined;
|
|
31735
32374
|
}>;
|
|
32375
|
+
/**
|
|
32376
|
+
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet&apiName=get&version=v3 click to debug }
|
|
32377
|
+
*
|
|
32378
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get document }
|
|
32379
|
+
*
|
|
32380
|
+
* 获取电子表格信息
|
|
32381
|
+
*
|
|
32382
|
+
* 该接口用于获取电子表格的基础信息。
|
|
32383
|
+
*/
|
|
32384
|
+
get: (payload?: {
|
|
32385
|
+
params?: {
|
|
32386
|
+
user_id_type?: "user_id" | "union_id" | "open_id";
|
|
32387
|
+
};
|
|
32388
|
+
path?: {
|
|
32389
|
+
spreadsheet_token?: string;
|
|
32390
|
+
};
|
|
32391
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
32392
|
+
code?: number | undefined;
|
|
32393
|
+
msg?: string | undefined;
|
|
32394
|
+
data?: {
|
|
32395
|
+
spreadsheet?: {
|
|
32396
|
+
title?: string | undefined;
|
|
32397
|
+
owner_id?: string | undefined;
|
|
32398
|
+
token?: string | undefined;
|
|
32399
|
+
url?: string | undefined;
|
|
32400
|
+
} | undefined;
|
|
32401
|
+
} | undefined;
|
|
32402
|
+
}>;
|
|
32403
|
+
/**
|
|
32404
|
+
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet&apiName=patch&version=v3 click to debug }
|
|
32405
|
+
*
|
|
32406
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch document }
|
|
32407
|
+
*
|
|
32408
|
+
* 修改电子表格属性
|
|
32409
|
+
*
|
|
32410
|
+
* 该接口用于修改电子表格的属性
|
|
32411
|
+
*/
|
|
32412
|
+
patch: (payload?: {
|
|
32413
|
+
data?: {
|
|
32414
|
+
title?: string;
|
|
32415
|
+
};
|
|
32416
|
+
path?: {
|
|
32417
|
+
spreadsheet_token?: string;
|
|
32418
|
+
};
|
|
32419
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
32420
|
+
code?: number | undefined;
|
|
32421
|
+
msg?: string | undefined;
|
|
32422
|
+
data?: {} | undefined;
|
|
32423
|
+
}>;
|
|
31736
32424
|
};
|
|
31737
32425
|
/**
|
|
31738
32426
|
* 筛选
|
|
@@ -31747,7 +32435,7 @@ declare abstract class Client$1 {
|
|
|
31747
32435
|
*
|
|
31748
32436
|
* 在子表内创建筛选。
|
|
31749
32437
|
*
|
|
31750
|
-
* 参数值可参考[筛选指南](/
|
|
32438
|
+
* 参数值可参考[筛选指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/filter-user-guide)
|
|
31751
32439
|
*/
|
|
31752
32440
|
create: (payload?: {
|
|
31753
32441
|
data: {
|
|
@@ -31828,7 +32516,7 @@ declare abstract class Client$1 {
|
|
|
31828
32516
|
*
|
|
31829
32517
|
* 更新子表筛选范围中的列筛选条件。
|
|
31830
32518
|
*
|
|
31831
|
-
* 参数值可参考[筛选指南](/
|
|
32519
|
+
* 参数值可参考[筛选指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/filter-user-guide)
|
|
31832
32520
|
*/
|
|
31833
32521
|
update: (payload?: {
|
|
31834
32522
|
data: {
|
|
@@ -31862,7 +32550,7 @@ declare abstract class Client$1 {
|
|
|
31862
32550
|
*
|
|
31863
32551
|
* 在筛选视图的筛选范围的某一列创建筛选条件。
|
|
31864
32552
|
*
|
|
31865
|
-
* 筛选条件参考 [筛选视图的筛选条件指南](/
|
|
32553
|
+
* 筛选条件参考 [筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
31866
32554
|
*/
|
|
31867
32555
|
create: (payload?: {
|
|
31868
32556
|
data?: {
|
|
@@ -31918,7 +32606,7 @@ declare abstract class Client$1 {
|
|
|
31918
32606
|
*
|
|
31919
32607
|
* 获取筛选视图某列的筛选条件信息。
|
|
31920
32608
|
*
|
|
31921
|
-
* 筛选条件含义参考 [筛选视图的筛选条件指南](/
|
|
32609
|
+
* 筛选条件含义参考 [筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
31922
32610
|
*/
|
|
31923
32611
|
get: (payload?: {
|
|
31924
32612
|
path?: {
|
|
@@ -31948,7 +32636,7 @@ declare abstract class Client$1 {
|
|
|
31948
32636
|
*
|
|
31949
32637
|
* 查询一个筛选视图的所有筛选条件,返回筛选视图的筛选范围内的筛选条件。
|
|
31950
32638
|
*
|
|
31951
|
-
* 筛选条件含义可参考 [筛选视图的筛选条件指南](/
|
|
32639
|
+
* 筛选条件含义可参考 [筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
31952
32640
|
*/
|
|
31953
32641
|
query: (payload?: {
|
|
31954
32642
|
path?: {
|
|
@@ -31977,7 +32665,7 @@ declare abstract class Client$1 {
|
|
|
31977
32665
|
*
|
|
31978
32666
|
* 更新筛选视图范围的某列的筛选条件,condition id 即为列的字母号。
|
|
31979
32667
|
*
|
|
31980
|
-
* 筛选条件参数可参考 [筛选视图的筛选条件指南](/
|
|
32668
|
+
* 筛选条件参数可参考 [筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
31981
32669
|
*/
|
|
31982
32670
|
update: (payload?: {
|
|
31983
32671
|
data?: {
|
|
@@ -32017,7 +32705,7 @@ declare abstract class Client$1 {
|
|
|
32017
32705
|
*
|
|
32018
32706
|
* 根据传入的参数创建一个筛选视图。Id 和 名字可选,不填的话会默认生成;range 必填。Id 长度为10,由 0-9、a-z、A-Z 组合生成。名字长度不超过100。单个子表内的筛选视图个数不超过 150。
|
|
32019
32707
|
*
|
|
32020
|
-
* 筛选范围的设置参考:[筛选视图的筛选条件指南](/
|
|
32708
|
+
* 筛选范围的设置参考:[筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
32021
32709
|
*/
|
|
32022
32710
|
create: (payload?: {
|
|
32023
32711
|
data?: {
|
|
@@ -32095,7 +32783,7 @@ declare abstract class Client$1 {
|
|
|
32095
32783
|
*
|
|
32096
32784
|
* 更新筛选视图的名字或者筛选范围。名字长度不超过100,不能重复即子表内唯一;筛选范围不超过子表的最大范围。
|
|
32097
32785
|
*
|
|
32098
|
-
* 筛选范围的设置参考:[筛选视图的筛选条件指南](/
|
|
32786
|
+
* 筛选范围的设置参考:[筛选视图的筛选条件指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/filter-view-condition-user-guide)
|
|
32099
32787
|
*/
|
|
32100
32788
|
patch: (payload?: {
|
|
32101
32789
|
data?: {
|
|
@@ -32145,7 +32833,7 @@ declare abstract class Client$1 {
|
|
|
32145
32833
|
}>;
|
|
32146
32834
|
};
|
|
32147
32835
|
/**
|
|
32148
|
-
*
|
|
32836
|
+
* 行列
|
|
32149
32837
|
*/
|
|
32150
32838
|
spreadsheetSheet: {
|
|
32151
32839
|
/**
|
|
@@ -32183,6 +32871,45 @@ declare abstract class Client$1 {
|
|
|
32183
32871
|
} | undefined;
|
|
32184
32872
|
} | undefined;
|
|
32185
32873
|
}>;
|
|
32874
|
+
/**
|
|
32875
|
+
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet.sheet&apiName=get&version=v3 click to debug }
|
|
32876
|
+
*
|
|
32877
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get document }
|
|
32878
|
+
*
|
|
32879
|
+
* 查询工作表
|
|
32880
|
+
*
|
|
32881
|
+
* 该接口用于通过工作表ID查询工作表属性信息。
|
|
32882
|
+
*/
|
|
32883
|
+
get: (payload?: {
|
|
32884
|
+
path?: {
|
|
32885
|
+
spreadsheet_token?: string;
|
|
32886
|
+
sheet_id?: string;
|
|
32887
|
+
};
|
|
32888
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
32889
|
+
code?: number | undefined;
|
|
32890
|
+
msg?: string | undefined;
|
|
32891
|
+
data?: {
|
|
32892
|
+
sheet?: {
|
|
32893
|
+
sheet_id?: string | undefined;
|
|
32894
|
+
title?: string | undefined;
|
|
32895
|
+
index?: number | undefined;
|
|
32896
|
+
hidden?: boolean | undefined;
|
|
32897
|
+
grid_properties?: {
|
|
32898
|
+
frozen_row_count?: number | undefined;
|
|
32899
|
+
frozen_column_count?: number | undefined;
|
|
32900
|
+
row_count?: number | undefined;
|
|
32901
|
+
column_count?: number | undefined;
|
|
32902
|
+
} | undefined;
|
|
32903
|
+
resource_type?: string | undefined;
|
|
32904
|
+
merges?: {
|
|
32905
|
+
start_row_index?: number | undefined;
|
|
32906
|
+
end_row_index?: number | undefined;
|
|
32907
|
+
start_column_index?: number | undefined;
|
|
32908
|
+
end_column_index?: number | undefined;
|
|
32909
|
+
}[] | undefined;
|
|
32910
|
+
} | undefined;
|
|
32911
|
+
} | undefined;
|
|
32912
|
+
}>;
|
|
32186
32913
|
/**
|
|
32187
32914
|
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet.sheet&apiName=move_dimension&version=v3 click to debug }
|
|
32188
32915
|
*
|
|
@@ -32210,6 +32937,44 @@ declare abstract class Client$1 {
|
|
|
32210
32937
|
msg?: string | undefined;
|
|
32211
32938
|
data?: {} | undefined;
|
|
32212
32939
|
}>;
|
|
32940
|
+
/**
|
|
32941
|
+
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet.sheet&apiName=query&version=v3 click to debug }
|
|
32942
|
+
*
|
|
32943
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query document }
|
|
32944
|
+
*
|
|
32945
|
+
* 获取工作表
|
|
32946
|
+
*
|
|
32947
|
+
* 该接口用于获取电子表格下所有工作表及其属性。
|
|
32948
|
+
*/
|
|
32949
|
+
query: (payload?: {
|
|
32950
|
+
path?: {
|
|
32951
|
+
spreadsheet_token?: string;
|
|
32952
|
+
};
|
|
32953
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
32954
|
+
code?: number | undefined;
|
|
32955
|
+
msg?: string | undefined;
|
|
32956
|
+
data?: {
|
|
32957
|
+
sheets?: {
|
|
32958
|
+
sheet_id?: string | undefined;
|
|
32959
|
+
title?: string | undefined;
|
|
32960
|
+
index?: number | undefined;
|
|
32961
|
+
hidden?: boolean | undefined;
|
|
32962
|
+
grid_properties?: {
|
|
32963
|
+
frozen_row_count?: number | undefined;
|
|
32964
|
+
frozen_column_count?: number | undefined;
|
|
32965
|
+
row_count?: number | undefined;
|
|
32966
|
+
column_count?: number | undefined;
|
|
32967
|
+
} | undefined;
|
|
32968
|
+
resource_type?: string | undefined;
|
|
32969
|
+
merges?: {
|
|
32970
|
+
start_row_index?: number | undefined;
|
|
32971
|
+
end_row_index?: number | undefined;
|
|
32972
|
+
start_column_index?: number | undefined;
|
|
32973
|
+
end_column_index?: number | undefined;
|
|
32974
|
+
}[] | undefined;
|
|
32975
|
+
}[] | undefined;
|
|
32976
|
+
} | undefined;
|
|
32977
|
+
}>;
|
|
32213
32978
|
/**
|
|
32214
32979
|
* {@link https://open.feishu.cn/api-explorer?project=sheets&resource=spreadsheet.sheet&apiName=replace&version=v3 click to debug }
|
|
32215
32980
|
*
|
|
@@ -32258,9 +33023,9 @@ declare abstract class Client$1 {
|
|
|
32258
33023
|
*
|
|
32259
33024
|
* 创建浮动图片
|
|
32260
33025
|
*
|
|
32261
|
-
* 根据传入的参数创建一张浮动图片。Float_image_token ([上传图片至表格后得到](/
|
|
33026
|
+
* 根据传入的参数创建一张浮动图片。Float_image_token ([上传图片至表格后得到](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all))和range(只支持一个单元格) 必填。Float_image_id 可选,不填的话会默认生成,长度为10,由 0-9、a-z、A-Z 组合生成。表格内不重复的图片(浮动图片+单元格图片)总数不超过4000。width 和 height 为图片展示的宽高,可选,不填的话会使用图片的真实宽高。offset_x 和 offset_y 为图片左上角距离所在单元格左上角的偏移,可选,默认为 0。
|
|
32262
33027
|
*
|
|
32263
|
-
* 浮动图片的设置参考:[浮动图片指南](/
|
|
33028
|
+
* 浮动图片的设置参考:[浮动图片指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)
|
|
32264
33029
|
*/
|
|
32265
33030
|
create: (payload?: {
|
|
32266
33031
|
data?: {
|
|
@@ -32320,7 +33085,7 @@ declare abstract class Client$1 {
|
|
|
32320
33085
|
*
|
|
32321
33086
|
* 根据 float_image_id 获取对应浮动图片的信息。
|
|
32322
33087
|
*
|
|
32323
|
-
* 浮动图片参考:[浮动图片指南](/
|
|
33088
|
+
* 浮动图片参考:[浮动图片指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)
|
|
32324
33089
|
*/
|
|
32325
33090
|
get: (payload?: {
|
|
32326
33091
|
path?: {
|
|
@@ -32352,7 +33117,7 @@ declare abstract class Client$1 {
|
|
|
32352
33117
|
*
|
|
32353
33118
|
* 更新已有的浮动图片位置和宽高,包括 range、width、height、offset_x 和 offset_y,不包括 float_image_id 和 float_image_token。
|
|
32354
33119
|
*
|
|
32355
|
-
* 浮动图片更新参考:[浮动图片指南](/
|
|
33120
|
+
* 浮动图片更新参考:[浮动图片指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)
|
|
32356
33121
|
*/
|
|
32357
33122
|
patch: (payload?: {
|
|
32358
33123
|
data?: {
|
|
@@ -32392,7 +33157,7 @@ declare abstract class Client$1 {
|
|
|
32392
33157
|
*
|
|
32393
33158
|
* 返回子表内所有的浮动图片信息。
|
|
32394
33159
|
*
|
|
32395
|
-
* 浮动图片参考:[浮动图片指南](/
|
|
33160
|
+
* 浮动图片参考:[浮动图片指南](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/float-image-user-guide)
|
|
32396
33161
|
*/
|
|
32397
33162
|
query: (payload?: {
|
|
32398
33163
|
path?: {
|
|
@@ -32585,7 +33350,7 @@ declare abstract class Client$1 {
|
|
|
32585
33350
|
*/
|
|
32586
33351
|
create: (payload?: {
|
|
32587
33352
|
data: {
|
|
32588
|
-
summary
|
|
33353
|
+
summary?: string;
|
|
32589
33354
|
description?: string;
|
|
32590
33355
|
extra?: string;
|
|
32591
33356
|
due?: {
|
|
@@ -33541,10 +34306,90 @@ declare abstract class Client$1 {
|
|
|
33541
34306
|
* 视频会议
|
|
33542
34307
|
*/
|
|
33543
34308
|
vc: {
|
|
34309
|
+
/**
|
|
34310
|
+
* alert
|
|
34311
|
+
*/
|
|
34312
|
+
alert: {
|
|
34313
|
+
listWithIterator: (payload?: {
|
|
34314
|
+
params: {
|
|
34315
|
+
start_time: string;
|
|
34316
|
+
end_time: string;
|
|
34317
|
+
query_type?: number;
|
|
34318
|
+
query_value?: string;
|
|
34319
|
+
page_size?: number;
|
|
34320
|
+
page_token?: string;
|
|
34321
|
+
};
|
|
34322
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
34323
|
+
[Symbol.asyncIterator](): AsyncGenerator<{
|
|
34324
|
+
items?: {
|
|
34325
|
+
alert_id?: string | undefined;
|
|
34326
|
+
resource_scope?: string | undefined;
|
|
34327
|
+
monitor_target?: number | undefined;
|
|
34328
|
+
alert_strategy?: string | undefined;
|
|
34329
|
+
alert_time?: string | undefined;
|
|
34330
|
+
alert_level?: number | undefined;
|
|
34331
|
+
contacts?: {
|
|
34332
|
+
contact_type?: number | undefined;
|
|
34333
|
+
contact_name?: string | undefined;
|
|
34334
|
+
}[] | undefined;
|
|
34335
|
+
notifyMethods?: number[] | undefined;
|
|
34336
|
+
alertRule?: string | undefined;
|
|
34337
|
+
}[] | undefined;
|
|
34338
|
+
} | null, void, unknown>;
|
|
34339
|
+
}>;
|
|
34340
|
+
/**
|
|
34341
|
+
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=alert&apiName=list&version=v1 click to debug }
|
|
34342
|
+
*
|
|
34343
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=vc&resource=alert&version=v1 document }
|
|
34344
|
+
*/
|
|
34345
|
+
list: (payload?: {
|
|
34346
|
+
params: {
|
|
34347
|
+
start_time: string;
|
|
34348
|
+
end_time: string;
|
|
34349
|
+
query_type?: number;
|
|
34350
|
+
query_value?: string;
|
|
34351
|
+
page_size?: number;
|
|
34352
|
+
page_token?: string;
|
|
34353
|
+
};
|
|
34354
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
34355
|
+
code?: number | undefined;
|
|
34356
|
+
msg?: string | undefined;
|
|
34357
|
+
data?: {
|
|
34358
|
+
has_more?: boolean | undefined;
|
|
34359
|
+
page_token?: string | undefined;
|
|
34360
|
+
items?: {
|
|
34361
|
+
alert_id?: string | undefined;
|
|
34362
|
+
resource_scope?: string | undefined;
|
|
34363
|
+
monitor_target?: number | undefined;
|
|
34364
|
+
alert_strategy?: string | undefined;
|
|
34365
|
+
alert_time?: string | undefined;
|
|
34366
|
+
alert_level?: number | undefined;
|
|
34367
|
+
contacts?: {
|
|
34368
|
+
contact_type?: number | undefined;
|
|
34369
|
+
contact_name?: string | undefined;
|
|
34370
|
+
}[] | undefined;
|
|
34371
|
+
notifyMethods?: number[] | undefined;
|
|
34372
|
+
alertRule?: string | undefined;
|
|
34373
|
+
}[] | undefined;
|
|
34374
|
+
} | undefined;
|
|
34375
|
+
}>;
|
|
34376
|
+
};
|
|
33544
34377
|
/**
|
|
33545
34378
|
* 导出
|
|
33546
34379
|
*/
|
|
33547
34380
|
export: {
|
|
34381
|
+
/**
|
|
34382
|
+
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=download&version=v1 click to debug }
|
|
34383
|
+
*
|
|
34384
|
+
* {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=vc&resource=export&version=v1 document }
|
|
34385
|
+
*/
|
|
34386
|
+
download: (payload?: {
|
|
34387
|
+
params: {
|
|
34388
|
+
file_token: string;
|
|
34389
|
+
};
|
|
34390
|
+
}, options?: IRequestOptions$1) => Promise<{
|
|
34391
|
+
writeFile: (filePath: string) => Promise<void>;
|
|
34392
|
+
}>;
|
|
33548
34393
|
/**
|
|
33549
34394
|
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=get&version=v1 click to debug }
|
|
33550
34395
|
*
|
|
@@ -33564,6 +34409,8 @@ declare abstract class Client$1 {
|
|
|
33564
34409
|
data?: {
|
|
33565
34410
|
status: number;
|
|
33566
34411
|
url?: string | undefined;
|
|
34412
|
+
file_token?: string | undefined;
|
|
34413
|
+
fail_msg?: string | undefined;
|
|
33567
34414
|
} | undefined;
|
|
33568
34415
|
}>;
|
|
33569
34416
|
/**
|
|
@@ -34103,6 +34950,10 @@ declare abstract class Client$1 {
|
|
|
34103
34950
|
};
|
|
34104
34951
|
};
|
|
34105
34952
|
auto_record?: boolean;
|
|
34953
|
+
assign_host_list?: Array<{
|
|
34954
|
+
user_type?: number;
|
|
34955
|
+
id?: string;
|
|
34956
|
+
}>;
|
|
34106
34957
|
};
|
|
34107
34958
|
};
|
|
34108
34959
|
params?: {
|
|
@@ -34120,6 +34971,9 @@ declare abstract class Client$1 {
|
|
|
34120
34971
|
live_link?: string | undefined;
|
|
34121
34972
|
end_time?: string | undefined;
|
|
34122
34973
|
} | undefined;
|
|
34974
|
+
reserve_correction_check_info?: {
|
|
34975
|
+
invalid_host_id_list?: string[] | undefined;
|
|
34976
|
+
} | undefined;
|
|
34123
34977
|
} | undefined;
|
|
34124
34978
|
}>;
|
|
34125
34979
|
/**
|
|
@@ -34195,6 +35049,10 @@ declare abstract class Client$1 {
|
|
|
34195
35049
|
};
|
|
34196
35050
|
} | undefined;
|
|
34197
35051
|
auto_record?: boolean | undefined;
|
|
35052
|
+
assign_host_list?: {
|
|
35053
|
+
user_type?: number | undefined;
|
|
35054
|
+
id?: string | undefined;
|
|
35055
|
+
}[] | undefined;
|
|
34198
35056
|
} | undefined;
|
|
34199
35057
|
} | undefined;
|
|
34200
35058
|
} | undefined;
|
|
@@ -34295,6 +35153,10 @@ declare abstract class Client$1 {
|
|
|
34295
35153
|
};
|
|
34296
35154
|
};
|
|
34297
35155
|
auto_record?: boolean;
|
|
35156
|
+
assign_host_list?: Array<{
|
|
35157
|
+
user_type?: number;
|
|
35158
|
+
id?: string;
|
|
35159
|
+
}>;
|
|
34298
35160
|
};
|
|
34299
35161
|
};
|
|
34300
35162
|
params?: {
|
|
@@ -34315,6 +35177,9 @@ declare abstract class Client$1 {
|
|
|
34315
35177
|
end_time?: string | undefined;
|
|
34316
35178
|
expire_status?: number | undefined;
|
|
34317
35179
|
} | undefined;
|
|
35180
|
+
reserve_correction_check_info?: {
|
|
35181
|
+
invalid_host_id_list?: string[] | undefined;
|
|
35182
|
+
} | undefined;
|
|
34318
35183
|
} | undefined;
|
|
34319
35184
|
}>;
|
|
34320
35185
|
};
|
|
@@ -34598,7 +35463,7 @@ declare abstract class Client$1 {
|
|
|
34598
35463
|
*
|
|
34599
35464
|
* 获取知识空间列表
|
|
34600
35465
|
*
|
|
34601
|
-
* 此接口用于获取有权限访问的知识空间列表。;;此接口为分页接口。由于权限过滤,可能返回列表为空,但分页标记(has_more)为true,可以继续分页请求。;;对于知识空间各项属性描述请参阅[获取知识空间信息](/
|
|
35466
|
+
* 此接口用于获取有权限访问的知识空间列表。;;此接口为分页接口。由于权限过滤,可能返回列表为空,但分页标记(has_more)为true,可以继续分页请求。;;对于知识空间各项属性描述请参阅[获取知识空间信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get)
|
|
34602
35467
|
*
|
|
34603
35468
|
* 使用tenant access token调用时,请确认应用/机器人拥有部分知识空间的访问权限,否则返回列表容易为空。
|
|
34604
35469
|
*/
|
|
@@ -34757,8 +35622,6 @@ declare abstract class Client$1 {
|
|
|
34757
35622
|
node_type: "origin" | "shortcut";
|
|
34758
35623
|
origin_node_token?: string;
|
|
34759
35624
|
title?: string;
|
|
34760
|
-
creator?: string;
|
|
34761
|
-
owner?: string;
|
|
34762
35625
|
};
|
|
34763
35626
|
path?: {
|
|
34764
35627
|
space_id?: string;
|
|
@@ -34913,7 +35776,7 @@ declare abstract class Client$1 {
|
|
|
34913
35776
|
*
|
|
34914
35777
|
* 该接口允许添加已有云文档至知识库,并挂载在指定父页面下
|
|
34915
35778
|
*
|
|
34916
|
-
* 仅支持文档所有者发起请求;;此接口为异步接口。若移动已完成(或节点已在Wiki中),则直接返回结果(Wiki token)。若尚未完成,则返回task id。请使用[获取任务结果](/
|
|
35779
|
+
* 仅支持文档所有者发起请求;;此接口为异步接口。若移动已完成(或节点已在Wiki中),则直接返回结果(Wiki token)。若尚未完成,则返回task id。请使用[获取任务结果](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get)接口进行查询。;;知识库权限要求:;- 文档可管理权限;- 原文件夹编辑权限;- 目标父节点容器编辑权限
|
|
34917
35780
|
*
|
|
34918
35781
|
* ### 移动操作 ###;移动后,文档将从“我的空间”或“共享空间”转移至“知识库”,并将从以下功能入口消失:;- 云空间主页:最近访问、快速访问;- 我的空间;- 共享空间;- 收藏;;### 权限变更 ###;移动后,文档会向所有可查看“页面树”的用户显示,默认继承父页面的权限设置。;</md-alert
|
|
34919
35782
|
*/
|
|
@@ -36034,8 +36897,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36034
36897
|
};
|
|
36035
36898
|
}) => Promise<any> | any;
|
|
36036
36899
|
/**
|
|
36037
|
-
|
|
36038
|
-
|
|
36900
|
+
|
|
36901
|
+
*/
|
|
36039
36902
|
"application.application.visibility.added_v6"?: (data: {
|
|
36040
36903
|
event_id?: string;
|
|
36041
36904
|
token?: string;
|
|
@@ -36056,8 +36919,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36056
36919
|
source?: number;
|
|
36057
36920
|
}) => Promise<any> | any;
|
|
36058
36921
|
/**
|
|
36059
|
-
|
|
36060
|
-
|
|
36922
|
+
|
|
36923
|
+
*/
|
|
36061
36924
|
"approval.approval.updated_v4"?: (data: {
|
|
36062
36925
|
event_id?: string;
|
|
36063
36926
|
token?: string;
|
|
@@ -36156,7 +37019,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36156
37019
|
*
|
|
36157
37020
|
* 当订阅用户的日历列表有日历变动时触发此事件。
|
|
36158
37021
|
*
|
|
36159
|
-
* 应用首先需要调用上述接口建立订阅关系。应用收到该事件后,使用事件的 user_list 字段中的用户对应的 user_access_token 调用[获取日历列表](/
|
|
37022
|
+
* 应用首先需要调用上述接口建立订阅关系。应用收到该事件后,使用事件的 user_list 字段中的用户对应的 user_access_token 调用[获取日历列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list)接口拉取增量的变更数据
|
|
36160
37023
|
*/
|
|
36161
37024
|
"calendar.calendar.changed_v4"?: (data: {
|
|
36162
37025
|
event_id?: string;
|
|
@@ -36181,7 +37044,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36181
37044
|
*
|
|
36182
37045
|
* 当被订阅的用户日历下有日程变更时触发此事件。
|
|
36183
37046
|
*
|
|
36184
|
-
* 应用首先需要调用[订阅日程变更事件接口](/
|
|
37047
|
+
* 应用首先需要调用[订阅日程变更事件接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription)建立订阅关系。应用收到该事件后,使用事件的 user_list 字段中的用户对应的 user_access_token 调用[获取日程列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list)接口拉取事件中 calendar_id 字段对应的日历下的日程数据
|
|
36185
37048
|
*/
|
|
36186
37049
|
"calendar.calendar.event.changed_v4"?: (data: {
|
|
36187
37050
|
event_id?: string;
|
|
@@ -36235,7 +37098,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36235
37098
|
*
|
|
36236
37099
|
* 创建通讯录部门时发送该事件给订阅应用。
|
|
36237
37100
|
*
|
|
36238
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37101
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36239
37102
|
*/
|
|
36240
37103
|
"contact.department.created_v3"?: (data: {
|
|
36241
37104
|
event_id?: string;
|
|
@@ -36272,7 +37135,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36272
37135
|
*
|
|
36273
37136
|
* 订阅这一事件可以获得被删除部门的信息。
|
|
36274
37137
|
*
|
|
36275
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37138
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36276
37139
|
*/
|
|
36277
37140
|
"contact.department.deleted_v3"?: (data: {
|
|
36278
37141
|
event_id?: string;
|
|
@@ -36315,7 +37178,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36315
37178
|
*
|
|
36316
37179
|
* 通过该事件订阅部门更新。old_object只展示被更新字段的原始值。应用身份访问通讯录的权限为历史版本,不推荐申请。
|
|
36317
37180
|
*
|
|
36318
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37181
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36319
37182
|
*/
|
|
36320
37183
|
"contact.department.updated_v3"?: (data: {
|
|
36321
37184
|
event_id?: string;
|
|
@@ -36761,7 +37624,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36761
37624
|
*
|
|
36762
37625
|
* 通过该事件订阅员工入职。
|
|
36763
37626
|
*
|
|
36764
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37627
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36765
37628
|
*/
|
|
36766
37629
|
"contact.user.created_v3"?: (data: {
|
|
36767
37630
|
event_id?: string;
|
|
@@ -36848,7 +37711,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36848
37711
|
*
|
|
36849
37712
|
* 通过该事件订阅员工离职。应用身份访问通讯录的权限为历史版本,不推荐申请。
|
|
36850
37713
|
*
|
|
36851
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37714
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36852
37715
|
*/
|
|
36853
37716
|
"contact.user.deleted_v3"?: (data: {
|
|
36854
37717
|
event_id?: string;
|
|
@@ -36939,7 +37802,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
36939
37802
|
*
|
|
36940
37803
|
* 通过该事件订阅员工变更。old_object中只展示更新的字段的原始值。
|
|
36941
37804
|
*
|
|
36942
|
-
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](/
|
|
37805
|
+
* 只有当应用拥有被改动字段的数据权限时,才会接收到事件。具体的数据权限与字段的关系请参考[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN),或查看事件体参数列表的字段描述。
|
|
36943
37806
|
*/
|
|
36944
37807
|
"contact.user.updated_v3"?: (data: {
|
|
36945
37808
|
event_id?: string;
|
|
@@ -37087,8 +37950,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37087
37950
|
};
|
|
37088
37951
|
}) => Promise<any> | any;
|
|
37089
37952
|
/**
|
|
37090
|
-
|
|
37091
|
-
|
|
37953
|
+
|
|
37954
|
+
*/
|
|
37092
37955
|
"drive.file.deleted_v1"?: (data: {
|
|
37093
37956
|
event_id?: string;
|
|
37094
37957
|
token?: string;
|
|
@@ -37113,8 +37976,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37113
37976
|
}>;
|
|
37114
37977
|
}) => Promise<any> | any;
|
|
37115
37978
|
/**
|
|
37116
|
-
|
|
37117
|
-
|
|
37979
|
+
|
|
37980
|
+
*/
|
|
37118
37981
|
"drive.file.edit_v1"?: (data: {
|
|
37119
37982
|
event_id?: string;
|
|
37120
37983
|
token?: string;
|
|
@@ -37140,8 +38003,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37140
38003
|
sheet_id?: string;
|
|
37141
38004
|
}) => Promise<any> | any;
|
|
37142
38005
|
/**
|
|
37143
|
-
|
|
37144
|
-
|
|
38006
|
+
|
|
38007
|
+
*/
|
|
37145
38008
|
"drive.file.permission_member_added_v1"?: (data: {
|
|
37146
38009
|
event_id?: string;
|
|
37147
38010
|
token?: string;
|
|
@@ -37173,8 +38036,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37173
38036
|
}>;
|
|
37174
38037
|
}) => Promise<any> | any;
|
|
37175
38038
|
/**
|
|
37176
|
-
|
|
37177
|
-
|
|
38039
|
+
|
|
38040
|
+
*/
|
|
37178
38041
|
"drive.file.permission_member_removed_v1"?: (data: {
|
|
37179
38042
|
event_id?: string;
|
|
37180
38043
|
token?: string;
|
|
@@ -37206,8 +38069,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37206
38069
|
}>;
|
|
37207
38070
|
}) => Promise<any> | any;
|
|
37208
38071
|
/**
|
|
37209
|
-
|
|
37210
|
-
|
|
38072
|
+
|
|
38073
|
+
*/
|
|
37211
38074
|
"drive.file.read_v1"?: (data: {
|
|
37212
38075
|
event_id?: string;
|
|
37213
38076
|
token?: string;
|
|
@@ -37232,8 +38095,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37232
38095
|
}>;
|
|
37233
38096
|
}) => Promise<any> | any;
|
|
37234
38097
|
/**
|
|
37235
|
-
|
|
37236
|
-
|
|
38098
|
+
|
|
38099
|
+
*/
|
|
37237
38100
|
"drive.file.title_updated_v1"?: (data: {
|
|
37238
38101
|
event_id?: string;
|
|
37239
38102
|
token?: string;
|
|
@@ -37258,8 +38121,8 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37258
38121
|
}>;
|
|
37259
38122
|
}) => Promise<any> | any;
|
|
37260
38123
|
/**
|
|
37261
|
-
|
|
37262
|
-
|
|
38124
|
+
|
|
38125
|
+
*/
|
|
37263
38126
|
"drive.file.trashed_v1"?: (data: {
|
|
37264
38127
|
event_id?: string;
|
|
37265
38128
|
token?: string;
|
|
@@ -37309,7 +38172,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37309
38172
|
*
|
|
37310
38173
|
* 工单创建事件
|
|
37311
38174
|
*
|
|
37312
|
-
* 可监听服务台的工单创建事件。需使用订阅接口订阅:[事件订阅](/
|
|
38175
|
+
* 可监听服务台的工单创建事件。需使用订阅接口订阅:[事件订阅](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/overview)
|
|
37313
38176
|
*/
|
|
37314
38177
|
"helpdesk.ticket.created_v1"?: (data: {
|
|
37315
38178
|
event_id?: string;
|
|
@@ -37355,7 +38218,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37355
38218
|
*
|
|
37356
38219
|
* 工单状态变更事件
|
|
37357
38220
|
*
|
|
37358
|
-
* 可监听工单状态和阶段变更事件。需使用订阅接口订阅:[事件订阅](/
|
|
38221
|
+
* 可监听工单状态和阶段变更事件。需使用订阅接口订阅:[事件订阅](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/overview)
|
|
37359
38222
|
*/
|
|
37360
38223
|
"helpdesk.ticket.updated_v1"?: (data: {
|
|
37361
38224
|
event_id?: string;
|
|
@@ -37408,7 +38271,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37408
38271
|
*
|
|
37409
38272
|
* 工单消息事件
|
|
37410
38273
|
*
|
|
37411
|
-
* 该消息事件属于工单消息事件。需使用订阅接口订阅:[事件订阅](/
|
|
38274
|
+
* 该消息事件属于工单消息事件。需使用订阅接口订阅:[事件订阅](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/overview)
|
|
37412
38275
|
*/
|
|
37413
38276
|
"helpdesk.ticket_message.created_v1"?: (data: {
|
|
37414
38277
|
token?: string;
|
|
@@ -37486,7 +38349,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37486
38349
|
*
|
|
37487
38350
|
* 群组被解散后触发此事件。
|
|
37488
38351
|
*
|
|
37489
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38352
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==解散群== 事件;- 事件会向群内订阅了该事件的机器人进行推送
|
|
37490
38353
|
*/
|
|
37491
38354
|
"im.chat.disbanded_v1"?: (data: {
|
|
37492
38355
|
event_id?: string;
|
|
@@ -37514,7 +38377,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37514
38377
|
*
|
|
37515
38378
|
* 机器人被用户添加至群聊时触发此事件。
|
|
37516
38379
|
*
|
|
37517
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38380
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==机器人进群== 事件;- 事件会向进群的机器人进行推送;- 机器人邀请机器人不会触发事件
|
|
37518
38381
|
*/
|
|
37519
38382
|
"im.chat.member.bot.added_v1"?: (data: {
|
|
37520
38383
|
event_id?: string;
|
|
@@ -37542,7 +38405,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37542
38405
|
*
|
|
37543
38406
|
* 机器人被移出群聊后触发此事件。
|
|
37544
38407
|
*
|
|
37545
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38408
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==机器人被移出群== 事件;- 事件会向被移出群的机器人进行推送
|
|
37546
38409
|
*/
|
|
37547
38410
|
"im.chat.member.bot.deleted_v1"?: (data: {
|
|
37548
38411
|
event_id?: string;
|
|
@@ -37570,7 +38433,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37570
38433
|
*
|
|
37571
38434
|
* 新用户进群触发此事件。
|
|
37572
38435
|
*
|
|
37573
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38436
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==用户进群== 事件;- 事件会向群内订阅了该事件的机器人进行推送
|
|
37574
38437
|
*/
|
|
37575
38438
|
"im.chat.member.user.added_v1"?: (data: {
|
|
37576
38439
|
event_id?: string;
|
|
@@ -37607,7 +38470,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37607
38470
|
*
|
|
37608
38471
|
* 用户主动退群或被移出群聊时推送事件。
|
|
37609
38472
|
*
|
|
37610
|
-
* 注意事项:;- 应用需要开启[机器人能力](/
|
|
38473
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)并且机器人所在群发生上述变化;- 机器人需要订阅 ==消息与群组== 分类下的 ==用户主动退群或被移出群聊== 事件;- 事件会向群内订阅了该事件的机器人进行推送
|
|
37611
38474
|
*/
|
|
37612
38475
|
"im.chat.member.user.deleted_v1"?: (data: {
|
|
37613
38476
|
event_id?: string;
|
|
@@ -37644,7 +38507,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37644
38507
|
*
|
|
37645
38508
|
* 撤销拉用户进群后触发此事件。
|
|
37646
38509
|
*
|
|
37647
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38510
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==撤销拉用户进群== 事件;- 事件会向群内订阅了该事件的机器人进行推送
|
|
37648
38511
|
*/
|
|
37649
38512
|
"im.chat.member.user.withdrawn_v1"?: (data: {
|
|
37650
38513
|
event_id?: string;
|
|
@@ -37681,7 +38544,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37681
38544
|
*
|
|
37682
38545
|
* 群组配置被修改后触发此事件,包含:;- 群主转移;- 群基本信息修改(群头像/群名称/群描述/群国际化名称);- 群权限修改(加人入群权限/群编辑权限/at所有人权限/群分享权限)。
|
|
37683
38546
|
*
|
|
37684
|
-
* 注意事项:; - 需要开启[机器人能力](/
|
|
38547
|
+
* 注意事项:; - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 需要订阅 ==消息与群组== 分类下的 ==群配置修改== 事件;- 事件会向群内订阅了该事件的机器人进行推送
|
|
37685
38548
|
*/
|
|
37686
38549
|
"im.chat.updated_v1"?: (data: {
|
|
37687
38550
|
event_id?: string;
|
|
@@ -37775,7 +38638,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37775
38638
|
*
|
|
37776
38639
|
* 用户阅读机器人发送的单聊消息后触发此事件。
|
|
37777
38640
|
*
|
|
37778
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38641
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 需要订阅 ==消息与群组== 分类下的 ==消息已读== 事件
|
|
37779
38642
|
*/
|
|
37780
38643
|
"im.message.message_read_v1"?: (data: {
|
|
37781
38644
|
event_id?: string;
|
|
@@ -37805,7 +38668,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37805
38668
|
*
|
|
37806
38669
|
* 消息被添加某一个表情回复后触发此事件
|
|
37807
38670
|
*
|
|
37808
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38671
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,具备==获取单聊、群组消息== 或 ==获取与发送单聊、群组消息==权限,并订阅 ==消息与群组== 分类下的 ==消息被reaction== 事件才可接收推送;- 机器人只能收到所在群聊内的消息被添加表情回复事件
|
|
37809
38672
|
*/
|
|
37810
38673
|
"im.message.reaction.created_v1"?: (data: {
|
|
37811
38674
|
event_id?: string;
|
|
@@ -37836,7 +38699,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37836
38699
|
*
|
|
37837
38700
|
* 消息被删除某一个表情回复后触发此事件
|
|
37838
38701
|
*
|
|
37839
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38702
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,具备==获取单聊、群组消息== 或 ==获取与发送单聊、群组消息==权限,并订阅 ==消息与群组== 分类下的 ==消息被取消reaction== 事件才可接收推送;- 机器人只能收到所在群聊内的消息被删除表情回复事件
|
|
37840
38703
|
*/
|
|
37841
38704
|
"im.message.reaction.deleted_v1"?: (data: {
|
|
37842
38705
|
event_id?: string;
|
|
@@ -37867,7 +38730,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37867
38730
|
*
|
|
37868
38731
|
* 机器人接收到用户发送的消息后触发此事件。
|
|
37869
38732
|
*
|
|
37870
|
-
* 注意事项:;- 需要开启[机器人能力](/
|
|
38733
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,并订阅 ==消息与群组== 分类下的 ==接收消息v2.0== 事件才可接收推送;- 同时,将根据应用具备的权限,判断可推送的信息:; - 当具备==获取用户发给机器人的单聊消息==权限或者==读取用户发给机器人的单聊消息(历史权限)==,可接收与机器人单聊会话中用户发送的所有消息; - 当具备==获取群组中所有消息== 权限时,可接收与机器人所在群聊会话中用户发送的所有消息; - 当具备==获取用户在群组中@机器人的消息== 权限或者==获取用户在群聊中@机器人的消息(历史权限)==,可接收机器人所在群聊中用户 @ 机器人的消息
|
|
37871
38734
|
*/
|
|
37872
38735
|
"im.message.receive_v1"?: (data: {
|
|
37873
38736
|
event_id?: string;
|
|
@@ -37916,7 +38779,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37916
38779
|
*
|
|
37917
38780
|
* 会议室被创建将触发此事件。
|
|
37918
38781
|
*
|
|
37919
|
-
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](/
|
|
38782
|
+
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)
|
|
37920
38783
|
*/
|
|
37921
38784
|
"meeting_room.meeting_room.created_v1"?: (data: {
|
|
37922
38785
|
event_id?: string;
|
|
@@ -37938,7 +38801,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37938
38801
|
*
|
|
37939
38802
|
* 会议室被删除将触发此事件。
|
|
37940
38803
|
*
|
|
37941
|
-
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](/
|
|
38804
|
+
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)
|
|
37942
38805
|
*/
|
|
37943
38806
|
"meeting_room.meeting_room.deleted_v1"?: (data: {
|
|
37944
38807
|
event_id?: string;
|
|
@@ -37960,7 +38823,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37960
38823
|
*
|
|
37961
38824
|
* 会议室状态信息变更将触发此事件。
|
|
37962
38825
|
*
|
|
37963
|
-
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](/
|
|
38826
|
+
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)
|
|
37964
38827
|
*/
|
|
37965
38828
|
"meeting_room.meeting_room.status_changed_v1"?: (data: {
|
|
37966
38829
|
event_id?: string;
|
|
@@ -37982,7 +38845,7 @@ interface IHandles extends IOtherEventHandles {
|
|
|
37982
38845
|
*
|
|
37983
38846
|
* 会议室属性更新将触发此事件。
|
|
37984
38847
|
*
|
|
37985
|
-
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](/
|
|
38848
|
+
* 了解事件订阅的使用场景和配置流程,请点击查看 [事件订阅概述](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)
|
|
37986
38849
|
*/
|
|
37987
38850
|
"meeting_room.meeting_room.updated_v1"?: (data: {
|
|
37988
38851
|
event_id?: string;
|