Mud Tools

Appearance

云文档事件订阅 - 租户权限（FeishuTenantV1DriveSubscribe） ​

接口名称 ​

云文档事件订阅（租户权限） -（IFeishuTenantV1DriveSubscribe）

功能描述 ​

提供以租户身份订阅飞书云文档事件的能力。云文档事件订阅用于订阅云文档的事件，如文件创建、更新、删除等，当云文档发生指定事件时，系统会向配置的地址发送事件通知。支持订阅云文档事件、查询订阅状态、取消订阅、订阅用户云文档事件、取消用户订阅以及查询用户订阅状态等操作。适用于需要以应用身份监听云文档变更事件的业务场景，如自动化文档同步、实时通知推送等。

参考文档 ​

函数列表 ​

函数名称功能描述认证方式HTTP 方法
SubscribeFileEventAsync订阅云文档事件租户令牌POST
GetFileSubscribeAsync查询云文档事件订阅状态租户令牌GET
UnsubscribeFileEventAsync取消云文档事件订阅租户令牌DELETE
SubscribeUserFileEventAsync订阅用户云文档事件租户令牌POST
UnsubscribeUserFileEventAsync取消用户云文档事件订阅租户令牌DELETE
GetUserFileSubscribeAsync查询用户云文档事件订阅状态租户令牌GET

函数详细内容 ​

订阅云文档事件 ​

函数签名：

csharp
Task<FeishuNullDataApiResult?> SubscribeFileEventAsync(
    [Path] string file_token,
    [Query("file_type")] string file_type,
    [Query("event_type")] string? event_type = null,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
file_tokenstring✅云文档的 token，示例值：doccnfYZzTlvXqZIGTdAHKabcef
file_typestring✅云文档类型，可选值：doc（旧版文档，已不推荐）、docx（新版文档）、sheet（电子表格）、bitable（多维表格）、file（文件）、folder（文件夹）、slides（幻灯片），示例值：docx
event_typestring?⚪事件类型。若 file_type 为 folder，需填写 file.created_in_folder_v1；若 file_type 不为 folder，请勿填写，示例值：file.created_in_folder_v1

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：订阅云文档的各类通知事件。调用该接口并在开发者后台添加事件后，当云文档发生指定事件时，系统会向配置的地址发送事件。

查询云文档事件订阅状态 ​

函数签名：

csharp
Task<FeishuApiResult<GetFileSubscribeResult>?> GetFileSubscribeAsync(
    [Path] string file_token,
    [Query("file_type")] string file_type,
    [Query("event_type")] string? event_type = null,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
file_tokenstring✅云文档的 token，示例值：doccnfYZzTlvXqZIGTdAHKabcef
file_typestring✅云文档类型，可选值：doc、docx、sheet、bitable、file、folder、slides，示例值：docx
event_typestring?⚪事件类型。若 file_type 为 folder，需填写 file.created_in_folder_v1；若 file_type 不为 folder，请勿填写，示例值：file.created_in_folder_v1

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "is_subscribe": true
  }
}

说明：用于查询云文档事件的订阅状态。

取消云文档事件订阅 ​

函数签名：

csharp
Task<FeishuNullDataApiResult?> UnsubscribeFileEventAsync(
    [Path] string file_token,
    [Query("file_type")] string file_type,
    [Query("event_type")] string? event_type = null,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
file_tokenstring✅云文档的 token，示例值：doccnfYZzTlvXqZIGTdAHKabcef
file_typestring✅云文档类型，可选值：doc、docx、sheet、bitable、file、folder、slides，示例值：docx
event_typestring?⚪事件类型。若 file_type 为 folder，需填写 file.created_in_folder_v1；若 file_type 不为 folder，请勿填写，示例值：file.created_in_folder_v1

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：用于取消订阅云文档的通知事件。

订阅用户云文档事件 ​

函数签名：

csharp
Task<FeishuNullDataApiResult?> SubscribeUserFileEventAsync(
    [Body] SubscribeUserFileEventRequest subscribeUserFileEventRequest,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
subscribeUserFileEventRequestSubscribeUserFileEventRequest✅订阅用户云文档事件请求体

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：订阅用户云文档的各类通知事件，调用后目前可获取接收者视角的云文档评论、回复添加事件，未来还会陆续扩充其它通知事件。

取消用户云文档事件订阅 ​

函数签名：

csharp
Task<FeishuNullDataApiResult?> UnsubscribeUserFileEventAsync(
    [Query("event_type")] string? event_type = null,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
event_typestring?⚪事件类型，示例值：file.created_in_folder_v1

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：用于取消订阅用户云文档的通知事件。取消订阅后，用户将不再收到云文档评论、回复添加事件。

查询用户云文档事件订阅状态 ​

函数签名：

csharp
Task<FeishuApiResult<GetUserFileSubscribeResult>?> GetUserFileSubscribeAsync(
    [Query("event_type")] string? event_type = null,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
event_typestring?⚪事件类型，示例值：file.created_in_folder_v1

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "is_subscribe": true
  }
}

说明：用于查询用户云文档事件的订阅状态。仅当 is_subscribe 为 true，应用才可收到"用户云文档事件"下的各类通知事件。