直播
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 获取直播列表 | ||
ListLiveRooms | 分页查询直播信息 | 查看文档去调试 |
| ListLiveRoomsById | 根据传入的直播ID批量查询指定的直播信息 | 查看文档去调试 |
| 直播数据统计 | ||
| GetLiveRoomStatistics | 查询与指定直播相关的数据统计信息。后续计划迁入新方案，不推荐使用 | 查看文档去调试 |
| GetLiveRoomUserStatistics | 分页查询与指定直播相关的用户观看数据。后续计划迁入新方案，不推荐使用 | 查看文档去调试 |
| 直播录制 | ||
| GetLiveRecord | 获取直播录制信息。可用于直播结束后获取回放地址，如果直播未结束，结果为空 | 查看文档去调试 |
| CreateLiveRecordSliceFile | 创建直播录制片段文件 | 查看文档去调试 |
| ListLiveFiles | 获取直播录制文件列表信息 | 查看文档去调试 |
| DeleteLiveFilesById | 删除该直播的录制文件 | 查看文档去调试 |
| CreateLiveRoom | 创建状态为未开播的新直播 | 查看文档去调试 |
| GetLiveRoom | 查询指定直播相关信息 | 查看文档去调试 |
| PublishLiveRoom | 发布直播，将直播状态转变为直播中，并获取推拉流地址 | 查看文档去调试 |
| UpdateLiveRoom | 更新指定直播相关信息 | 查看文档去调试 |
| StopLiveRoom | 停止指定直播，直播状态改变为直播结束 | 查看文档去调试 |
| DeleteLiveRoom | 删除直播记录 | 查看文档去调试 |
课堂
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateClass | 创建课程。可用于学生上课，职场培训等场景，包含连麦、直播、白板、聊天等功能 | 查看文档去调试 |
| GetClassDetail | 获取课程详情。可用于查询课程状态，以及相关联的直播，连麦，白板等ID信息。通过这些ID，可进一步查询对应的直播，连麦，白板的详情 | 查看文档去调试 |
| StopClass | 执行结束课程动作，会修改课程状态为已下课 | 查看文档去调试 |
| UpdateClass | 更新课程 | 查看文档去调试 |
| DeleteClass | 删除课程 | 查看文档去调试 |
| ListClasses | 获取课程列表。可基于应用ID和课程状态，分页查询应用对应的所有课程列表 | 查看文档去调试 |
| GetClassRecord | 获取课程录制信息。可用于课程结束后获取回放地址，如果课程未结束，结果为空 | 查看文档去调试 |
| UpdateShareScreenLayout | 更新共享屏幕布局。可用于课堂场景，直播画面中共享屏幕画面叠加老师摄像头画面 | 查看文档去调试 |
房间
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateRoom | 创建一个房间，用户可以在房间内使用直播、白板、音视频通信等功能 | 查看文档去调试 |
| GetRoom | 查询指定房间信息，包含房间信息和使用中的原子能力信息 | 查看文档去调试 |
| ListRooms | 查询应用下的房间列表，包含每个房间的信息和正在使用的原子能力信息 | 查看文档去调试 |
| UpdateRoom | 更新房间所有可修改信息 | 查看文档去调试 |
| KickRoomUser | 实现对房间内某特定用户实施踢出房间操作 | 查看文档去调试 |
| SetUserAdmin | 设置房间内某特定用户为管理员 | 查看文档去调试 |
| CancelUserAdmin | 取消房间内某特定用户管理员身份，变成普通观众 | 查看文档去调试 |
| DeleteRoom | 删除指定房间，删除后房间无法继续使用 | 查看文档去调试 |
| ListRoomUsers | 分页查询房间内的实时用户列表 | 查看文档去调试 |
消息
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 敏感词 | ||
| CreateSensitiveWord | 自定义敏感词 | 查看文档去调试 |
| DeleteSensitiveWord | 删除敏感词 | 查看文档去调试 |
| ListSensitiveWord | 查询敏感词 | 查看文档去调试 |
| 禁言 | ||
| CancelBanAllComment | 取消房间内全员禁言的限制 | 查看文档去调试 |
| CancelBanComment | 取消对房间内某特定用户的禁言 | 查看文档去调试 |
| BanAllComment | 禁言房间内所有用户 | 查看文档去调试 |
| BanComment | 实现对房间内某特定用户实施禁言操作 | 查看文档去调试 |
| 消息管理 | ||
| SendCustomMessageToAll | 向房间中全部在线成员发送自定义消息 | 查看文档去调试 |
| SendCustomMessageToUsers | 向房间中的指定成员发送自定义消息 | 查看文档去调试 |
| SendComment | 发送弹幕消息，该弹幕消息会推送给房间内所有在线人员 | 查看文档去调试 |
| ListComments | 批量查询弹幕消息 | 查看文档去调试 |
| DeleteComment | 删除弹幕消息 | 查看文档去调试 |
| DeleteCommentByCreatorId | 根据创建者ID批量删除弹幕 | 查看文档去调试 |