@larksuiteoapi/node-sdk 1.6.3 → 1.7.1
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 +248 -60
- package/lib/index.js +248 -60
- package/package.json +2 -2
- package/types/index.d.ts +587 -203
package/es/index.js
CHANGED
|
@@ -561,7 +561,7 @@ class Client$1 {
|
|
|
561
561
|
},
|
|
562
562
|
};
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* 管理后台-企业勋章
|
|
565
565
|
*/
|
|
566
566
|
this.admin = {
|
|
567
567
|
/**
|
|
@@ -2247,7 +2247,7 @@ class Client$1 {
|
|
|
2247
2247
|
}),
|
|
2248
2248
|
},
|
|
2249
2249
|
/**
|
|
2250
|
-
*
|
|
2250
|
+
* 审批查询
|
|
2251
2251
|
*/
|
|
2252
2252
|
task: {
|
|
2253
2253
|
/**
|
|
@@ -3965,9 +3965,9 @@ class Client$1 {
|
|
|
3965
3965
|
*
|
|
3966
3966
|
* 获取多维表格元数据
|
|
3967
3967
|
*
|
|
3968
|
-
*
|
|
3968
|
+
* 获取指定多维表格的元数据信息，包括多维表格名称，多维表格版本号，多维表格是否开启高级权限等。
|
|
3969
3969
|
*
|
|
3970
|
-
* 该接口支持调用频率上限为 20 QPS
|
|
3970
|
+
* 该接口支持调用频率上限为 20 QPS（Query Per Second，每秒请求率）
|
|
3971
3971
|
*/
|
|
3972
3972
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
3973
3973
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -4852,7 +4852,7 @@ class Client$1 {
|
|
|
4852
4852
|
*
|
|
4853
4853
|
* 该接口用于在数据表中新增多条记录，单次调用最多新增 500 条记录。
|
|
4854
4854
|
*
|
|
4855
|
-
* 该接口支持调用频率上限为 10 QPS
|
|
4855
|
+
* 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
|
|
4856
4856
|
*/
|
|
4857
4857
|
batchCreate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
4858
4858
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -4930,7 +4930,7 @@ class Client$1 {
|
|
|
4930
4930
|
*
|
|
4931
4931
|
* 该接口用于在数据表中新增一条记录
|
|
4932
4932
|
*
|
|
4933
|
-
* 该接口支持调用频率上限为 10 QPS
|
|
4933
|
+
* 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
|
|
4934
4934
|
*/
|
|
4935
4935
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
4936
4936
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -5056,7 +5056,7 @@ class Client$1 {
|
|
|
5056
5056
|
*
|
|
5057
5057
|
* 该接口用于列出数据表中的现有记录，单次最多列出 500 行记录，支持分页获取。
|
|
5058
5058
|
*
|
|
5059
|
-
* 该接口支持调用频率上限为 1000
|
|
5059
|
+
* 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率），1000 QPM（Query Per Minute，每分钟请求率）
|
|
5060
5060
|
*/
|
|
5061
5061
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
5062
5062
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -5082,7 +5082,7 @@ class Client$1 {
|
|
|
5082
5082
|
*
|
|
5083
5083
|
* 该接口用于更新数据表中的一条记录
|
|
5084
5084
|
*
|
|
5085
|
-
* 该接口支持调用频率上限为 10 QPS
|
|
5085
|
+
* 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
|
|
5086
5086
|
*/
|
|
5087
5087
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
5088
5088
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -8797,7 +8797,7 @@ class Client$1 {
|
|
|
8797
8797
|
}),
|
|
8798
8798
|
},
|
|
8799
8799
|
/**
|
|
8800
|
-
*
|
|
8800
|
+
* 事件
|
|
8801
8801
|
*/
|
|
8802
8802
|
file: {
|
|
8803
8803
|
/**
|
|
@@ -11536,7 +11536,7 @@ class Client$1 {
|
|
|
11536
11536
|
*/
|
|
11537
11537
|
this.hire = {
|
|
11538
11538
|
/**
|
|
11539
|
-
*
|
|
11539
|
+
* 入职
|
|
11540
11540
|
*/
|
|
11541
11541
|
application: {
|
|
11542
11542
|
/**
|
|
@@ -12225,7 +12225,7 @@ class Client$1 {
|
|
|
12225
12225
|
},
|
|
12226
12226
|
};
|
|
12227
12227
|
/**
|
|
12228
|
-
*
|
|
12228
|
+
* 消息卡片
|
|
12229
12229
|
*/
|
|
12230
12230
|
this.im = {
|
|
12231
12231
|
/**
|
|
@@ -12241,7 +12241,7 @@ class Client$1 {
|
|
|
12241
12241
|
*
|
|
12242
12242
|
* 批量撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息。
|
|
12243
12243
|
*
|
|
12244
|
-
* 注意事项：;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息，所以为异步接口，会有一定延迟。
|
|
12244
|
+
* 注意事项：;- 应用需要启用[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息，所以为异步接口，会有一定延迟。
|
|
12245
12245
|
*/
|
|
12246
12246
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12247
12247
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12324,7 +12324,7 @@ class Client$1 {
|
|
|
12324
12324
|
*
|
|
12325
12325
|
* 获取会话中的群公告信息，公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
|
12326
12326
|
*
|
|
12327
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12327
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 获取内部群信息时，操作者须与群组在同一租户下
|
|
12328
12328
|
*/
|
|
12329
12329
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12330
12330
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12350,7 +12350,7 @@ class Client$1 {
|
|
|
12350
12350
|
*
|
|
12351
12351
|
* 更新会话中的群公告信息，更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
|
12352
12352
|
*
|
|
12353
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12353
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时，操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置，群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置，所有成员可以更新群公告
|
|
12354
12354
|
*/
|
|
12355
12355
|
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12356
12356
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12381,7 +12381,7 @@ class Client$1 {
|
|
|
12381
12381
|
*
|
|
12382
12382
|
* 创建群并设置群头像、群名、群描述等。
|
|
12383
12383
|
*
|
|
12384
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12384
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 本接口支持在创建群的同时拉用户或机器人进群；如果仅需要拉用户或者机器人入群参考 [将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口
|
|
12385
12385
|
*/
|
|
12386
12386
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12387
12387
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12407,7 +12407,7 @@ class Client$1 {
|
|
|
12407
12407
|
*
|
|
12408
12408
|
* 解散群组。
|
|
12409
12409
|
*
|
|
12410
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12410
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 如果使用tenant_access_token，需要机器人符合以下任一情况才可解散群：; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token，需要对应的用户是群主才可解散群
|
|
12411
12411
|
*/
|
|
12412
12412
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12413
12413
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12433,7 +12433,7 @@ class Client$1 {
|
|
|
12433
12433
|
*
|
|
12434
12434
|
* 获取群名称、群描述、群头像、群主 ID 等群基本信息。
|
|
12435
12435
|
*
|
|
12436
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12436
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群里（否则只会返回群名称、群头像等基本信息）;- 获取内部群信息时，操作者须与群组在同一租户下
|
|
12437
12437
|
*/
|
|
12438
12438
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12439
12439
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12457,9 +12457,9 @@ class Client$1 {
|
|
|
12457
12457
|
*
|
|
12458
12458
|
* 获取群分享链接
|
|
12459
12459
|
*
|
|
12460
|
-
*
|
|
12460
|
+
* 获取指定群的分享链接。
|
|
12461
12461
|
*
|
|
12462
|
-
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12462
|
+
* 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时，Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时，仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时，操作者须与群组在同一租户下
|
|
12463
12463
|
*/
|
|
12464
12464
|
link: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12465
12465
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12533,7 +12533,7 @@ class Client$1 {
|
|
|
12533
12533
|
*
|
|
12534
12534
|
* 获取用户或者机器人所在群列表。
|
|
12535
12535
|
*
|
|
12536
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12536
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL;- 获取的群列表不包含P2P单聊
|
|
12537
12537
|
*/
|
|
12538
12538
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12539
12539
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12607,7 +12607,7 @@ class Client$1 {
|
|
|
12607
12607
|
*
|
|
12608
12608
|
* 搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。;搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。
|
|
12609
12609
|
*
|
|
12610
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12610
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)
|
|
12611
12611
|
*/
|
|
12612
12612
|
search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12613
12613
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12633,7 +12633,7 @@ class Client$1 {
|
|
|
12633
12633
|
*
|
|
12634
12634
|
* 更新群头像、群名称、群描述、群配置、转让群主等。
|
|
12635
12635
|
*
|
|
12636
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12636
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 对于群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新所有信息;- 对于不满足上述权限条件的群成员或机器人：; - 若未开启 ==仅群主和群管理员可编辑群信息== 配置，仅可更新群头像、群名称、群描述、群国际化名称信息; - 若开启了 ==仅群主和群管理员可编辑群信息== 配置，任何群信息都不能修改;- 如果同时更新 ==邀请用户或机器人入群权限== 和 ==群分享权限== 这两项设置需要满足以下条件：; - 若未开启 ==仅群主和管理员可以邀请用户或机器人入群==，需要设置 ==群分享权限== 为 ==允许分享==; - 若开启了 ==仅群主和管理员可以邀请用户或机器人入群==，需要设置 ==群分享权限== 为 ==不允许分享==
|
|
12637
12637
|
*/
|
|
12638
12638
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12639
12639
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12664,7 +12664,7 @@ class Client$1 {
|
|
|
12664
12664
|
*
|
|
12665
12665
|
* 将用户或机器人指定为群管理员。
|
|
12666
12666
|
*
|
|
12667
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12667
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 仅有群主可以指定群管理员
|
|
12668
12668
|
*/
|
|
12669
12669
|
addManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12670
12670
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12690,7 +12690,7 @@ class Client$1 {
|
|
|
12690
12690
|
*
|
|
12691
12691
|
* 删除指定的群管理员（用户或机器人）。
|
|
12692
12692
|
*
|
|
12693
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12693
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 仅有群主可以删除群管理员
|
|
12694
12694
|
*/
|
|
12695
12695
|
deleteManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12696
12696
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12721,7 +12721,7 @@ class Client$1 {
|
|
|
12721
12721
|
*
|
|
12722
12722
|
* 将用户或机器人拉入群聊。
|
|
12723
12723
|
*
|
|
12724
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12724
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 如需拉用户进群，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时，操作者须与群组在同一租户下; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时，仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时，所有群成员都可以拉用户或机器人进群
|
|
12725
12725
|
*/
|
|
12726
12726
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12727
12727
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12747,7 +12747,7 @@ class Client$1 {
|
|
|
12747
12747
|
*
|
|
12748
12748
|
* 将用户或机器人移出群聊。
|
|
12749
12749
|
*
|
|
12750
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12750
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 用户或机器人在任何条件下均可移除自己出群（即主动退群）;- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人，可以移除其他用户或者机器人;- 每次请求，最多移除50个用户或者5个机器人;- 操作内部群时，操作者须与群组在同一租户下
|
|
12751
12751
|
*/
|
|
12752
12752
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12753
12753
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12821,7 +12821,7 @@ class Client$1 {
|
|
|
12821
12821
|
*
|
|
12822
12822
|
* 获取用户/机器人所在群的群成员列表。
|
|
12823
12823
|
*
|
|
12824
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12824
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时，操作者须与群组在同一租户下
|
|
12825
12825
|
*/
|
|
12826
12826
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12827
12827
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12847,7 +12847,7 @@ class Client$1 {
|
|
|
12847
12847
|
*
|
|
12848
12848
|
* 根据使用的access_token判断对应的用户或者机器人是否在群里。
|
|
12849
12849
|
*
|
|
12850
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12850
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 获取内部群信息时，操作者须与群组在同一租户下
|
|
12851
12851
|
*/
|
|
12852
12852
|
isInChat: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12853
12853
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12873,7 +12873,7 @@ class Client$1 {
|
|
|
12873
12873
|
*
|
|
12874
12874
|
* 用户或机器人主动加入群聊。
|
|
12875
12875
|
*
|
|
12876
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12876
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 目前仅支持加入公开群;- 操作内部群时，操作者须与群组在同一租户下
|
|
12877
12877
|
*/
|
|
12878
12878
|
meJoin: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12879
12879
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12952,7 +12952,7 @@ class Client$1 {
|
|
|
12952
12952
|
*
|
|
12953
12953
|
* 获取群发言模式、可发言用户名单等
|
|
12954
12954
|
*
|
|
12955
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12955
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人 或 授权用户 必须在群里
|
|
12956
12956
|
*/
|
|
12957
12957
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12958
12958
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -12978,7 +12978,7 @@ class Client$1 {
|
|
|
12978
12978
|
*
|
|
12979
12979
|
* 更新群组的发言权限设置，可设置为全员可发言、仅管理员可发言 或 指定用户可发言。
|
|
12980
12980
|
*
|
|
12981
|
-
* 注意事项：; - 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
12981
|
+
* 注意事项：; - 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 若以用户授权调用接口，**当授权用户是群主**时，可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口)，当**机器人是群主** 或者 **机器人是群组创建者、具备==更新应用所创建群的群信息==权限且仍在群内**时，可更新群发言权限
|
|
12982
12982
|
*/
|
|
12983
12983
|
update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
12984
12984
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13009,7 +13009,7 @@ class Client$1 {
|
|
|
13009
13009
|
*
|
|
13010
13010
|
* 添加自定义会话标签页。
|
|
13011
13011
|
*
|
|
13012
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13012
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- tab_config字段当前只对`url`类型的会话标签页生效;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以添加会话标签页;- 操作内部群时，操作者须与群组在同一租户下
|
|
13013
13013
|
*/
|
|
13014
13014
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13015
13015
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13035,7 +13035,7 @@ class Client$1 {
|
|
|
13035
13035
|
*
|
|
13036
13036
|
* 删除会话标签页。
|
|
13037
13037
|
*
|
|
13038
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13038
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以删除会话标签页;- 操作内部群时，操作者须与群组在同一租户下
|
|
13039
13039
|
*/
|
|
13040
13040
|
deleteTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13041
13041
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13061,7 +13061,7 @@ class Client$1 {
|
|
|
13061
13061
|
*
|
|
13062
13062
|
* 拉取会话标签页。
|
|
13063
13063
|
*
|
|
13064
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13064
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 操作内部群时，操作者须与群组在同一租户下
|
|
13065
13065
|
*/
|
|
13066
13066
|
listTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13067
13067
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13087,7 +13087,7 @@ class Client$1 {
|
|
|
13087
13087
|
*
|
|
13088
13088
|
* 会话标签页排序。
|
|
13089
13089
|
*
|
|
13090
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13090
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位，不参与排序，但是请求体中必须包含该标签页的Tab ID;- 操作内部群时，操作者须与群组在同一租户下
|
|
13091
13091
|
*/
|
|
13092
13092
|
sortTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13093
13093
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13113,7 +13113,7 @@ class Client$1 {
|
|
|
13113
13113
|
*
|
|
13114
13114
|
* 更新会话标签页
|
|
13115
13115
|
*
|
|
13116
|
-
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13116
|
+
* 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以更新会话标签页;- 操作内部群时，操作者须与群组在同一租户下
|
|
13117
13117
|
*/
|
|
13118
13118
|
updateTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13119
13119
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13144,7 +13144,7 @@ class Client$1 {
|
|
|
13144
13144
|
*
|
|
13145
13145
|
* 撤销会话中的置顶。
|
|
13146
13146
|
*
|
|
13147
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13147
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 撤销内部群置顶时，操作者须与群组在同一租户下
|
|
13148
13148
|
*/
|
|
13149
13149
|
deleteTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13150
13150
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13170,7 +13170,7 @@ class Client$1 {
|
|
|
13170
13170
|
*
|
|
13171
13171
|
* 更新会话中的群置顶信息，可以将群中的某一条消息，或者群公告置顶显示。
|
|
13172
13172
|
*
|
|
13173
|
-
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13173
|
+
* 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 更新内部群置顶时，操作者须与群组在同一租户下
|
|
13174
13174
|
*/
|
|
13175
13175
|
putTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13176
13176
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13201,7 +13201,7 @@ class Client$1 {
|
|
|
13201
13201
|
*
|
|
13202
13202
|
* 上传文件，可以上传视频，音频和常见的文件类型。
|
|
13203
13203
|
*
|
|
13204
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13204
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 文件大小不得超过30M，且不允许上传空文件
|
|
13205
13205
|
*/
|
|
13206
13206
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13207
13207
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13228,7 +13228,7 @@ class Client$1 {
|
|
|
13228
13228
|
*
|
|
13229
13229
|
* 下载文件接口，只能下载应用自己上传的文件。
|
|
13230
13230
|
*
|
|
13231
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13231
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 只能下载机器人自己上传的文件;- 下载用户发送的资源，请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口;- 下载的资源大小不能超过100M;- 如果需要Content-Disposition header，发起请求的时候需要在header中设置Content-Type为application/json
|
|
13232
13232
|
*/
|
|
13233
13233
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13234
13234
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13274,7 +13274,7 @@ class Client$1 {
|
|
|
13274
13274
|
*
|
|
13275
13275
|
* 上传图片接口，支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。
|
|
13276
13276
|
*
|
|
13277
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13277
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 图片大小不得超过10M，且不支持上传大小为0的图片
|
|
13278
13278
|
*/
|
|
13279
13279
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13280
13280
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13301,7 +13301,7 @@ class Client$1 {
|
|
|
13301
13301
|
*
|
|
13302
13302
|
* 下载图片资源，只能下载当前应用所上传且图片类型为message的图片。
|
|
13303
13303
|
*
|
|
13304
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13304
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 只能下载机器人自己上传且图片类型为message的图片，avatar类型暂不支持下载;- 下载用户发送的资源，请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
|
|
13305
13305
|
*/
|
|
13306
13306
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13307
13307
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13347,7 +13347,7 @@ class Client$1 {
|
|
|
13347
13347
|
*
|
|
13348
13348
|
* 给指定用户或者会话发送消息，支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
|
|
13349
13349
|
*
|
|
13350
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13350
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 给用户发送消息，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 给群组发送消息，需要机器人在群组中
|
|
13351
13351
|
*/
|
|
13352
13352
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13353
13353
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13373,7 +13373,7 @@ class Client$1 {
|
|
|
13373
13373
|
*
|
|
13374
13374
|
* 机器人撤回机器人自己发送的消息或群主撤回群内消息。
|
|
13375
13375
|
*
|
|
13376
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13376
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ，撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内，自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息，则机器人必须是该群的群主、管理员 或者 创建者，且消息发送时间不超过1年;- 无法撤回通过「[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)」接口发送的消息
|
|
13377
13377
|
*/
|
|
13378
13378
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13379
13379
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13399,7 +13399,7 @@ class Client$1 {
|
|
|
13399
13399
|
*
|
|
13400
13400
|
* 通过 message_id 查询消息内容。
|
|
13401
13401
|
*
|
|
13402
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13402
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 机器人必须在群组中
|
|
13403
13403
|
*/
|
|
13404
13404
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13405
13405
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13473,7 +13473,7 @@ class Client$1 {
|
|
|
13473
13473
|
*
|
|
13474
13474
|
* 获取会话（包括单聊、群组）的历史消息（聊天记录）。
|
|
13475
13475
|
*
|
|
13476
|
-
* - 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13476
|
+
* - 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 获取消息时，机器人必须在群组中
|
|
13477
13477
|
*
|
|
13478
13478
|
* 接口级别权限默认只能获取单聊（p2p）消息，如果需要获取群组（group）消息，应用还必须拥有 **==获取群组中所有消息==** 权限
|
|
13479
13479
|
*/
|
|
@@ -13501,7 +13501,7 @@ class Client$1 {
|
|
|
13501
13501
|
*
|
|
13502
13502
|
* 更新应用已发送的消息卡片内容。
|
|
13503
13503
|
*
|
|
13504
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13504
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 若以user_access_token更新消息，该操作用户必须是卡片消息的发送者;- 仅支持对所有人更新**未撤回**的[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN)消息，需在卡片的config属性中，显式声明 =="update_multi":true==。 ;- **不支持更新批量消息**;- 文本消息请求体最大不能超过150KB；卡片及富文本消息请求体最大不能超过30KB;- 仅支持修改14天内发送的消息;- 单条消息更新频控为**5QPS**
|
|
13505
13505
|
*/
|
|
13506
13506
|
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13507
13507
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13527,7 +13527,7 @@ class Client$1 {
|
|
|
13527
13527
|
*
|
|
13528
13528
|
* 查询消息的已读信息。
|
|
13529
13529
|
*
|
|
13530
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13530
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能查询机器人自己发送，且发送时间不超过7天的消息;- 查询消息已读信息时机器人仍需要在会话内;- 本接口不支持查询批量消息
|
|
13531
13531
|
*/
|
|
13532
13532
|
readUsers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13533
13533
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13553,7 +13553,7 @@ class Client$1 {
|
|
|
13553
13553
|
*
|
|
13554
13554
|
* 回复指定消息，支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
|
|
13555
13555
|
*
|
|
13556
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13556
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 回复私聊消息，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 回复群组消息，需要机器人在群中
|
|
13557
13557
|
*/
|
|
13558
13558
|
reply: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13559
13559
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13579,7 +13579,7 @@ class Client$1 {
|
|
|
13579
13579
|
*
|
|
13580
13580
|
* 对指定消息进行应用内加急。
|
|
13581
13581
|
*
|
|
13582
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13582
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 不支持加急批量消息;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
|
|
13583
13583
|
*
|
|
13584
13584
|
* 特别说明：;- 默认接口限流为50 QPS，请谨慎调用
|
|
13585
13585
|
*/
|
|
@@ -13607,7 +13607,7 @@ class Client$1 {
|
|
|
13607
13607
|
*
|
|
13608
13608
|
* 对指定消息进行应用内加急与电话加急。
|
|
13609
13609
|
*
|
|
13610
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13610
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群组中;- 需要用户阅读已加急的消息才可以继续加急（用户未读的加急上限为200条）
|
|
13611
13611
|
*
|
|
13612
13612
|
* 特别说明：;- 通过接口产生的电话加急将消耗企业的加急额度，请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS，请谨慎调用
|
|
13613
13613
|
*/
|
|
@@ -13635,7 +13635,7 @@ class Client$1 {
|
|
|
13635
13635
|
*
|
|
13636
13636
|
* 对指定消息进行应用内加急与短信加急。
|
|
13637
13637
|
*
|
|
13638
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13638
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在加急消息所在的群组中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
|
|
13639
13639
|
*
|
|
13640
13640
|
* 特别说明：;- 通过接口产生的短信加急将消耗企业的加急额度，请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS，请谨慎调用
|
|
13641
13641
|
*/
|
|
@@ -13668,7 +13668,7 @@ class Client$1 {
|
|
|
13668
13668
|
*
|
|
13669
13669
|
* 给指定消息添加指定类型的表情回复（reaction即表情回复，本文档统一用“reaction”代称）。
|
|
13670
13670
|
*
|
|
13671
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13671
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 待添加reaction的消息要真实存在，不能被撤回;- 给消息添加reaction，需要reaction的发送方（机器人或者用户）在消息所在的会话内
|
|
13672
13672
|
*/
|
|
13673
13673
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13674
13674
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13694,7 +13694,7 @@ class Client$1 {
|
|
|
13694
13694
|
*
|
|
13695
13695
|
* 删除指定消息的表情回复（reaction即表情回复，本文档统一用“reaction”代称）。
|
|
13696
13696
|
*
|
|
13697
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13697
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能删除真实存在的reaction，并且删除reaction请求的操作者必须是reaction的原始添加者
|
|
13698
13698
|
*/
|
|
13699
13699
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13700
13700
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13768,7 +13768,7 @@ class Client$1 {
|
|
|
13768
13768
|
*
|
|
13769
13769
|
* 获取指定消息的特定类型表情回复列表（reaction即表情回复，本文档统一用“reaction”代称）。
|
|
13770
13770
|
*
|
|
13771
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13771
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 待获取reaction信息的消息要真实存在，不能被撤回;- 获取消息的reaction，需要request的授权主体（机器人或者用户）在消息所在的会话内
|
|
13772
13772
|
*/
|
|
13773
13773
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13774
13774
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13799,7 +13799,7 @@ class Client$1 {
|
|
|
13799
13799
|
*
|
|
13800
13800
|
* 获取消息中的资源文件，包括音频，视频，图片和文件，**暂不支持表情包资源下载**。当前仅支持 100M 以内的资源文件的下载。
|
|
13801
13801
|
*
|
|
13802
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13802
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人和消息需要在同一会话中;- 暂不支持获取合并转发消息中的子消息的资源文件
|
|
13803
13803
|
*/
|
|
13804
13804
|
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13805
13805
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13845,7 +13845,7 @@ class Client$1 {
|
|
|
13845
13845
|
*
|
|
13846
13846
|
* Pin一条指定的消息。
|
|
13847
13847
|
*
|
|
13848
|
-
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13848
|
+
* 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- Pin消息时，机器人必须在对应的群组中;- 若消息已经被Pin，返回该Pin的操作信息;- 不能Pin一条对操作者不可见的消息;- 对同一条消息的Pin操作不能超过==5 QPS==
|
|
13849
13849
|
*/
|
|
13850
13850
|
create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13851
13851
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13871,7 +13871,7 @@ class Client$1 {
|
|
|
13871
13871
|
*
|
|
13872
13872
|
* 移除一条指定消息的Pin。
|
|
13873
13873
|
*
|
|
13874
|
-
* 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13874
|
+
* 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 移除Pin消息时，机器人必须在对应的群组中;- 若消息未被Pin或已被撤回，返回成功信息;- 不能移除一条对操作者不可见的Pin消息;- 对同一条消息移除Pin的操作不能超过==5 QPS==
|
|
13875
13875
|
*/
|
|
13876
13876
|
delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13877
13877
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -13945,7 +13945,7 @@ class Client$1 {
|
|
|
13945
13945
|
*
|
|
13946
13946
|
* 获取所在群内指定时间范围内的所有Pin消息。
|
|
13947
13947
|
*
|
|
13948
|
-
* 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/
|
|
13948
|
+
* 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 获取Pin消息时，机器人必须在群组中;- 获取的Pin消息按Pin的创建时间降序排列;- 接口默认限流为==50 QPS==
|
|
13949
13949
|
*/
|
|
13950
13950
|
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
13951
13951
|
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
@@ -15217,6 +15217,165 @@ class Client$1 {
|
|
|
15217
15217
|
return get(res, "data", {});
|
|
15218
15218
|
}),
|
|
15219
15219
|
},
|
|
15220
|
+
/**
|
|
15221
|
+
* 指标库
|
|
15222
|
+
*/
|
|
15223
|
+
metricSource: {
|
|
15224
|
+
/**
|
|
15225
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source&apiName=list&version=v1 click to debug }
|
|
15226
|
+
*
|
|
15227
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source/list document }
|
|
15228
|
+
*
|
|
15229
|
+
* 获取指标库
|
|
15230
|
+
*
|
|
15231
|
+
* 获取租户下全部 OKR 指标库（仅限 OKR 企业版使用）
|
|
15232
|
+
*/
|
|
15233
|
+
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15234
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15235
|
+
return httpInstance
|
|
15236
|
+
.request({
|
|
15237
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources`, path),
|
|
15238
|
+
method: "GET",
|
|
15239
|
+
data,
|
|
15240
|
+
params,
|
|
15241
|
+
headers,
|
|
15242
|
+
})
|
|
15243
|
+
.catch((e) => {
|
|
15244
|
+
this.logger.error(formatErrors(e));
|
|
15245
|
+
throw e;
|
|
15246
|
+
});
|
|
15247
|
+
}),
|
|
15248
|
+
},
|
|
15249
|
+
/**
|
|
15250
|
+
* 指标项
|
|
15251
|
+
*/
|
|
15252
|
+
metricSourceTableItem: {
|
|
15253
|
+
/**
|
|
15254
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=batch_update&version=v1 click to debug }
|
|
15255
|
+
*
|
|
15256
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/batch_update document }
|
|
15257
|
+
*
|
|
15258
|
+
* 批量更新指标项
|
|
15259
|
+
*
|
|
15260
|
+
* - 该接口用于批量更新多项指标，单次调用最多更新 100 条记录。接口仅限 OKR 企业版使用。;; 更新成功后 OKR 系统会给以下人员发送消息通知：;; - 首次更新目标值的人员 ;; - 已经将指标添加为 KR、且本次目标值/起始值/支撑的上级有变更的人员，不包含仅更新了进度值的人员
|
|
15261
|
+
*/
|
|
15262
|
+
batchUpdate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15263
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15264
|
+
return httpInstance
|
|
15265
|
+
.request({
|
|
15266
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/batch_update`, path),
|
|
15267
|
+
method: "PATCH",
|
|
15268
|
+
data,
|
|
15269
|
+
params,
|
|
15270
|
+
headers,
|
|
15271
|
+
})
|
|
15272
|
+
.catch((e) => {
|
|
15273
|
+
this.logger.error(formatErrors(e));
|
|
15274
|
+
throw e;
|
|
15275
|
+
});
|
|
15276
|
+
}),
|
|
15277
|
+
/**
|
|
15278
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=get&version=v1 click to debug }
|
|
15279
|
+
*
|
|
15280
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/get document }
|
|
15281
|
+
*
|
|
15282
|
+
* 获取指标项详情
|
|
15283
|
+
*
|
|
15284
|
+
* 获取某项指标的具体内容（仅限 OKR 企业版使用）
|
|
15285
|
+
*/
|
|
15286
|
+
get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15287
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15288
|
+
return httpInstance
|
|
15289
|
+
.request({
|
|
15290
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/:metric_item_id`, path),
|
|
15291
|
+
method: "GET",
|
|
15292
|
+
data,
|
|
15293
|
+
params,
|
|
15294
|
+
headers,
|
|
15295
|
+
})
|
|
15296
|
+
.catch((e) => {
|
|
15297
|
+
this.logger.error(formatErrors(e));
|
|
15298
|
+
throw e;
|
|
15299
|
+
});
|
|
15300
|
+
}),
|
|
15301
|
+
/**
|
|
15302
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=list&version=v1 click to debug }
|
|
15303
|
+
*
|
|
15304
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/list document }
|
|
15305
|
+
*
|
|
15306
|
+
* 获取指标项
|
|
15307
|
+
*
|
|
15308
|
+
* 获取指定指标表下的所有指标项（仅限 OKR 企业版使用）
|
|
15309
|
+
*/
|
|
15310
|
+
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15311
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15312
|
+
return httpInstance
|
|
15313
|
+
.request({
|
|
15314
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items`, path),
|
|
15315
|
+
method: "GET",
|
|
15316
|
+
data,
|
|
15317
|
+
params,
|
|
15318
|
+
headers,
|
|
15319
|
+
})
|
|
15320
|
+
.catch((e) => {
|
|
15321
|
+
this.logger.error(formatErrors(e));
|
|
15322
|
+
throw e;
|
|
15323
|
+
});
|
|
15324
|
+
}),
|
|
15325
|
+
/**
|
|
15326
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=patch&version=v1 click to debug }
|
|
15327
|
+
*
|
|
15328
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/patch document }
|
|
15329
|
+
*
|
|
15330
|
+
* 更新指标项
|
|
15331
|
+
*
|
|
15332
|
+
* - 该接口用于更新某项指标，接口仅限 OKR 企业版使用。;; 更新成功后 OKR 系统会给以下人员发送消息通知：;; - 首次更新目标值的人员 ;; - 已经将指标添加为 KR、且本次目标值/起始值/支撑的上级有变更的人员，不包含仅更新了进度值的人员
|
|
15333
|
+
*/
|
|
15334
|
+
patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15335
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15336
|
+
return httpInstance
|
|
15337
|
+
.request({
|
|
15338
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/:metric_item_id`, path),
|
|
15339
|
+
method: "PATCH",
|
|
15340
|
+
data,
|
|
15341
|
+
params,
|
|
15342
|
+
headers,
|
|
15343
|
+
})
|
|
15344
|
+
.catch((e) => {
|
|
15345
|
+
this.logger.error(formatErrors(e));
|
|
15346
|
+
throw e;
|
|
15347
|
+
});
|
|
15348
|
+
}),
|
|
15349
|
+
},
|
|
15350
|
+
/**
|
|
15351
|
+
* 指标表
|
|
15352
|
+
*/
|
|
15353
|
+
metricSourceTable: {
|
|
15354
|
+
/**
|
|
15355
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table&apiName=list&version=v1 click to debug }
|
|
15356
|
+
*
|
|
15357
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table/list document }
|
|
15358
|
+
*
|
|
15359
|
+
* 获取指标表
|
|
15360
|
+
*
|
|
15361
|
+
* 获取指定指标库下有哪些指标表（仅限 OKR 企业版使用）
|
|
15362
|
+
*/
|
|
15363
|
+
list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15364
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15365
|
+
return httpInstance
|
|
15366
|
+
.request({
|
|
15367
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables`, path),
|
|
15368
|
+
method: "GET",
|
|
15369
|
+
data,
|
|
15370
|
+
params,
|
|
15371
|
+
headers,
|
|
15372
|
+
})
|
|
15373
|
+
.catch((e) => {
|
|
15374
|
+
this.logger.error(formatErrors(e));
|
|
15375
|
+
throw e;
|
|
15376
|
+
});
|
|
15377
|
+
}),
|
|
15378
|
+
},
|
|
15220
15379
|
/**
|
|
15221
15380
|
* OKR
|
|
15222
15381
|
*/
|
|
@@ -15380,6 +15539,35 @@ class Client$1 {
|
|
|
15380
15539
|
});
|
|
15381
15540
|
}),
|
|
15382
15541
|
},
|
|
15542
|
+
/**
|
|
15543
|
+
* 复盘（灰度租户可见）
|
|
15544
|
+
*/
|
|
15545
|
+
review: {
|
|
15546
|
+
/**
|
|
15547
|
+
* {@link https://open.feishu.cn/api-explorer?project=okr&resource=review&apiName=query&version=v1 click to debug }
|
|
15548
|
+
*
|
|
15549
|
+
* {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query document }
|
|
15550
|
+
*
|
|
15551
|
+
* 查询复盘信息
|
|
15552
|
+
*
|
|
15553
|
+
* 根据周期和用户查询复盘信息。
|
|
15554
|
+
*/
|
|
15555
|
+
query: (payload, options) => __awaiter(this, void 0, void 0, function* () {
|
|
15556
|
+
const { headers, params, data, path } = yield this.formatPayload(payload, options);
|
|
15557
|
+
return httpInstance
|
|
15558
|
+
.request({
|
|
15559
|
+
url: fillApiPath(`${this.domain}/open-apis/okr/v1/reviews/query`, path),
|
|
15560
|
+
method: "GET",
|
|
15561
|
+
data,
|
|
15562
|
+
params,
|
|
15563
|
+
headers,
|
|
15564
|
+
})
|
|
15565
|
+
.catch((e) => {
|
|
15566
|
+
this.logger.error(formatErrors(e));
|
|
15567
|
+
throw e;
|
|
15568
|
+
});
|
|
15569
|
+
}),
|
|
15570
|
+
},
|
|
15383
15571
|
/**
|
|
15384
15572
|
* 用户OKR
|
|
15385
15573
|
*/
|
|
@@ -16311,7 +16499,7 @@ class Client$1 {
|
|
|
16311
16499
|
}),
|
|
16312
16500
|
},
|
|
16313
16501
|
/**
|
|
16314
|
-
*
|
|
16502
|
+
* 行列
|
|
16315
16503
|
*/
|
|
16316
16504
|
spreadsheetSheet: {
|
|
16317
16505
|
/**
|