@larksuiteoapi/node-sdk 1.2.3 → 1.4.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/README.md +30 -0
- package/README.zh.md +30 -0
- package/es/index.js +332 -136
- package/lib/index.js +332 -136
- package/package.json +9 -4
- package/types/index.d.ts +14535 -631
package/lib/index.js
CHANGED
|
@@ -1059,7 +1059,7 @@ class Client$1 {
|
|
|
1059
1059
|
}),
|
|
1060
1060
|
},
|
|
1061
1061
|
/**
|
|
1062
|
-
*
|
|
1062
|
+
* 事件
|
|
1063
1063
|
*/
|
|
1064
1064
|
applicationAppVersion: {
|
|
1065
1065
|
/**
|
|
@@ -1137,9 +1137,11 @@ class Client$1 {
|
|
|
1137
1137
|
/**
|
|
1138
1138
|
* {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_version&apiName=list&version=v6 click to debug }
|
|
1139
1139
|
*
|
|
1140
|
-
* {@link https://open.feishu.cn/
|
|
1140
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list document }
|
|
1141
1141
|
*
|
|
1142
1142
|
* 获取应用版本列表
|
|
1143
|
+
*
|
|
1144
|
+
* 根据 app_id 获取对应应用版本列表。
|
|
1143
1145
|
*/
|
|
1144
1146
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
1145
1147
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -1365,7 +1367,7 @@ class Client$1 {
|
|
|
1365
1367
|
*/
|
|
1366
1368
|
this.approval = {
|
|
1367
1369
|
/**
|
|
1368
|
-
*
|
|
1370
|
+
* 原生审批定义
|
|
1369
1371
|
*/
|
|
1370
1372
|
approval: {
|
|
1371
1373
|
/**
|
|
@@ -1469,7 +1471,11 @@ class Client$1 {
|
|
|
1469
1471
|
/**
|
|
1470
1472
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=approval&apiName=list&version=v4 click to debug }
|
|
1471
1473
|
*
|
|
1472
|
-
* {@link https://open.feishu.cn/
|
|
1474
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/list document }
|
|
1475
|
+
*
|
|
1476
|
+
* 查询审批定义列表
|
|
1477
|
+
*
|
|
1478
|
+
* 查询当前用户可发起的审批定义列表。
|
|
1473
1479
|
*/
|
|
1474
1480
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
1475
1481
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -1697,13 +1703,13 @@ class Client$1 {
|
|
|
1697
1703
|
}),
|
|
1698
1704
|
},
|
|
1699
1705
|
/**
|
|
1700
|
-
*
|
|
1706
|
+
* 原生审批实例
|
|
1701
1707
|
*/
|
|
1702
1708
|
instance: {
|
|
1703
1709
|
/**
|
|
1704
1710
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=add_sign&version=v4 click to debug }
|
|
1705
1711
|
*
|
|
1706
|
-
* {@link https://open.feishu.cn/
|
|
1712
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign document }
|
|
1707
1713
|
*/
|
|
1708
1714
|
addSign: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
1709
1715
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -1891,7 +1897,7 @@ class Client$1 {
|
|
|
1891
1897
|
/**
|
|
1892
1898
|
* {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=preview&version=v4 click to debug }
|
|
1893
1899
|
*
|
|
1894
|
-
* {@link https://open.feishu.cn/
|
|
1900
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview document }
|
|
1895
1901
|
*/
|
|
1896
1902
|
preview: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
1897
1903
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -1961,7 +1967,7 @@ class Client$1 {
|
|
|
1961
1967
|
*
|
|
1962
1968
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query document }
|
|
1963
1969
|
*
|
|
1964
|
-
*
|
|
1970
|
+
* 查询实例列表
|
|
1965
1971
|
*
|
|
1966
1972
|
* 该接口通过不同条件查询审批系统中符合条件的审批实例列表。
|
|
1967
1973
|
*/
|
|
@@ -1985,7 +1991,7 @@ class Client$1 {
|
|
|
1985
1991
|
*
|
|
1986
1992
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc document }
|
|
1987
1993
|
*
|
|
1988
|
-
*
|
|
1994
|
+
* 查询抄送列表
|
|
1989
1995
|
*
|
|
1990
1996
|
* 该接口通过不同条件查询审批系统中符合条件的审批抄送列表。
|
|
1991
1997
|
*/
|
|
@@ -2030,7 +2036,7 @@ class Client$1 {
|
|
|
2030
2036
|
}),
|
|
2031
2037
|
},
|
|
2032
2038
|
/**
|
|
2033
|
-
*
|
|
2039
|
+
* 原生审批评论
|
|
2034
2040
|
*/
|
|
2035
2041
|
instanceComment: {
|
|
2036
2042
|
/**
|
|
@@ -2179,7 +2185,7 @@ class Client$1 {
|
|
|
2179
2185
|
}),
|
|
2180
2186
|
},
|
|
2181
2187
|
/**
|
|
2182
|
-
*
|
|
2188
|
+
* 审批查询
|
|
2183
2189
|
*/
|
|
2184
2190
|
task: {
|
|
2185
2191
|
/**
|
|
@@ -2331,7 +2337,7 @@ class Client$1 {
|
|
|
2331
2337
|
*
|
|
2332
2338
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search document }
|
|
2333
2339
|
*
|
|
2334
|
-
*
|
|
2340
|
+
* 查询任务列表
|
|
2335
2341
|
*
|
|
2336
2342
|
* 该接口通过不同条件查询审批系统中符合条件的审批任务列表
|
|
2337
2343
|
*/
|
|
@@ -2381,7 +2387,7 @@ class Client$1 {
|
|
|
2381
2387
|
*/
|
|
2382
2388
|
this.attendance = {
|
|
2383
2389
|
/**
|
|
2384
|
-
*
|
|
2390
|
+
* approval_info
|
|
2385
2391
|
*/
|
|
2386
2392
|
approvalInfo: {
|
|
2387
2393
|
/**
|
|
@@ -2943,7 +2949,7 @@ class Client$1 {
|
|
|
2943
2949
|
}),
|
|
2944
2950
|
},
|
|
2945
2951
|
/**
|
|
2946
|
-
*
|
|
2952
|
+
* user_flow
|
|
2947
2953
|
*/
|
|
2948
2954
|
userFlow: {
|
|
2949
2955
|
/**
|
|
@@ -3106,7 +3112,7 @@ class Client$1 {
|
|
|
3106
3112
|
}),
|
|
3107
3113
|
},
|
|
3108
3114
|
/**
|
|
3109
|
-
*
|
|
3115
|
+
* user_stats_field
|
|
3110
3116
|
*/
|
|
3111
3117
|
userStatsField: {
|
|
3112
3118
|
/**
|
|
@@ -3135,7 +3141,7 @@ class Client$1 {
|
|
|
3135
3141
|
}),
|
|
3136
3142
|
},
|
|
3137
3143
|
/**
|
|
3138
|
-
*
|
|
3144
|
+
* user_stats_view
|
|
3139
3145
|
*/
|
|
3140
3146
|
userStatsView: {
|
|
3141
3147
|
/**
|
|
@@ -3449,7 +3455,7 @@ class Client$1 {
|
|
|
3449
3455
|
*
|
|
3450
3456
|
* 创建免审词条
|
|
3451
3457
|
*
|
|
3452
|
-
*
|
|
3458
|
+
* 通过此接口创建的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】。
|
|
3453
3459
|
*/
|
|
3454
3460
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3455
3461
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3473,7 +3479,7 @@ class Client$1 {
|
|
|
3473
3479
|
*
|
|
3474
3480
|
* 获取词条详情
|
|
3475
3481
|
*
|
|
3476
|
-
* 通过词条 id
|
|
3482
|
+
* 通过词条 id 拉取对应的词条详情信息。
|
|
3477
3483
|
*
|
|
3478
3484
|
* 也支持通过 provider 和 outer_id 返回对应实体的详情数据。此时路径中的 entity_id 为固定的 enterprise_0
|
|
3479
3485
|
*/
|
|
@@ -3499,7 +3505,7 @@ class Client$1 {
|
|
|
3499
3505
|
*
|
|
3500
3506
|
* 词条高亮
|
|
3501
3507
|
*
|
|
3502
|
-
* 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id
|
|
3508
|
+
* 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现百科词条智能高亮。
|
|
3503
3509
|
*/
|
|
3504
3510
|
highlight: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3505
3511
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3571,7 +3577,7 @@ class Client$1 {
|
|
|
3571
3577
|
*
|
|
3572
3578
|
* 获取词条列表
|
|
3573
3579
|
*
|
|
3574
|
-
*
|
|
3580
|
+
* 分页拉取词条列表数据,支持拉取租户内的全部词条。
|
|
3575
3581
|
*/
|
|
3576
3582
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3577
3583
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3595,7 +3601,7 @@ class Client$1 {
|
|
|
3595
3601
|
*
|
|
3596
3602
|
* 精准搜索词条
|
|
3597
3603
|
*
|
|
3598
|
-
* 将关键词与词条名、别名精准匹配,并返回对应的 词条 ID
|
|
3604
|
+
* 将关键词与词条名、别名精准匹配,并返回对应的 词条 ID。
|
|
3599
3605
|
*/
|
|
3600
3606
|
match: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3601
3607
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3667,7 +3673,7 @@ class Client$1 {
|
|
|
3667
3673
|
*
|
|
3668
3674
|
* 模糊搜索词条
|
|
3669
3675
|
*
|
|
3670
|
-
*
|
|
3676
|
+
* 传入关键词,与词条名、别名、释义等信息进行模糊匹配,返回搜到的词条信息。
|
|
3671
3677
|
*/
|
|
3672
3678
|
search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3673
3679
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3691,7 +3697,7 @@ class Client$1 {
|
|
|
3691
3697
|
*
|
|
3692
3698
|
* 更新免审词条
|
|
3693
3699
|
*
|
|
3694
|
-
*
|
|
3700
|
+
* 通过此接口更新已有的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】。
|
|
3695
3701
|
*/
|
|
3696
3702
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3697
3703
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3710,13 +3716,17 @@ class Client$1 {
|
|
|
3710
3716
|
}),
|
|
3711
3717
|
},
|
|
3712
3718
|
/**
|
|
3713
|
-
*
|
|
3719
|
+
* 文件
|
|
3714
3720
|
*/
|
|
3715
3721
|
file: {
|
|
3716
3722
|
/**
|
|
3717
3723
|
* {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=download&version=v1 click to debug }
|
|
3718
3724
|
*
|
|
3719
|
-
* {@link https://open.feishu.cn/
|
|
3725
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download document }
|
|
3726
|
+
*
|
|
3727
|
+
* 图片下载
|
|
3728
|
+
*
|
|
3729
|
+
* 通过 file_token 下载原图片
|
|
3720
3730
|
*/
|
|
3721
3731
|
download: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3722
3732
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3751,7 +3761,11 @@ class Client$1 {
|
|
|
3751
3761
|
/**
|
|
3752
3762
|
* {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=upload&version=v1 click to debug }
|
|
3753
3763
|
*
|
|
3754
|
-
* {@link https://open.feishu.cn/
|
|
3764
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload document }
|
|
3765
|
+
*
|
|
3766
|
+
* 图片上传
|
|
3767
|
+
*
|
|
3768
|
+
* 百科词条图片资源上传。
|
|
3755
3769
|
*/
|
|
3756
3770
|
upload: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3757
3771
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -3772,7 +3786,7 @@ class Client$1 {
|
|
|
3772
3786
|
},
|
|
3773
3787
|
};
|
|
3774
3788
|
/**
|
|
3775
|
-
*
|
|
3789
|
+
* 云文档-多维表格
|
|
3776
3790
|
*/
|
|
3777
3791
|
this.bitable = {
|
|
3778
3792
|
/**
|
|
@@ -5137,7 +5151,7 @@ class Client$1 {
|
|
|
5137
5151
|
*/
|
|
5138
5152
|
this.block = {
|
|
5139
5153
|
/**
|
|
5140
|
-
*
|
|
5154
|
+
* 服务端 API
|
|
5141
5155
|
*/
|
|
5142
5156
|
entity: {
|
|
5143
5157
|
/**
|
|
@@ -5190,7 +5204,7 @@ class Client$1 {
|
|
|
5190
5204
|
}),
|
|
5191
5205
|
},
|
|
5192
5206
|
/**
|
|
5193
|
-
*
|
|
5207
|
+
* 服务端 API
|
|
5194
5208
|
*/
|
|
5195
5209
|
message: {
|
|
5196
5210
|
/**
|
|
@@ -5198,9 +5212,9 @@ class Client$1 {
|
|
|
5198
5212
|
*
|
|
5199
5213
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/block-v2/message/create document }
|
|
5200
5214
|
*
|
|
5201
|
-
* Block
|
|
5215
|
+
* Block协同数据推送
|
|
5202
5216
|
*
|
|
5203
|
-
* 根据BlockID
|
|
5217
|
+
* 根据BlockID向指定用户列表推送协同数据。
|
|
5204
5218
|
*/
|
|
5205
5219
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
5206
5220
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -6489,7 +6503,7 @@ class Client$1 {
|
|
|
6489
6503
|
}),
|
|
6490
6504
|
},
|
|
6491
6505
|
/**
|
|
6492
|
-
*
|
|
6506
|
+
* 部门
|
|
6493
6507
|
*/
|
|
6494
6508
|
department: {
|
|
6495
6509
|
childrenWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -6547,9 +6561,9 @@ class Client$1 {
|
|
|
6547
6561
|
*
|
|
6548
6562
|
* 获取子部门列表
|
|
6549
6563
|
*
|
|
6550
|
-
* 通过部门ID获取部门的子部门列表。
|
|
6564
|
+
* 通过部门ID获取部门的子部门列表。
|
|
6551
6565
|
*
|
|
6552
|
-
* - 使用 user_access_token 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,最多1000个部门对该用户可见。;;- 使用
|
|
6566
|
+
* - 部门ID 必填,根部门的部门ID 为0。;- 使用 `user_access_token` 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,最多1000个部门对该用户可见。;;- 使用 ;`tenant_access_token` 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0,会检验应用是否有全员通讯录权限,如果是非0 部门ID,则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码,有权限则返回部门下子部门列表(根据fetch_child决定是否递归)。
|
|
6553
6567
|
*/
|
|
6554
6568
|
children: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
6555
6569
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -6573,7 +6587,7 @@ class Client$1 {
|
|
|
6573
6587
|
*
|
|
6574
6588
|
* 创建部门
|
|
6575
6589
|
*
|
|
6576
|
-
* 该接口用于向通讯录中创建部门。
|
|
6590
|
+
* 该接口用于向通讯录中创建部门。
|
|
6577
6591
|
*
|
|
6578
6592
|
* 只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门,则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。
|
|
6579
6593
|
*/
|
|
@@ -6599,7 +6613,7 @@ class Client$1 {
|
|
|
6599
6613
|
*
|
|
6600
6614
|
* 删除部门
|
|
6601
6615
|
*
|
|
6602
|
-
* 该接口用于向通讯录中删除部门。
|
|
6616
|
+
* 该接口用于向通讯录中删除部门。
|
|
6603
6617
|
*
|
|
6604
6618
|
* 应用需要同时拥有待删除部门及其父部门的通讯录授权。应用商店应用无权限调用该接口。
|
|
6605
6619
|
*/
|
|
@@ -6625,9 +6639,9 @@ class Client$1 {
|
|
|
6625
6639
|
*
|
|
6626
6640
|
* 获取单个部门信息
|
|
6627
6641
|
*
|
|
6628
|
-
* 该接口用于向通讯录获取单个部门信息。
|
|
6642
|
+
* 该接口用于向通讯录获取单个部门信息。
|
|
6629
6643
|
*
|
|
6630
|
-
*
|
|
6644
|
+
* - 使用`tenant_access_token`时,应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息,则需要拥有全员权限。;- 使用`user_access_token`时,用户需要有待查询部门的可见性,如果需要获取根部门信息,则要求员工可见所有人。
|
|
6631
6645
|
*/
|
|
6632
6646
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
6633
6647
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -6773,9 +6787,9 @@ class Client$1 {
|
|
|
6773
6787
|
*
|
|
6774
6788
|
* 获取父部门信息
|
|
6775
6789
|
*
|
|
6776
|
-
* 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。
|
|
6790
|
+
* 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。
|
|
6777
6791
|
*
|
|
6778
|
-
*
|
|
6792
|
+
* 使用`tenant_access_token`时,该接口只返回可见性范围内的父部门信息。;例如:A >>B>>C>>D四级部门,通讯录权限只到B,那么查询D部门的parent,会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息。
|
|
6779
6793
|
*/
|
|
6780
6794
|
parent: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
6781
6795
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -6797,9 +6811,9 @@ class Client$1 {
|
|
|
6797
6811
|
*
|
|
6798
6812
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch document }
|
|
6799
6813
|
*
|
|
6800
|
-
*
|
|
6814
|
+
* 修改部门部分信息
|
|
6801
6815
|
*
|
|
6802
|
-
* 该接口用于更新通讯录中部门的信息中的任一个字段。
|
|
6816
|
+
* 该接口用于更新通讯录中部门的信息中的任一个字段。
|
|
6803
6817
|
*
|
|
6804
6818
|
* 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。
|
|
6805
6819
|
*/
|
|
@@ -6873,9 +6887,9 @@ class Client$1 {
|
|
|
6873
6887
|
*
|
|
6874
6888
|
* 搜索部门
|
|
6875
6889
|
*
|
|
6876
|
-
* 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。
|
|
6890
|
+
* 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。
|
|
6877
6891
|
*
|
|
6878
|
-
*
|
|
6892
|
+
* 部门存在,但用户搜索不到并不一定是搜索有问题,可能是管理员在后台配置了权限控制,导致用户无法搜索到该部门。
|
|
6879
6893
|
*/
|
|
6880
6894
|
search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
6881
6895
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -6923,7 +6937,7 @@ class Client$1 {
|
|
|
6923
6937
|
*
|
|
6924
6938
|
* 更新部门所有信息
|
|
6925
6939
|
*
|
|
6926
|
-
* 该接口用于更新当前部门所有信息。
|
|
6940
|
+
* 该接口用于更新当前部门所有信息。
|
|
6927
6941
|
*
|
|
6928
6942
|
* - 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。;; - 没有填写的字段会被置为空值(order字段除外)。
|
|
6929
6943
|
*/
|
|
@@ -7729,7 +7743,7 @@ class Client$1 {
|
|
|
7729
7743
|
*
|
|
7730
7744
|
* 创建用户
|
|
7731
7745
|
*
|
|
7732
|
-
* 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
|
|
7746
|
+
* 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
|
|
7733
7747
|
*
|
|
7734
7748
|
* - 新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户,如果想要在根部门下新增用户,必须要有全员权限。;- 应用商店应用无权限调用此接口。;- 创建用户后,会给用户发送邀请短信/邮件,用户在操作同意后才可访问团队。;- 返回数据中不返回手机号,如果需要请重新查询用户信息获取手机号。
|
|
7735
7749
|
*/
|
|
@@ -7755,9 +7769,9 @@ class Client$1 {
|
|
|
7755
7769
|
*
|
|
7756
7770
|
* 删除用户
|
|
7757
7771
|
*
|
|
7758
|
-
* 该接口向通讯录删除一个用户信息,可以理解为员工离职。
|
|
7772
|
+
* 该接口向通讯录删除一个用户信息,可以理解为员工离职。
|
|
7759
7773
|
*
|
|
7760
|
-
* 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B
|
|
7774
|
+
* - 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。;- 应用商店应用无权限调用接口。;- 用户可以在删除员工时设置删除员工数据的接收者,如果不设置则由其leader接收,如果该员工没有leader,则会将该员工的数据删除。
|
|
7761
7775
|
*/
|
|
7762
7776
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
7763
7777
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -7829,9 +7843,9 @@ class Client$1 {
|
|
|
7829
7843
|
*
|
|
7830
7844
|
* 获取部门直属用户列表
|
|
7831
7845
|
*
|
|
7832
|
-
* 基于部门ID
|
|
7846
|
+
* 基于部门ID获取部门直属用户列表。
|
|
7833
7847
|
*
|
|
7834
|
-
* - 使用 user_access_token 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;-
|
|
7848
|
+
* - 部门ID 必填,根部门的部门ID为0。;- 使用 `user_access_token` 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;- 使用`tenant_access_token`会根据应用通讯录的范围进行权限过滤。 如果请求的部门ID为0,则校验应用是否具有全员通讯录权限; 如果是非0的部门ID,则会验证应用是否具有该部门的通讯录权限。 无权限返回无权限错误码,有权限则返回对应部门下的直接用户列表。
|
|
7835
7849
|
*/
|
|
7836
7850
|
findByDepartment: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
7837
7851
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -7855,7 +7869,7 @@ class Client$1 {
|
|
|
7855
7869
|
*
|
|
7856
7870
|
* 获取单个用户信息
|
|
7857
7871
|
*
|
|
7858
|
-
*
|
|
7872
|
+
* 该接口用于获取通讯录中单个用户的信息。
|
|
7859
7873
|
*/
|
|
7860
7874
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
7861
7875
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -7953,7 +7967,7 @@ class Client$1 {
|
|
|
7953
7967
|
*
|
|
7954
7968
|
* 修改用户部分信息
|
|
7955
7969
|
*
|
|
7956
|
-
* 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。
|
|
7970
|
+
* 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。
|
|
7957
7971
|
*/
|
|
7958
7972
|
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
7959
7973
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -7977,9 +7991,9 @@ class Client$1 {
|
|
|
7977
7991
|
*
|
|
7978
7992
|
* 更新用户所有信息
|
|
7979
7993
|
*
|
|
7980
|
-
* 该接口用于更新通讯录中用户的字段。
|
|
7994
|
+
* 该接口用于更新通讯录中用户的字段。
|
|
7981
7995
|
*
|
|
7982
|
-
*
|
|
7996
|
+
* 应用需要拥有待更新用户的通讯录授权,如果涉及到用户部门变更,还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。
|
|
7983
7997
|
*/
|
|
7984
7998
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
7985
7999
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -8031,6 +8045,8 @@ class Client$1 {
|
|
|
8031
8045
|
*
|
|
8032
8046
|
* 批量更新块的富文本内容。
|
|
8033
8047
|
*
|
|
8048
|
+
* 频率限制:单个应用调用频率上限为每秒 3 次。
|
|
8049
|
+
*
|
|
8034
8050
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnMiwAKCiE6oQEkPyhvmmQEe),了解相关规则及约束。
|
|
8035
8051
|
*/
|
|
8036
8052
|
batchUpdate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8057,6 +8073,8 @@ class Client$1 {
|
|
|
8057
8073
|
*
|
|
8058
8074
|
* 获取指定块的富文本内容。
|
|
8059
8075
|
*
|
|
8076
|
+
* 频率限制:单个应用调用频率上限为每秒 5 次。
|
|
8077
|
+
*
|
|
8060
8078
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnamKaccZKqIMopnREJCZUMe#doxcnWEMWYAg2YMkEq0SZXHzaih),了解相关规则及约束。
|
|
8061
8079
|
*/
|
|
8062
8080
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8131,6 +8149,8 @@ class Client$1 {
|
|
|
8131
8149
|
*
|
|
8132
8150
|
* 获取文档所有块的富文本内容并分页返回。
|
|
8133
8151
|
*
|
|
8152
|
+
* 频率限制:单个应用调用频率上限为每秒 5 次。
|
|
8153
|
+
*
|
|
8134
8154
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnamKaccZKqIMopnREJCZUMe#doxcn6AkCE2AUUm2WwxID7lS7Xc),了解相关规则及约束。
|
|
8135
8155
|
*/
|
|
8136
8156
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8157,6 +8177,8 @@ class Client$1 {
|
|
|
8157
8177
|
*
|
|
8158
8178
|
* 更新指定的块。
|
|
8159
8179
|
*
|
|
8180
|
+
* 频率限制:单个应用调用频率上限为每秒 3 次。
|
|
8181
|
+
*
|
|
8160
8182
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnEeyS0I8MMqoieIMpK7jm8g),了解相关规则及约束。
|
|
8161
8183
|
*/
|
|
8162
8184
|
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8176,7 +8198,7 @@ class Client$1 {
|
|
|
8176
8198
|
}),
|
|
8177
8199
|
},
|
|
8178
8200
|
/**
|
|
8179
|
-
*
|
|
8201
|
+
* document.block.children
|
|
8180
8202
|
*/
|
|
8181
8203
|
documentBlockChildren: {
|
|
8182
8204
|
/**
|
|
@@ -8188,6 +8210,8 @@ class Client$1 {
|
|
|
8188
8210
|
*
|
|
8189
8211
|
* 指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的文档版本号。
|
|
8190
8212
|
*
|
|
8213
|
+
* 频率限制:单个应用调用频率上限为每秒 3 次。
|
|
8214
|
+
*
|
|
8191
8215
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcngCsscGk0WacO258mYDgM6b),了解相关规则及约束。
|
|
8192
8216
|
*/
|
|
8193
8217
|
batchDelete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8214,6 +8238,8 @@ class Client$1 {
|
|
|
8214
8238
|
*
|
|
8215
8239
|
* 指定需要操作的块,为其创建一批子块,并插入到指定位置。如果操作成功,接口将返回新创建子块的富文本内容。
|
|
8216
8240
|
*
|
|
8241
|
+
* 频率限制:单个应用调用频率上限为每秒 3 次。
|
|
8242
|
+
*
|
|
8217
8243
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnm0ooUe0s20GwwVB3a05rtb),了解相关规则及约束。
|
|
8218
8244
|
*/
|
|
8219
8245
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8288,6 +8314,8 @@ class Client$1 {
|
|
|
8288
8314
|
*
|
|
8289
8315
|
* 给定一个指定版本的文档,并指定需要操作的块,分页遍历其所有子块富文本内容 。如果不指定版本,则会默认查询最新版本。
|
|
8290
8316
|
*
|
|
8317
|
+
* 频率限制:单个应用调用频率上限为每秒 5 次。
|
|
8318
|
+
*
|
|
8291
8319
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnE2UK2yY0gEGK8nBMPtB0vd),了解相关规则及约束。
|
|
8292
8320
|
*/
|
|
8293
8321
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8319,6 +8347,8 @@ class Client$1 {
|
|
|
8319
8347
|
*
|
|
8320
8348
|
* 创建新版文档,文档标题和目录可选。
|
|
8321
8349
|
*
|
|
8350
|
+
* 频率限制:单个应用调用频率上限为每秒 3 次。
|
|
8351
|
+
*
|
|
8322
8352
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnyoyCgwS8ywWwMtQr9yjZ2f),了解相关规则及约束。
|
|
8323
8353
|
*/
|
|
8324
8354
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8345,6 +8375,8 @@ class Client$1 {
|
|
|
8345
8375
|
*
|
|
8346
8376
|
* 获取文档最新版本号、标题等
|
|
8347
8377
|
*
|
|
8378
|
+
* 频率限制:单个应用调用频率上限为每秒 5 次。
|
|
8379
|
+
*
|
|
8348
8380
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnWKAE4aSaIU4GcdLInSaVde),了解相关规则及约束。
|
|
8349
8381
|
*/
|
|
8350
8382
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8371,6 +8403,8 @@ class Client$1 {
|
|
|
8371
8403
|
*
|
|
8372
8404
|
* 获取文档的纯文本内容。
|
|
8373
8405
|
*
|
|
8406
|
+
* 频率限制:单个应用调用频率上限为每秒 5 次。
|
|
8407
|
+
*
|
|
8374
8408
|
* 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnQeqI4wiKIMis6GNvCOBuqg),了解相关规则及约束。
|
|
8375
8409
|
*/
|
|
8376
8410
|
rawContent: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -8591,11 +8625,9 @@ class Client$1 {
|
|
|
8591
8625
|
*
|
|
8592
8626
|
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list document }
|
|
8593
8627
|
*
|
|
8594
|
-
*
|
|
8595
|
-
*
|
|
8596
|
-
* 通过分页方式获取云文档中的全文评论列表。
|
|
8628
|
+
* 获取文档评论
|
|
8597
8629
|
*
|
|
8598
|
-
*
|
|
8630
|
+
* 根据文档token分页获取云文档中的评论。
|
|
8599
8631
|
*/
|
|
8600
8632
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
8601
8633
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -8691,7 +8723,7 @@ class Client$1 {
|
|
|
8691
8723
|
}),
|
|
8692
8724
|
},
|
|
8693
8725
|
/**
|
|
8694
|
-
*
|
|
8726
|
+
* 下载
|
|
8695
8727
|
*/
|
|
8696
8728
|
file: {
|
|
8697
8729
|
/**
|
|
@@ -8918,7 +8950,7 @@ class Client$1 {
|
|
|
8918
8950
|
*
|
|
8919
8951
|
* 订阅云文档事件
|
|
8920
8952
|
*
|
|
8921
|
-
*
|
|
8953
|
+
* 该接口仅支持**文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a),事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
|
|
8922
8954
|
*/
|
|
8923
8955
|
subscribe: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
8924
8956
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -9071,7 +9103,7 @@ class Client$1 {
|
|
|
9071
9103
|
}),
|
|
9072
9104
|
},
|
|
9073
9105
|
/**
|
|
9074
|
-
*
|
|
9106
|
+
* file.statistics
|
|
9075
9107
|
*/
|
|
9076
9108
|
fileStatistics: {
|
|
9077
9109
|
/**
|
|
@@ -9230,7 +9262,7 @@ class Client$1 {
|
|
|
9230
9262
|
}),
|
|
9231
9263
|
},
|
|
9232
9264
|
/**
|
|
9233
|
-
*
|
|
9265
|
+
* 素材
|
|
9234
9266
|
*/
|
|
9235
9267
|
media: {
|
|
9236
9268
|
/**
|
|
@@ -9412,7 +9444,7 @@ class Client$1 {
|
|
|
9412
9444
|
}),
|
|
9413
9445
|
},
|
|
9414
9446
|
/**
|
|
9415
|
-
*
|
|
9447
|
+
* meta
|
|
9416
9448
|
*/
|
|
9417
9449
|
meta: {
|
|
9418
9450
|
/**
|
|
@@ -9492,6 +9524,32 @@ class Client$1 {
|
|
|
9492
9524
|
throw e;
|
|
9493
9525
|
});
|
|
9494
9526
|
}),
|
|
9527
|
+
/**
|
|
9528
|
+
* {@link https://open.feishu.cn/api-explorer?project=drive&resource=permission.member&apiName=list&version=v1 click to debug }
|
|
9529
|
+
*
|
|
9530
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list document }
|
|
9531
|
+
*
|
|
9532
|
+
* 获取协作者列表
|
|
9533
|
+
*
|
|
9534
|
+
* 该接口用于根据 filetoken 查询协作者
|
|
9535
|
+
*
|
|
9536
|
+
* - 你能获取到协作者列表的前提是你对该文档有分享权限;- 目前仅支持人、群、组织架构三种类型的协作者
|
|
9537
|
+
*/
|
|
9538
|
+
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
9539
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
9540
|
+
return httpInstance
|
|
9541
|
+
.request({
|
|
9542
|
+
url: fillApiPath(`${this.domain}/open-apis/drive/v1/permissions/:token/members`, path),
|
|
9543
|
+
method: "GET",
|
|
9544
|
+
data,
|
|
9545
|
+
params,
|
|
9546
|
+
headers,
|
|
9547
|
+
})
|
|
9548
|
+
.catch((e) => {
|
|
9549
|
+
this.logger.error(formatErrors(e));
|
|
9550
|
+
throw e;
|
|
9551
|
+
});
|
|
9552
|
+
}),
|
|
9495
9553
|
/**
|
|
9496
9554
|
* {@link https://open.feishu.cn/api-explorer?project=drive&resource=permission.member&apiName=update&version=v1 click to debug }
|
|
9497
9555
|
*
|
|
@@ -9714,7 +9772,7 @@ class Client$1 {
|
|
|
9714
9772
|
*/
|
|
9715
9773
|
this.event = {
|
|
9716
9774
|
/**
|
|
9717
|
-
*
|
|
9775
|
+
* 事件订阅
|
|
9718
9776
|
*/
|
|
9719
9777
|
outboundIp: {
|
|
9720
9778
|
listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -9770,11 +9828,11 @@ class Client$1 {
|
|
|
9770
9828
|
*
|
|
9771
9829
|
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list document }
|
|
9772
9830
|
*
|
|
9773
|
-
* 获取事件出口IP
|
|
9831
|
+
* 获取事件出口 IP
|
|
9774
9832
|
*
|
|
9775
|
-
* 飞书开放平台向应用配置的回调地址推送事件时,是通过特定的IP
|
|
9833
|
+
* 飞书开放平台向应用配置的回调地址推送事件时,是通过特定的 IP 发送出去的,应用可以通过本接口获取所有相关的 IP 地址。
|
|
9776
9834
|
*
|
|
9777
|
-
* IP
|
|
9835
|
+
* IP 地址有变更可能,建议应用每隔 6 小时定时拉取最新的 IP 地址,以免由于企业防火墙设置,导致应用无法及时接收到飞书开放平台推送的事件。
|
|
9778
9836
|
*/
|
|
9779
9837
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
9780
9838
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -10090,7 +10148,7 @@ class Client$1 {
|
|
|
10090
10148
|
}),
|
|
10091
10149
|
},
|
|
10092
10150
|
/**
|
|
10093
|
-
*
|
|
10151
|
+
* agent_schedule
|
|
10094
10152
|
*/
|
|
10095
10153
|
agentSchedule: {
|
|
10096
10154
|
/**
|
|
@@ -11410,7 +11468,7 @@ class Client$1 {
|
|
|
11410
11468
|
/**
|
|
11411
11469
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=create&version=v1 click to debug }
|
|
11412
11470
|
*
|
|
11413
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11471
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/create_application document }
|
|
11414
11472
|
*
|
|
11415
11473
|
* 创建投递
|
|
11416
11474
|
*
|
|
@@ -11434,7 +11492,7 @@ class Client$1 {
|
|
|
11434
11492
|
/**
|
|
11435
11493
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=get&version=v1 click to debug }
|
|
11436
11494
|
*
|
|
11437
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11495
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application document }
|
|
11438
11496
|
*
|
|
11439
11497
|
* 获取投递信息
|
|
11440
11498
|
*
|
|
@@ -11458,7 +11516,7 @@ class Client$1 {
|
|
|
11458
11516
|
/**
|
|
11459
11517
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=list&version=v1 click to debug }
|
|
11460
11518
|
*
|
|
11461
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11519
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application-list document }
|
|
11462
11520
|
*
|
|
11463
11521
|
* 获取投递列表
|
|
11464
11522
|
*
|
|
@@ -11482,7 +11540,7 @@ class Client$1 {
|
|
|
11482
11540
|
/**
|
|
11483
11541
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=offer&version=v1 click to debug }
|
|
11484
11542
|
*
|
|
11485
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11543
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application-offer document }
|
|
11486
11544
|
*
|
|
11487
11545
|
* 获取 Offer 信息
|
|
11488
11546
|
*
|
|
@@ -11506,7 +11564,7 @@ class Client$1 {
|
|
|
11506
11564
|
/**
|
|
11507
11565
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=terminate&version=v1 click to debug }
|
|
11508
11566
|
*
|
|
11509
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11567
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/terminate-application document }
|
|
11510
11568
|
*
|
|
11511
11569
|
* 终止投递
|
|
11512
11570
|
*
|
|
@@ -11530,7 +11588,7 @@ class Client$1 {
|
|
|
11530
11588
|
/**
|
|
11531
11589
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=transfer_onboard&version=v1 click to debug }
|
|
11532
11590
|
*
|
|
11533
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
11591
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uczM1YjL3MTN24yNzUjN document }
|
|
11534
11592
|
*
|
|
11535
11593
|
* 操作候选人入职
|
|
11536
11594
|
*
|
|
@@ -11718,7 +11776,7 @@ class Client$1 {
|
|
|
11718
11776
|
/**
|
|
11719
11777
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=job&apiName=get&version=v1 click to debug }
|
|
11720
11778
|
*
|
|
11721
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/
|
|
11779
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/job/get-job document }
|
|
11722
11780
|
*
|
|
11723
11781
|
* 获取职位信息
|
|
11724
11782
|
*
|
|
@@ -11741,7 +11799,7 @@ class Client$1 {
|
|
|
11741
11799
|
}),
|
|
11742
11800
|
},
|
|
11743
11801
|
/**
|
|
11744
|
-
*
|
|
11802
|
+
* job.manager
|
|
11745
11803
|
*/
|
|
11746
11804
|
jobManager: {
|
|
11747
11805
|
/**
|
|
@@ -11776,7 +11834,7 @@ class Client$1 {
|
|
|
11776
11834
|
/**
|
|
11777
11835
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=job_process&apiName=list&version=v1 click to debug }
|
|
11778
11836
|
*
|
|
11779
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/
|
|
11837
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/jop-process/get-process document }
|
|
11780
11838
|
*
|
|
11781
11839
|
* 获取招聘流程信息
|
|
11782
11840
|
*
|
|
@@ -12041,7 +12099,7 @@ class Client$1 {
|
|
|
12041
12099
|
/**
|
|
12042
12100
|
* {@link https://open.feishu.cn/api-explorer?project=hire&resource=talent&apiName=get&version=v1 click to debug }
|
|
12043
12101
|
*
|
|
12044
|
-
* {@link https://open.feishu.cn/document/ukTMukTMukTM/
|
|
12102
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uUzM1YjL1MTN24SNzUjN/get-talent document }
|
|
12045
12103
|
*
|
|
12046
12104
|
* 获取人才信息
|
|
12047
12105
|
*
|
|
@@ -12115,9 +12173,9 @@ class Client$1 {
|
|
|
12115
12173
|
*
|
|
12116
12174
|
* 批量撤回消息
|
|
12117
12175
|
*
|
|
12118
|
-
*
|
|
12176
|
+
* 批量撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息。
|
|
12119
12177
|
*
|
|
12120
|
-
* 注意事项:;-
|
|
12178
|
+
* 注意事项:;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息,所以为异步接口,会有一定延迟。
|
|
12121
12179
|
*/
|
|
12122
12180
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12123
12181
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12141,9 +12199,9 @@ class Client$1 {
|
|
|
12141
12199
|
*
|
|
12142
12200
|
* 查询批量消息整体进度
|
|
12143
12201
|
*
|
|
12144
|
-
*
|
|
12202
|
+
* 该接口在[查询批量消息推送和阅读人数](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)查询结果的基础上,增加了批量请求中有效的userid数量以及消息撤回进度数据。
|
|
12145
12203
|
*
|
|
12146
|
-
* 注意事项:;*
|
|
12204
|
+
* 注意事项:;* 该接口返回的数据为查询时刻的快照数据
|
|
12147
12205
|
*/
|
|
12148
12206
|
getProgress: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12149
12207
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12167,9 +12225,9 @@ class Client$1 {
|
|
|
12167
12225
|
*
|
|
12168
12226
|
* 查询批量消息推送和阅读人数
|
|
12169
12227
|
*
|
|
12170
|
-
*
|
|
12228
|
+
* 批量发送消息后,可以通过该接口查询批量消息推送的总人数和阅读人数。
|
|
12171
12229
|
*
|
|
12172
|
-
* 注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;-
|
|
12230
|
+
* 注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;- 该接口返回的数据为查询时刻的快照数据
|
|
12173
12231
|
*/
|
|
12174
12232
|
readUser: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12175
12233
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12257,7 +12315,7 @@ class Client$1 {
|
|
|
12257
12315
|
*
|
|
12258
12316
|
* 创建群并设置群头像、群名、群描述等。
|
|
12259
12317
|
*
|
|
12260
|
-
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);-
|
|
12318
|
+
* 注意事项:; - 应用需要开启[机器人能力](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)接口
|
|
12261
12319
|
*/
|
|
12262
12320
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12263
12321
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12281,9 +12339,9 @@ class Client$1 {
|
|
|
12281
12339
|
*
|
|
12282
12340
|
* 解散群
|
|
12283
12341
|
*
|
|
12284
|
-
*
|
|
12342
|
+
* 解散群组。
|
|
12285
12343
|
*
|
|
12286
|
-
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token
|
|
12344
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token,需要机器人符合以下任一情况才可解散群:; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token,需要对应的用户是群主才可解散群;- 解散外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
12287
12345
|
*/
|
|
12288
12346
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12289
12347
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12309,7 +12367,7 @@ class Client$1 {
|
|
|
12309
12367
|
*
|
|
12310
12368
|
* 获取群名称、群描述、群头像、群主 ID 等群基本信息。
|
|
12311
12369
|
*
|
|
12312
|
-
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); -
|
|
12370
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群里(否则只会返回群名称、群头像等基本信息);- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
12313
12371
|
*/
|
|
12314
12372
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12315
12373
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12335,7 +12393,7 @@ class Client$1 {
|
|
|
12335
12393
|
*
|
|
12336
12394
|
* 获取指定群的分享链接
|
|
12337
12395
|
*
|
|
12338
|
-
* 注意事项:;-
|
|
12396
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时,仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时,操作者须与群组在同一租户下;- 获取外部群分享链接时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
12339
12397
|
*/
|
|
12340
12398
|
link: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12341
12399
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12409,7 +12467,7 @@ class Client$1 {
|
|
|
12409
12467
|
*
|
|
12410
12468
|
* 获取用户或者机器人所在群列表。
|
|
12411
12469
|
*
|
|
12412
|
-
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);-
|
|
12470
|
+
* 注意事项:; - 应用需要开启[机器人能力](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/get)的请求 URL;- 获取的群列表不包含p2p单聊群
|
|
12413
12471
|
*/
|
|
12414
12472
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12415
12473
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12509,7 +12567,7 @@ class Client$1 {
|
|
|
12509
12567
|
*
|
|
12510
12568
|
* 更新群头像、群名称、群描述、群配置、转让群主等。
|
|
12511
12569
|
*
|
|
12512
|
-
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);-
|
|
12570
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 对于群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新所有信息;- 对于不满足上述权限条件的群成员或机器人:; - 若未开启 ==仅群主和群管理员可编辑群信息== 配置,仅可更新群头像、群名称、群描述、群国际化名称信息; - 若开启了 ==仅群主和群管理员可编辑群信息== 配置,任何群信息都不能修改;- 更新外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
12513
12571
|
*/
|
|
12514
12572
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12515
12573
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12564,7 +12622,7 @@ class Client$1 {
|
|
|
12564
12622
|
*
|
|
12565
12623
|
* 删除群管理员
|
|
12566
12624
|
*
|
|
12567
|
-
*
|
|
12625
|
+
* 删除指定的群管理员(用户或机器人)。
|
|
12568
12626
|
*
|
|
12569
12627
|
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
|
|
12570
12628
|
*/
|
|
@@ -12597,7 +12655,7 @@ class Client$1 {
|
|
|
12597
12655
|
*
|
|
12598
12656
|
* 将用户或机器人拉入群聊。
|
|
12599
12657
|
*
|
|
12600
|
-
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); -
|
|
12658
|
+
* 注意事项:; - 应用需要开启[机器人能力](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); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时,仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时,所有群成员都可以拉用户或机器人进群
|
|
12601
12659
|
*/
|
|
12602
12660
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12603
12661
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12623,7 +12681,7 @@ class Client$1 {
|
|
|
12623
12681
|
*
|
|
12624
12682
|
* 将用户或机器人移出群聊。
|
|
12625
12683
|
*
|
|
12626
|
-
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5
|
|
12684
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人
|
|
12627
12685
|
*/
|
|
12628
12686
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12629
12687
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12766,7 +12824,7 @@ class Client$1 {
|
|
|
12766
12824
|
}),
|
|
12767
12825
|
},
|
|
12768
12826
|
/**
|
|
12769
|
-
*
|
|
12827
|
+
* chat.moderation
|
|
12770
12828
|
*/
|
|
12771
12829
|
chatModeration: {
|
|
12772
12830
|
getWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -12852,7 +12910,7 @@ class Client$1 {
|
|
|
12852
12910
|
*
|
|
12853
12911
|
* 更新群组的发言权限设置,可设置为全员可发言、仅管理员可发言 或 指定用户可发言。
|
|
12854
12912
|
*
|
|
12855
|
-
* 注意事项:; - 需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM);- 若以用户授权调用接口,**当授权用户是群主**时,可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口),当**机器人是群主** 或者
|
|
12913
|
+
* 注意事项:; - 需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM);- 若以用户授权调用接口,**当授权用户是群主**时,可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口),当**机器人是群主** 或者 **机器人是群组创建者、具备==更新应用所创建群的群信息==权限且仍在群内**时,可更新群发言权限
|
|
12856
12914
|
*/
|
|
12857
12915
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12858
12916
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13002,7 +13060,7 @@ class Client$1 {
|
|
|
13002
13060
|
}),
|
|
13003
13061
|
},
|
|
13004
13062
|
/**
|
|
13005
|
-
*
|
|
13063
|
+
* chat.top_notice
|
|
13006
13064
|
*/
|
|
13007
13065
|
chatTopNotice: {
|
|
13008
13066
|
/**
|
|
@@ -13012,7 +13070,9 @@ class Client$1 {
|
|
|
13012
13070
|
*
|
|
13013
13071
|
* 撤销群置顶
|
|
13014
13072
|
*
|
|
13015
|
-
*
|
|
13073
|
+
* 撤销会话中的置顶。
|
|
13074
|
+
*
|
|
13075
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 撤销内部群置顶时,操作者须与群组在同一租户下;- 撤销外部群置顶时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
13016
13076
|
*/
|
|
13017
13077
|
deleteTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13018
13078
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13037,6 +13097,8 @@ class Client$1 {
|
|
|
13037
13097
|
* 更新群置顶
|
|
13038
13098
|
*
|
|
13039
13099
|
* 更新会话中的群置顶信息,可以将群中的某一条消息,或者群公告置顶显示。
|
|
13100
|
+
*
|
|
13101
|
+
* 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 更新内部群置顶时,操作者须与群组在同一租户下;- 更新外部群置顶时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
|
|
13040
13102
|
*/
|
|
13041
13103
|
putTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13042
13104
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13065,9 +13127,9 @@ class Client$1 {
|
|
|
13065
13127
|
*
|
|
13066
13128
|
* 上传文件
|
|
13067
13129
|
*
|
|
13068
|
-
*
|
|
13130
|
+
* 上传文件,可以上传视频,音频和常见的文件类型。
|
|
13069
13131
|
*
|
|
13070
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);-
|
|
13132
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 文件大小不得超过30M,且不允许上传空文件
|
|
13071
13133
|
*/
|
|
13072
13134
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13073
13135
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13092,9 +13154,9 @@ class Client$1 {
|
|
|
13092
13154
|
*
|
|
13093
13155
|
* 下载文件
|
|
13094
13156
|
*
|
|
13095
|
-
*
|
|
13157
|
+
* 下载文件接口,只能下载应用自己上传的文件。
|
|
13096
13158
|
*
|
|
13097
|
-
* 注意事项:;- 需要开启[机器人能力](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)
|
|
13159
|
+
* 注意事项:;- 需要开启[机器人能力](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)接口;- 下载的资源大小不能超过100M;- 如果需要Content-Disposition header,发起请求的时候需要在header中设置Content-Type为application/json
|
|
13098
13160
|
*/
|
|
13099
13161
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13100
13162
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13138,9 +13200,9 @@ class Client$1 {
|
|
|
13138
13200
|
*
|
|
13139
13201
|
* 上传图片
|
|
13140
13202
|
*
|
|
13141
|
-
*
|
|
13203
|
+
* 上传图片接口,支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。
|
|
13142
13204
|
*
|
|
13143
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);-
|
|
13205
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 图片大小不得超过10M,且不支持上传大小为0的图片
|
|
13144
13206
|
*/
|
|
13145
13207
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13146
13208
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13165,9 +13227,9 @@ class Client$1 {
|
|
|
13165
13227
|
*
|
|
13166
13228
|
* 下载图片
|
|
13167
13229
|
*
|
|
13168
|
-
*
|
|
13230
|
+
* 下载图片资源,只能下载当前应用所上传且图片类型为message的图片。
|
|
13169
13231
|
*
|
|
13170
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传且图片类型为message的图片,avatar
|
|
13232
|
+
* 注意事项:;- 需要开启[机器人能力](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)接口
|
|
13171
13233
|
*/
|
|
13172
13234
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13173
13235
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13201,7 +13263,7 @@ class Client$1 {
|
|
|
13201
13263
|
}),
|
|
13202
13264
|
},
|
|
13203
13265
|
/**
|
|
13204
|
-
*
|
|
13266
|
+
* 消息 - 消息卡片
|
|
13205
13267
|
*/
|
|
13206
13268
|
message: {
|
|
13207
13269
|
/**
|
|
@@ -13213,7 +13275,7 @@ class Client$1 {
|
|
|
13213
13275
|
*
|
|
13214
13276
|
* 给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
|
|
13215
13277
|
*
|
|
13216
|
-
* 注意事项:;- 需要开启[机器人能力](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);-
|
|
13278
|
+
* 注意事项:;- 需要开启[机器人能力](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);- 给群组发送消息,需要机器人在群组中
|
|
13217
13279
|
*/
|
|
13218
13280
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13219
13281
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13239,7 +13301,7 @@ class Client$1 {
|
|
|
13239
13301
|
*
|
|
13240
13302
|
* 机器人撤回机器人自己发送的消息或群主撤回群内消息。
|
|
13241
13303
|
*
|
|
13242
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内,自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息,则机器人必须是该群的群主、管理员 或者 创建者,且消息发送时间不超过1年;-
|
|
13304
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内,自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息,则机器人必须是该群的群主、管理员 或者 创建者,且消息发送时间不超过1年;- 无法撤回通过「[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)」接口发送的消息
|
|
13243
13305
|
*/
|
|
13244
13306
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13245
13307
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13263,7 +13325,7 @@ class Client$1 {
|
|
|
13263
13325
|
*
|
|
13264
13326
|
* 获取指定消息的内容
|
|
13265
13327
|
*
|
|
13266
|
-
* 通过 message_id
|
|
13328
|
+
* 通过 message_id 查询消息内容。
|
|
13267
13329
|
*
|
|
13268
13330
|
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 机器人必须在群组中
|
|
13269
13331
|
*/
|
|
@@ -13333,7 +13395,7 @@ class Client$1 {
|
|
|
13333
13395
|
/**
|
|
13334
13396
|
* {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=list&version=v1 click to debug }
|
|
13335
13397
|
*
|
|
13336
|
-
* {@link https://open.feishu.cn/document/
|
|
13398
|
+
* {@link https://open.feishu.cn/document/ukTMukTMukTM/uADO3YjLwgzN24CM4cjN document }
|
|
13337
13399
|
*
|
|
13338
13400
|
* 获取会话历史消息
|
|
13339
13401
|
*
|
|
@@ -13367,7 +13429,7 @@ class Client$1 {
|
|
|
13367
13429
|
*
|
|
13368
13430
|
* 更新应用已发送的消息卡片内容。
|
|
13369
13431
|
*
|
|
13370
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
|
|
13432
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若以user_access_token更新消息,该操作用户必须是卡片消息的发送者;- 对所有人更新[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN),需在卡片的config属性中,显式声明`"update_multi":true`。 更新特定人的卡片内容,必须在用户对卡片进行交互操作后触发调用,参考[「独享卡片」](https://open.feishu.cn/document/ukTMukTMukTM/uYjNwUjL2YDM14iN2ATN#49904b71) ;- 当前仅支持更新未撤回的 **卡片消息**;- **不支持更新批量消息**;- 文本消息请求体最大不能超过150KB;卡片及富文本消息请求体最大不能超过30KB;- 仅支持修改14天内发送的消息;- 单条消息更新频控为**5QPS**
|
|
13371
13433
|
*/
|
|
13372
13434
|
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13373
13435
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13419,7 +13481,7 @@ class Client$1 {
|
|
|
13419
13481
|
*
|
|
13420
13482
|
* 回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
|
|
13421
13483
|
*
|
|
13422
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;-
|
|
13484
|
+
* 注意事项:;- 需要开启[机器人能力](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);- 回复群组消息,需要机器人在群中
|
|
13423
13485
|
*/
|
|
13424
13486
|
reply: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13425
13487
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13445,7 +13507,9 @@ class Client$1 {
|
|
|
13445
13507
|
*
|
|
13446
13508
|
* 对指定消息进行应用内加急。
|
|
13447
13509
|
*
|
|
13448
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;-
|
|
13510
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 不支持加急批量消息;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群中;- 调用本接口需要用户已阅读加急的消息才可以继续加急(用户未读的加急上限为200条)
|
|
13511
|
+
*
|
|
13512
|
+
* 特别说明:;- 默认接口限流为50 QPS,请谨慎调用
|
|
13449
13513
|
*/
|
|
13450
13514
|
urgentApp: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13451
13515
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13469,11 +13533,11 @@ class Client$1 {
|
|
|
13469
13533
|
*
|
|
13470
13534
|
* 发送电话加急
|
|
13471
13535
|
*
|
|
13472
|
-
*
|
|
13536
|
+
* 对指定消息进行应用内加急与电话加急。
|
|
13473
13537
|
*
|
|
13474
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;-
|
|
13538
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群组中;- 需要用户阅读已加急的消息才可以继续加急(用户未读的加急上限为200条)
|
|
13475
13539
|
*
|
|
13476
|
-
* 特别说明:;-
|
|
13540
|
+
* 特别说明:;- 通过接口产生的电话加急将消耗企业的加急额度,请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS,请谨慎调用
|
|
13477
13541
|
*/
|
|
13478
13542
|
urgentPhone: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13479
13543
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13499,9 +13563,9 @@ class Client$1 {
|
|
|
13499
13563
|
*
|
|
13500
13564
|
* 对指定消息进行应用内加急与短信加急。
|
|
13501
13565
|
*
|
|
13502
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;-
|
|
13566
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在加急消息所在的群组中;- 调用本接口需要用户已阅读加急的消息才可以继续加急(用户未读的加急上限为200条)
|
|
13503
13567
|
*
|
|
13504
|
-
* 特别说明:;-
|
|
13568
|
+
* 特别说明:;- 通过接口产生的短信加急将消耗企业的加急额度,请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS,请谨慎调用
|
|
13505
13569
|
*/
|
|
13506
13570
|
urgentSms: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13507
13571
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13530,7 +13594,7 @@ class Client$1 {
|
|
|
13530
13594
|
*
|
|
13531
13595
|
* 添加消息表情回复
|
|
13532
13596
|
*
|
|
13533
|
-
* 给指定消息添加指定类型的表情回复(reaction
|
|
13597
|
+
* 给指定消息添加指定类型的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
|
|
13534
13598
|
*
|
|
13535
13599
|
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待添加reaction的消息要真实存在,不能被撤回;- 给消息添加reaction,需要reaction的发送方(机器人或者用户)在消息所在的会话内
|
|
13536
13600
|
*/
|
|
@@ -13556,7 +13620,7 @@ class Client$1 {
|
|
|
13556
13620
|
*
|
|
13557
13621
|
* 删除消息表情回复
|
|
13558
13622
|
*
|
|
13559
|
-
* 删除指定消息的表情回复(reaction
|
|
13623
|
+
* 删除指定消息的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
|
|
13560
13624
|
*
|
|
13561
13625
|
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能删除真实存在的reaction,并且删除reaction请求的操作者必须是reaction的原始添加者
|
|
13562
13626
|
*/
|
|
@@ -13630,7 +13694,7 @@ class Client$1 {
|
|
|
13630
13694
|
*
|
|
13631
13695
|
* 获取消息表情回复
|
|
13632
13696
|
*
|
|
13633
|
-
* 获取指定消息的特定类型表情回复列表(reaction
|
|
13697
|
+
* 获取指定消息的特定类型表情回复列表(reaction即表情回复,本文档统一用“reaction”代称)。
|
|
13634
13698
|
*
|
|
13635
13699
|
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待获取reaction信息的消息要真实存在,不能被撤回;- 获取消息的reaction,需要request的授权主体(机器人或者用户)在消息所在的会话内
|
|
13636
13700
|
*/
|
|
@@ -13651,7 +13715,7 @@ class Client$1 {
|
|
|
13651
13715
|
}),
|
|
13652
13716
|
},
|
|
13653
13717
|
/**
|
|
13654
|
-
*
|
|
13718
|
+
* message.resource
|
|
13655
13719
|
*/
|
|
13656
13720
|
messageResource: {
|
|
13657
13721
|
/**
|
|
@@ -13663,7 +13727,7 @@ class Client$1 {
|
|
|
13663
13727
|
*
|
|
13664
13728
|
* 获取消息中的资源文件,包括音频,视频,图片和文件,**暂不支持表情包资源下载**。当前仅支持 100M 以内的资源文件的下载。
|
|
13665
13729
|
*
|
|
13666
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;-
|
|
13730
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;- 暂不支持获取合并转发消息中的子消息的资源文件
|
|
13667
13731
|
*/
|
|
13668
13732
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13669
13733
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13707,7 +13771,9 @@ class Client$1 {
|
|
|
13707
13771
|
*
|
|
13708
13772
|
* Pin消息
|
|
13709
13773
|
*
|
|
13710
|
-
* Pin
|
|
13774
|
+
* Pin一条指定的消息。
|
|
13775
|
+
*
|
|
13776
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- Pin消息时,机器人必须在对应的群组中;- 若消息已经被Pin,返回该Pin的操作信息;- 不能Pin一条对操作者不可见的消息;- 对同一条消息的Pin操作不能超过==5 QPS==
|
|
13711
13777
|
*/
|
|
13712
13778
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13713
13779
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13731,7 +13797,9 @@ class Client$1 {
|
|
|
13731
13797
|
*
|
|
13732
13798
|
* 移除Pin消息
|
|
13733
13799
|
*
|
|
13734
|
-
* 移除一条指定消息的Pin
|
|
13800
|
+
* 移除一条指定消息的Pin。
|
|
13801
|
+
*
|
|
13802
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 移除Pin消息时,机器人必须在对应的群组中;- 若消息未被Pin或已被撤回,返回成功信息;- 不能移除一条对操作者不可见的Pin消息;- 对同一条消息移除Pin的操作不能超过==5 QPS==
|
|
13735
13803
|
*/
|
|
13736
13804
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13737
13805
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13803,7 +13871,9 @@ class Client$1 {
|
|
|
13803
13871
|
*
|
|
13804
13872
|
* 获取群内Pin消息
|
|
13805
13873
|
*
|
|
13806
|
-
* 获取所在群内指定时间范围内的所有Pin
|
|
13874
|
+
* 获取所在群内指定时间范围内的所有Pin消息。
|
|
13875
|
+
*
|
|
13876
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取Pin消息时,机器人必须在群组中;- 获取的Pin消息按Pin的创建时间降序排列;- 接口默认限流为==50 QPS==
|
|
13807
13877
|
*/
|
|
13808
13878
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13809
13879
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -16781,7 +16851,7 @@ class Client$1 {
|
|
|
16781
16851
|
*
|
|
16782
16852
|
* 新增执行者
|
|
16783
16853
|
*
|
|
16784
|
-
*
|
|
16854
|
+
* 该接口用于新增任务执行者,一次性可以添加多个执行者。新增的执行者必须是用户的ID。
|
|
16785
16855
|
*/
|
|
16786
16856
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
16787
16857
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -17426,7 +17496,7 @@ class Client$1 {
|
|
|
17426
17496
|
*/
|
|
17427
17497
|
this.vc = {
|
|
17428
17498
|
/**
|
|
17429
|
-
*
|
|
17499
|
+
* 告警中心
|
|
17430
17500
|
*/
|
|
17431
17501
|
alert: {
|
|
17432
17502
|
listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -17480,7 +17550,11 @@ class Client$1 {
|
|
|
17480
17550
|
/**
|
|
17481
17551
|
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=alert&apiName=list&version=v1 click to debug }
|
|
17482
17552
|
*
|
|
17483
|
-
* {@link https://open.feishu.cn/
|
|
17553
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list document }
|
|
17554
|
+
*
|
|
17555
|
+
* 获取告警记录
|
|
17556
|
+
*
|
|
17557
|
+
* 获取特定条件下租户的设备告警记录
|
|
17484
17558
|
*/
|
|
17485
17559
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
17486
17560
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -17505,7 +17579,11 @@ class Client$1 {
|
|
|
17505
17579
|
/**
|
|
17506
17580
|
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=download&version=v1 click to debug }
|
|
17507
17581
|
*
|
|
17508
|
-
* {@link https://open.feishu.cn/
|
|
17582
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download document }
|
|
17583
|
+
*
|
|
17584
|
+
* 下载导出文件
|
|
17585
|
+
*
|
|
17586
|
+
* 下载导出文件
|
|
17509
17587
|
*/
|
|
17510
17588
|
download: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
17511
17589
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -17568,7 +17646,7 @@ class Client$1 {
|
|
|
17568
17646
|
*
|
|
17569
17647
|
* 导出会议明细
|
|
17570
17648
|
*
|
|
17571
|
-
*
|
|
17649
|
+
* 导出会议明细,具体权限要求请参考「导出概述」
|
|
17572
17650
|
*/
|
|
17573
17651
|
meetingList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
17574
17652
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -17592,7 +17670,7 @@ class Client$1 {
|
|
|
17592
17670
|
*
|
|
17593
17671
|
* 导出参会人明细
|
|
17594
17672
|
*
|
|
17595
|
-
*
|
|
17673
|
+
* 导出某个会议的参会人详情列表,具体权限要求请参考「导出概述」
|
|
17596
17674
|
*/
|
|
17597
17675
|
participantList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
17598
17676
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -17616,7 +17694,7 @@ class Client$1 {
|
|
|
17616
17694
|
*
|
|
17617
17695
|
* 导出参会人会议质量数据
|
|
17618
17696
|
*
|
|
17619
|
-
*
|
|
17697
|
+
* 导出某场会议某个参会人的音视频&共享质量数据;,具体权限要求请参考「导出概述」
|
|
17620
17698
|
*/
|
|
17621
17699
|
participantQualityList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
17622
17700
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -18140,6 +18218,59 @@ class Client$1 {
|
|
|
18140
18218
|
});
|
|
18141
18219
|
}),
|
|
18142
18220
|
},
|
|
18221
|
+
/**
|
|
18222
|
+
* 会议室预定范围
|
|
18223
|
+
*/
|
|
18224
|
+
reserveConfig: {
|
|
18225
|
+
/**
|
|
18226
|
+
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=reserve_config&apiName=patch&version=v1 click to debug }
|
|
18227
|
+
*
|
|
18228
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch document }
|
|
18229
|
+
*
|
|
18230
|
+
* 更新会议室预定范围
|
|
18231
|
+
*
|
|
18232
|
+
* 更新会议室预定范围
|
|
18233
|
+
*/
|
|
18234
|
+
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
18235
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
18236
|
+
return httpInstance
|
|
18237
|
+
.request({
|
|
18238
|
+
url: fillApiPath(`${this.domain}/open-apis/vc/v1/reserve_configs/:reserve_config_id`, path),
|
|
18239
|
+
method: "PATCH",
|
|
18240
|
+
data,
|
|
18241
|
+
params,
|
|
18242
|
+
headers,
|
|
18243
|
+
})
|
|
18244
|
+
.catch((e) => {
|
|
18245
|
+
this.logger.error(formatErrors(e));
|
|
18246
|
+
throw e;
|
|
18247
|
+
});
|
|
18248
|
+
}),
|
|
18249
|
+
/**
|
|
18250
|
+
* {@link https://open.feishu.cn/api-explorer?project=vc&resource=reserve_config&apiName=reserve_scope&version=v1 click to debug }
|
|
18251
|
+
*
|
|
18252
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope document }
|
|
18253
|
+
*
|
|
18254
|
+
* 获取会议室预定范围
|
|
18255
|
+
*
|
|
18256
|
+
* 获取会议室预定范围
|
|
18257
|
+
*/
|
|
18258
|
+
reserveScope: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
18259
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
18260
|
+
return httpInstance
|
|
18261
|
+
.request({
|
|
18262
|
+
url: fillApiPath(`${this.domain}/open-apis/vc/v1/reserve_configs/reserve_scope`, path),
|
|
18263
|
+
method: "GET",
|
|
18264
|
+
data,
|
|
18265
|
+
params,
|
|
18266
|
+
headers,
|
|
18267
|
+
})
|
|
18268
|
+
.catch((e) => {
|
|
18269
|
+
this.logger.error(formatErrors(e));
|
|
18270
|
+
throw e;
|
|
18271
|
+
});
|
|
18272
|
+
}),
|
|
18273
|
+
},
|
|
18143
18274
|
/**
|
|
18144
18275
|
* 会议室配置
|
|
18145
18276
|
*/
|
|
@@ -19229,13 +19360,40 @@ const pickRequestData = (req) => new Promise((resolve) => {
|
|
|
19229
19360
|
});
|
|
19230
19361
|
});
|
|
19231
19362
|
|
|
19232
|
-
const
|
|
19363
|
+
const generateChallenge = (data, options) => {
|
|
19364
|
+
if ('encrypt' in data && !options.encryptKey) {
|
|
19365
|
+
throw new Error('auto-challenge need encryptKey, please check for missing in dispatcher');
|
|
19366
|
+
}
|
|
19367
|
+
const targetData = 'encrypt' in data
|
|
19368
|
+
? JSON.parse(new AESCipher(options.encryptKey).decrypt(data.encrypt))
|
|
19369
|
+
: data;
|
|
19370
|
+
return {
|
|
19371
|
+
isChallenge: targetData.type === 'url_verification',
|
|
19372
|
+
challenge: {
|
|
19373
|
+
challenge: targetData.challenge,
|
|
19374
|
+
},
|
|
19375
|
+
};
|
|
19376
|
+
};
|
|
19377
|
+
|
|
19378
|
+
const adaptDefault = (path, dispatcher, options) => (req, res) => __awaiter(void 0, void 0, void 0, function* () {
|
|
19233
19379
|
if (req.url !== path) {
|
|
19234
19380
|
return;
|
|
19235
19381
|
}
|
|
19236
19382
|
const data = Object.assign(Object.create({
|
|
19237
19383
|
headers: req.headers,
|
|
19238
19384
|
}), yield pickRequestData(req));
|
|
19385
|
+
// 是否自动响应challange事件:
|
|
19386
|
+
// https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case
|
|
19387
|
+
const autoChallenge = get__default["default"](options, 'autoChallenge', false);
|
|
19388
|
+
if (autoChallenge) {
|
|
19389
|
+
const { isChallenge, challenge } = generateChallenge(data, {
|
|
19390
|
+
encryptKey: dispatcher.encryptKey,
|
|
19391
|
+
});
|
|
19392
|
+
if (isChallenge) {
|
|
19393
|
+
res.end(JSON.stringify(challenge));
|
|
19394
|
+
return;
|
|
19395
|
+
}
|
|
19396
|
+
}
|
|
19239
19397
|
const value = yield dispatcher.invoke(data);
|
|
19240
19398
|
// event don't need response
|
|
19241
19399
|
if (dispatcher instanceof CardActionHandler) {
|
|
@@ -19259,6 +19417,18 @@ const adaptExpress = (dispatcher, options) => (req, res) => __awaiter(void 0, vo
|
|
|
19259
19417
|
const data = Object.assign(Object.create({
|
|
19260
19418
|
headers: req.headers,
|
|
19261
19419
|
}), reqData);
|
|
19420
|
+
// 是否自动响应challange事件:
|
|
19421
|
+
// https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case
|
|
19422
|
+
const autoChallenge = get__default["default"](options, 'autoChallenge', false);
|
|
19423
|
+
if (autoChallenge) {
|
|
19424
|
+
const { isChallenge, challenge } = generateChallenge(data, {
|
|
19425
|
+
encryptKey: dispatcher.encryptKey,
|
|
19426
|
+
});
|
|
19427
|
+
if (isChallenge) {
|
|
19428
|
+
res.json(challenge);
|
|
19429
|
+
return;
|
|
19430
|
+
}
|
|
19431
|
+
}
|
|
19262
19432
|
const value = yield dispatcher.invoke(data);
|
|
19263
19433
|
// event don't need response
|
|
19264
19434
|
if (dispatcher instanceof CardActionHandler) {
|
|
@@ -19284,6 +19454,19 @@ const adaptKoa = (path, dispatcher, options) => (ctx, next) => __awaiter(void 0,
|
|
|
19284
19454
|
const data = Object.assign(Object.create({
|
|
19285
19455
|
headers: req.headers,
|
|
19286
19456
|
}), reqData);
|
|
19457
|
+
// 是否自动响应challange事件:
|
|
19458
|
+
// https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case
|
|
19459
|
+
const autoChallenge = get__default["default"](options, 'autoChallenge', false);
|
|
19460
|
+
if (autoChallenge) {
|
|
19461
|
+
const { isChallenge, challenge } = generateChallenge(data, {
|
|
19462
|
+
encryptKey: dispatcher.encryptKey,
|
|
19463
|
+
});
|
|
19464
|
+
if (isChallenge) {
|
|
19465
|
+
ctx.body = challenge;
|
|
19466
|
+
yield next();
|
|
19467
|
+
return;
|
|
19468
|
+
}
|
|
19469
|
+
}
|
|
19287
19470
|
const value = yield dispatcher.invoke(data);
|
|
19288
19471
|
// event don't need response
|
|
19289
19472
|
if (dispatcher instanceof CardActionHandler) {
|
|
@@ -19312,6 +19495,19 @@ const adaptKoaRouter = (dispatcher, options) => (ctx, next) => __awaiter(void 0,
|
|
|
19312
19495
|
const data = Object.assign(Object.create({
|
|
19313
19496
|
headers: req.headers,
|
|
19314
19497
|
}), reqData);
|
|
19498
|
+
// 是否自动响应challange事件:
|
|
19499
|
+
// https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case
|
|
19500
|
+
const autoChallenge = get__default["default"](options, 'autoChallenge', false);
|
|
19501
|
+
if (autoChallenge) {
|
|
19502
|
+
const { isChallenge, challenge } = generateChallenge(data, {
|
|
19503
|
+
encryptKey: dispatcher.encryptKey,
|
|
19504
|
+
});
|
|
19505
|
+
if (isChallenge) {
|
|
19506
|
+
ctx.body = challenge;
|
|
19507
|
+
yield next();
|
|
19508
|
+
return;
|
|
19509
|
+
}
|
|
19510
|
+
}
|
|
19315
19511
|
const value = yield dispatcher.invoke(data);
|
|
19316
19512
|
// event don't need response
|
|
19317
19513
|
if (dispatcher instanceof CardActionHandler) {
|