开始录制
发生在开始录制时【仅通过Open API预约的会议会产生此类事件】
事件
| 项目 | 值 |
|---|---|
| 事件类型 | vc.meeting.recording_started_v1 |
| 支持的应用类型 | custom,isv |
| 权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 开启任一权限即可 | vc:meeting:readonly 获取会议信息 vc:meeting.meetingevent:read 获取会议信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
| 推送方式 | Webhook |
事件体
| 名称 | 类型 | 描述 |
|---|---|---|
schema | string | 事件模式 |
header | event_header | 事件头 |
└ event_id | string | 事件 ID |
└ event_type | string | 事件类型 |
└ create_time | string | 事件创建时间戳(单位:毫秒) |
└ token | string | 事件 Token |
└ app_id | string | 应用 ID |
└ tenant_key | string | 租户 Key |
event | \- | - |
└ meeting | meeting_event_meeting | 会议数据 |
└ id | string | 会议ID(视频会议的唯一标识,视频会议开始后才会产生) |
└ topic | string | 会议主题 |
└ meeting_no | string | 9位会议号(飞书用户可通过输入9位会议号快捷入会) |
└ meeting_source | int | 会议创建源 可选值有: - 1: 日程会议 - 2: 即时会议 - 3: 面试会议 - 4: 开放平台会议 - 100: 其他会议类型 |
└ start_time | string | 会议开始时间(unix时间,单位:秒) |
└ end_time | string | 会议结束时间(unix时间,单位:秒) |
└ host_user | meeting_event_user | 会议主持人 |
└ id | user_id | 用户 ID |
└ union_id | string | 用户的 union id |
└ user_id | string | 用户的 user id 字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
└ open_id | string | 用户的 open id |
└ user_role | int | 用户会中角色 可选值有: - 1: 普通参会人 - 2: 主持人 - 3: 联席主持人 |
└ user_type | int | 用户类型 可选值有: - 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户 - 8: sharebox用户 - 9: 开放平台应用 |
└ owner | meeting_event_user | 会议拥有者 |
└ id | user_id | 用户 ID |
└ union_id | string | 用户的 union id |
└ user_id | string | 用户的 user id 字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
└ open_id | string | 用户的 open id |
└ user_role | int | 用户会中角色 可选值有: - 1: 普通参会人 - 2: 主持人 - 3: 联席主持人 |
└ user_type | int | 用户类型 可选值有: - 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户 - 8: sharebox用户 - 9: 开放平台应用 |
└ meeting_sub_type | int | 会议子类型 可选值有: - 1: 会前投屏 - 2: 有线共享 - 3: 会前妙享 - 4: 企业办公电话 - 5: IP Phone - 6: 网络研讨会 |
└ security_setting | meeting_security_setting | 会议安全设置 |
└ security_level | int | 安全级别 可选值有: - 1: 所有人可加入 - 2: 仅企业内用户可加入 - 3: 仅指定联系人和群可加入 - 4: 仅主持人可参会(锁定会议) |
└ group_ids | string\[\] | 允许入会的群组ID列表 数据校验规则: - 长度范围: 0 ~ 200 |
└ user_ids | user_id\[\] | 允许入会的用户ID列表 数据校验规则: - 长度范围: 0 ~ 200 |
└ union_id | string | 用户的 union id |
└ user_id | string | 用户的 user id |
└ open_id | string | 用户的 open id |
└ room_ids | string\[\] | 允许入会的会议室ID列表 数据校验规则: - 长度范围: 0 ~ 200 |
└ has_set_security_contacts_and_group | boolean | 是否设置了仅指定联系人和群组可参会 |
└ webinar_setting | meeting_webinar_setting | 研讨会相关设置 |
└ webinar_type | int | 网络研讨会类型 可选值有: - 1: 普通网络研讨会 - 2: 直播网络研讨会 |
└ operator | meeting_event_user | 事件操作人 |
└ id | user_id | 用户 ID |
└ union_id | string | 用户的 union id |
└ user_id | string | 用户的 user id 字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
└ open_id | string | 用户的 open id |
└ user_role | int | 用户会中角色 可选值有: - 1: 普通参会人 - 2: 主持人 - 3: 联席主持人 |
└ user_type | int | 用户类型 可选值有: - 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户 - 8: sharebox用户 - 9: 开放平台应用 |
事件体示例
json
{
"schema": "2.0",
"header": {
"event_id": "5e3702a84e847582be8db7fb73283c02",
"event_type": "vc.meeting.recording_started_v1",
"create_time": "1608725989000",
"token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
"app_id": "cli_9f5343c580712544",
"tenant_key": "2ca1d211f64f6438"
},
"event": {
"meeting": {
"id": "6911188411934433028",
"topic": "my meeting",
"meeting_no": "235812466",
"meeting_source": 1,
"start_time": "1608883322",
"end_time": "1608883899",
"host_user": {
"id": {
"union_id": "on_8ed6aa67826108097d9ee143816345",
"user_id": "e33ggbyz",
"open_id": "ou_84aad35d084aa403a838cf73ee18467"
},
"user_role": 1,
"user_type": 1
},
"owner": {
"id": {
"union_id": "on_8ed6aa67826108097d9ee143816345",
"user_id": "e33ggbyz",
"open_id": "ou_84aad35d084aa403a838cf73ee18467"
},
"user_role": 1,
"user_type": 1
},
"meeting_sub_type": 1,
"security_setting": {
"security_level": 1,
"group_ids": [
"[oc_XXXXf6a28a0d08c45d895267e8b4a91i]"
],
"user_ids": [
{
"union_id": "on_785a8cda5345f665f7187d7d876cb790",
"user_id": "f3e15a6a",
"open_id": "ou_2cc0462a0597358575e771bea74e3304"
}
],
"room_ids": [
"[omm_XXe32cf10a4358788ff4e09e37ebbf9b]"
],
"has_set_security_contacts_and_group": true
},
"webinar_setting": {
"webinar_type": 1
}
},
"operator": {
"id": {
"union_id": "on_8ed6aa67826108097d9ee143816345",
"user_id": "e33ggbyz",
"open_id": "ou_84aad35d084aa403a838cf73ee18467"
},
"user_role": 1,
"user_type": 1
}
}
}事件订阅示例代码
订阅方式
长连接方式(推荐):无需发布到公网地址,在本地开发环境中即可接收事件回调,且无需处理加解密逻辑。 发送至开发者服务器:需要提供服务器公网地址。
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/vc/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("", "").
OnP2MeetingRecordingStartedV1(func(ctx context.Context, event *larkvc.P2MeetingRecordingStartedV1) error {
fmt.Printf("[ OnP2MeetingRecordingStartedV1 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_vc_meeting_recording_started_v1(data: lark.vc.v1.P2VcMeetingRecordingStartedV1) -> None:
print(f'[ do_p2_vc_meeting_recording_started_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_vc_meeting_recording_started_v1(do_p2_vc_meeting_recording_started_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.vc.VcService;
import com.lark.oapi.service.vc.v1.model.P2MeetingRecordingStartedV1;
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("", "")
.onP2MeetingRecordingStartedV1(new VcService.P2MeetingRecordingStartedV1Handler() {
@Override
public void handle(P2MeetingRecordingStartedV1 event) throws Exception {
System.out.printf("[ onP2MeetingRecordingStartedV1 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({
'vc.meeting.recording_started_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/vc/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("", "").
OnP2MeetingRecordingStartedV1(func(ctx context.Context, event *larkvc.P2MeetingRecordingStartedV1) error {
fmt.Printf("[ OnP2MeetingRecordingStartedV1 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_vc_meeting_recording_started_v1(data: lark.vc.v1.P2VcMeetingRecordingStartedV1) -> None:
print(f'[ do_p2_vc_meeting_recording_started_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_vc_meeting_recording_started_v1(do_p2_vc_meeting_recording_started_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.vc.VcService;
import com.lark.oapi.service.vc.v1.model.P2MeetingRecordingStartedV1;
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")
.onP2MeetingRecordingStartedV1(new VcService.P2MeetingRecordingStartedV1Handler() {
@Override
public void handle(P2MeetingRecordingStartedV1 event) throws Exception {
System.out.printf("[ onP2MeetingRecordingStartedV1 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({
'vc.meeting.recording_started_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);