BililiveRecorder API接口完全参考：Webhook和RESTful接口详解

BililiveRecorder API接口完全参考Webhook和RESTful接口详解【免费下载链接】BililiveRecorder录播姬 | mikufans 生放送录制项目地址: https://gitcode.com/gh_mirrors/bi/BililiveRecorderBililiveRecorder录播姬是一款强大的mikufans生放送录制工具提供了丰富的API接口来实现自动化控制和集成。本文将详细介绍其Webhook通知机制和RESTful API接口帮助开发者快速实现自定义集成方案。一、Webhook通知机制详解Webhook是BililiveRecorder的核心功能之一能够在录制事件发生时主动推送通知非常适合构建实时监控和自动化工作流。1.1 Webhook版本与配置BililiveRecorder支持两种Webhook版本可在配置文件中进行设置Webhook V1基础版本支持录制结束事件通知Webhook V2增强版本支持更多事件类型和详细数据配置文件路径BililiveRecorder.Core/Config/V3/Config.gen.cs1.2 Webhook V2支持的事件类型Webhook V2支持多种录制事件包括录制文件打开FileOpening录制文件关闭FileClosed录制会话开始SessionStarted录制会话结束SessionEnded直播流开始StreamStarted直播流结束StreamEnded事件实现代码BililiveRecorder.Core/SimpleWebhook/BasicWebhookV2.cs1.3 Webhook数据格式Webhook V2发送的JSON数据格式示例{ type: FileClosed, timestamp: 1620000000, roomId: 12345, filename: 2023-01-01-12-00-00.flv, duration: 3600, filesize: 104857600 }二、RESTful API接口完全指南BililiveRecorder提供了完整的RESTful API接口可通过HTTP请求实现对录播姬的完全控制。2.1 API基础信息API根路径/api内容类型application/json认证方式基础认证Basic Auth2.2 房间管理API房间管理API允许你添加、删除和查询直播间主要接口如下2.2.1 获取所有直播间GET /api/Room响应示例[ { objectId: f47ac10b-58cc-4372-a567-0e02b2c3d479, roomId: 12345, shortId: 12345, name: 主播名称, status: Recording, autoRecord: true } ]实现代码BililiveRecorder.Web/Api/RoomController.cs2.2.2 添加直播间POST /api/Room请求体{ roomId: 12345, autoRecord: true }实现代码BililiveRecorder.Web/Api/RoomController.cs#L472.2.3 删除直播间DELETE /api/Room/{roomId}2.3 录制控制API通过录制控制API可以远程控制直播间的录制状态2.3.1 开始录制POST /api/Room/{roomId}/start实现代码BililiveRecorder.Web/Api/RoomController.cs#L2982.3.2 停止录制POST /api/Room/{roomId}/stop2.3.3 手动分段POST /api/Room/{roomId}/split2.4 配置管理API配置管理API允许你读取和修改录播姬的全局设置和房间设置2.4.1 获取全局配置GET /api/Config/global实现代码BililiveRecorder.Web/Api/ConfigController.cs#L352.4.2 更新全局配置POST /api/Config/global请求体示例{ apiHost: https://api.live.bilibili.com, apiTimeout: 10000, webhookV2Urls: [https://your-webhook-endpoint.com] }三、API使用示例3.1 使用curl控制录制开始录制curl -X POST http://localhost:23333/api/Room/12345/start \ -u username:password获取录制状态curl http://localhost:23333/api/Room/12345/stats \ -u username:password3.2 Webhook接收示例Node.jsconst express require(express); const bodyParser require(body-parser); const app express(); app.use(bodyParser.json()); app.post(/webhook, (req, res) { const event req.body; console.log(Received event: ${event.type}); if (event.type FileClosed) { console.log(New recording: ${event.filename}, Size: ${event.filesize} bytes); // 处理录制完成的文件 } res.status(200).send(OK); }); app.listen(3000, () console.log(Webhook server running on port 3000));四、常见问题与故障排除4.1 API请求返回401 Unauthorized这通常是认证失败导致的请检查用户名和密码是否正确。默认用户名和密码在配置文件中设置。4.2 Webhook没有收到通知检查Webhook URL是否可达确认配置中的Webhook URL是否正确查看录播姬日志文件获取详细错误信息4.3 API响应缓慢检查网络连接确认录播姬是否在高负载状态调整API超时设置BililiveRecorder.Core/Config/V3/Config.gen.cs五、API集成最佳实践错误处理实现重试机制处理临时网络问题安全性始终使用HTTPS保护API通信性能优化批量操作多个直播间时使用批量API监控定期调用状态API监控录播姬运行状态日志记录API交互日志以便故障排除通过本文介绍的Webhook和RESTful API你可以轻松将BililiveRecorder集成到自己的工作流中实现自动化录制管理、实时监控和自定义处理逻辑。无论是构建个人录制管理系统还是企业级直播内容管理平台这些API都能提供强大的支持。要开始使用这些API只需克隆项目仓库git clone https://gitcode.com/gh_mirrors/bi/BililiveRecorder然后参考项目文档进行配置和开发。【免费下载链接】BililiveRecorder录播姬 | mikufans 生放送录制项目地址: https://gitcode.com/gh_mirrors/bi/BililiveRecorder创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考