文件已读

文件已读事件。云文档被打开时，将触发此事件。

Tip: 了解事件订阅的配置流程和使用场景，参考事件概述。

前提条件

添加该事件之前，你需确保已调用订阅云文档事件接口。

事件

项目	值
事件类型	drive.file.read_v1
支持的应用类型	custom,isv
权限要求订阅该事件所需的权限，开启其中任意一项权限即可订阅开启任一权限即可	`drive:drive` 查看、评论、编辑和管理多维表格 `docs:doc` 查看、评论、编辑和管理云空间中所有文件 `sheets:spreadsheet` 查看、评论、编辑和管理云空间中所有文件 `docs:event.document_opened:read` 接收云文档打开事件
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 `contact:user.employee_id:readonly` 获取用户 user ID
推送方式	`Webhook`

事件体

名称	类型	描述
`schema`	`string`	事件格式的版本。无此字段的即为 1.0 版本。
`header`	`event_header`	事件头
└ `event_id`	`string`	事件 ID
└ `event_type`	`string`	事件类型
└ `token`	`string`	事件 token
└ `create_time`	`string`	事件创建时间戳（单位：毫秒）
└ `tenant_key`	`string`	租户 key，即企业标识
└ `app_id`	`string`	应用 ID
└ `resource_id`	`string`	订阅的云文档 token
└ `user_list`	`string`	订阅的用户列表
└ `union_id`	`string`	用户的 Union ID
`event`	`\-`	-
└ `file_type`	`string`	云文档类型，支持以下枚举： - doc：旧版文档。已不推荐使用 - docx：新版文档 - sheet：电子表格 - bitable：多维表格 - slides：幻灯片
└ `file_token`	`string`	多维表格 token
└ `operator_id`	`-`	操作人 ID
└ `union_id`	`string`	用户的 Union ID
└ `user_id`	`string`	用户的 User ID 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 Open ID

事件体示例

json

{
  "schema": "2.0", // 事件格式的版本。无此字段的即为 1.0 版本
  "header": {
    "event_id": "88ba7a69073dcc5b0dea70be77xxxxxx", // 事件的唯一标识
    "token": "xxxxxx", // 事件 token
    "create_time": "1612246959000", //  事件创建时间戳（单位：毫秒）
    "event_type": "drive.file.read_v1", // 事件类型 
    "tenant_key": "xxxxxx", // 租户 key，即企业标识 
    "app_id": "cli_xxxxxx", // 应用 ID
    "resource_id": "doccnfYZzTlvXqZIGTdAHKabcef", // 资源 ID，即订阅的云文档 token
    "user_list": [
      { // 订阅的用户列表
        "union_id": "on_xxxxxx"
      }
    ]
  },
  "event": {
    "file_token": "doccnfYZzTlvXqZIGTdAHKabcef", // 文件 token
    "file_type": "docx", // 文件类型，支持 doc、sheet、docx 和 bitable
    "operator_id_list": [
      { // 操作者 ID 列表
        "open_id": "ou_xxxxxx",
        "union_id": "on_xxxxxx",
        "user_id": "xxxxxx"
      }
    ]
  }
}

事件订阅示例代码

事件订阅流程可参考：事件订阅概述，新手入门可参考：教程

订阅方式

长连接方式（推荐）：无需发布到公网地址，在本地开发环境中即可接收事件回调，且无需处理加解密逻辑。发送至开发者服务器：需要提供服务器公网地址。

package main

import (
	"context"
	"fmt"

	larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
	larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
	"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
	"github.com/larksuite/oapi-sdk-go/v3/service/drive/v1"
	larkws "github.com/larksuite/oapi-sdk-go/v3/ws"
)

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations
func main() {
	// 注册事件 Register event
	eventHandler := dispatcher.NewEventDispatcher("", "").
		OnP2FileReadV1(func(ctx context.Context, event *larkdrive.P2FileReadV1) error {
			fmt.Printf("[ OnP2FileReadV1 access ], data: %s\n", larkcore.Prettify(event))
			return nil
		})

	// 构建 client Build client
	cli := larkws.NewClient("YOUR_APP_ID", "YOUR_APP_SECRET",
		larkws.WithEventHandler(eventHandler),
		larkws.WithLogLevel(larkcore.LogLevelDebug),
	)

	// 建立长连接 Establish persistent connection
	err := cli.Start(context.Background())

	if err != nil {
		panic(err)
	}
}

# SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development
import lark_oapi as lark


def do_p2_drive_file_read_v1(data: lark.drive.v1.P2DriveFileReadV1) -> None:
    print(f'[ do_p2_drive_file_read_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_drive_file_read_v1(do_p2_drive_file_read_v1) \
    .build()


def main():
    # 构建 client Build client
    cli = lark.ws.Client("APP_ID", "APP_SECRET",
                        event_handler=event_handler, log_level=lark.LogLevel.DEBUG)
    # 建立长连接 Establish persistent connection
    cli.start()

if __name__ == "__main__":
    main()

package com.example.sample;

import com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.drive.DriveService;
import com.lark.oapi.service.drive.v1.model.P2FileReadV1;
import com.lark.oapi.event.EventDispatcher;
import com.lark.oapi.ws.Client;

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations
public class Sample {
    // 注册事件 Register event
    private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("", "")
            .onP2FileReadV1(new DriveService.P2FileReadV1Handler() {
                @Override
                public void handle(P2FileReadV1 event) throws Exception {
                    System.out.printf("[ onP2FileReadV1 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
                }
            })
            .build();

    public static void main(String[] args) {
        // 构建 client Build client
        Client client = new Client.Builder("APP_ID", "APP_SECRET")
                .eventHandler(EVENT_HANDLER)
                .build();
        // 建立长连接 Establish persistent connection
        client.start();
    }
}

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development
import * as Lark from '@larksuiteoapi/node-sdk';
const baseConfig = {
    appId: 'APP_ID',
    appSecret: 'APP_SECRET'
}
// 构建 client Build client
const wsClient = new Lark.WSClient(baseConfig);
// 建立长连接 Establish persistent connection
wsClient.start({
    // 注册事件 Register event
    eventDispatcher: new Lark.EventDispatcher({}).register({
        'drive.file.read_v1': async (data) => {
            console.log(data);
        }
    })
});

package main

import (
	"context"
	"fmt"
	"net/http"

	larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
	"github.com/larksuite/oapi-sdk-go/v3/core/httpserverext"
	larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
	"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
	"github.com/larksuite/oapi-sdk-go/v3/service/drive/v1"
)

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations
func main() {
	// 注册事件 Register event
	eventHandler := dispatcher.NewEventDispatcher("", "").
		OnP2FileReadV1(func(ctx context.Context, event *larkdrive.P2FileReadV1) error {
			fmt.Printf("[ OnP2FileReadV1 access ], data: %s\n", larkcore.Prettify(event))
			return nil
		})

	// 创建路由处理器 Create route handler
	http.HandleFunc("/webhook/event", httpserverext.NewEventHandlerFunc(handler, larkevent.WithLogLevel(larkcore.LogLevelDebug)))

	err := http.ListenAndServe(":7777", nil)

	if err != nil {
		panic(err)
	}
}

# SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development
from flask import Flask
from lark_oapi.adapter.flask import *
import lark_oapi as lark

app = Flask(__name__)


def do_p2_drive_file_read_v1(data: lark.drive.v1.P2DriveFileReadV1) -> None:
    print(f'[ do_p2_drive_file_read_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_drive_file_read_v1(do_p2_drive_file_read_v1) \
    .build()


# 创建路由处理器 Create route handler
@app.route("/webhook/event", methods=["POST"])
def event():
    resp = event_handler.do(parse_req())
    return parse_resp(resp)

if __name__ == "__main__":
    app.run(port=7777)

package com.lark.oapi.sample.event;

import com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.drive.DriveService;
import com.lark.oapi.service.drive.v1.model.P2FileReadV1;
import com.lark.oapi.sdk.servlet.ext.ServletAdapter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations
@RestController
public class EventController {

    // 注册事件 Register event
    private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("verificationToken", "encryptKey")
            .onP2FileReadV1(new DriveService.P2FileReadV1Handler() {
                @Override
                public void handle(P2FileReadV1 event) throws Exception {
                    System.out.printf("[ onP2FileReadV1 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
                }
            })
            .build();

    // 注入 ServletAdapter 实例 Inject ServletAdapter instance
    @Autowired
    private ServletAdapter servletAdapter;

    // 创建路由处理器 Create route handler
    @RequestMapping("/webhook/event")
    public void event(HttpServletRequest request, HttpServletResponse response)
            throws Throwable {
        // 回调扩展包提供的事件回调处理器 Callback handler provided by the extension package
        servletAdapter.handleEvent(request, response, EVENT_DISPATCHER);
    }
}

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development
import http from 'http';
import * as lark from '@larksuiteoapi/node-sdk';

// 注册事件 Register event
const eventDispatcher = new lark.EventDispatcher({
    encryptKey: '',
    verificationToken: '',
}).register({
    'drive.file.read_v1': async (data) => {
        console.log(data);
        return 'success';
    },
});

const server = http.createServer();
// 创建路由处理器 Create route handler
server.on('request', lark.adaptDefault('/webhook/event', eventDispatcher));
server.listen(3000);

应用角色

应用角色成员

事件

列表

用户

导出任务

导入任务

上传

multipart · 上传 · 文件

multipart · 上传 · 媒体

筛选视图条件

文件已读 ​

前提条件 ​

事件 ​

事件体 ​

事件体示例 ​

事件订阅示例代码 ​

文件已读

前提条件

事件

事件体

事件体示例

事件订阅示例代码