API概览

本产品(低代码音视频工厂/2021-06-30)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行对接,或提交工单反馈给我们。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

长连接

API标题API概述
GetAuthToken获取长连接建连Token调用GetAuthToken获取长连接建连Token,客户端可以用此Token通过LWP协议和各个原子能力进行长连接通信。

直播

API标题API概述
获取直播列表获取直播列表
ListLiveRooms批量查询直播信息调用ListLiveRooms分页查询直播信息。
ListLiveRoomsById根据直播ID批量查询直播信息调用ListLiveRoomsById根据传入的直播ID批量查询指定的直播信息。
直播数据统计直播数据统计
GetLiveRoomStatistics查询直播统计数据调用GetLiveRoomStatistics查询与指定直播相关的数据统计信息。后续计划迁入新方案,不推荐使用。
GetLiveRoomUserStatistics分页查询直播用户数据统计调用GetLiveRoomUserStatistics分页查询与指定直播相关的用户观看数据。后续计划迁入新方案,不推荐使用。
直播录制直播录制
GetLiveRecord获取直播录制信息调用GetLiveRecord获取直播录制信息。可用于直播结束后获取回放地址,如果直播未结束,结果为空。
CreateLiveRecordSliceFile创建直播录制片段文件调用CreateLiveRecordSliceFile创建直播录制片段文件。
ListLiveFiles获取直播录制文件列表调用ListLiveFiles获取直播录制文件列表信息。
DeleteLiveFilesById根据直播ID删除该直播的录制文件调用DeleteLiveFilesById接口删除该直播的录制文件。
CreateLiveRoom创建直播调用CreateLiveRoom创建状态为未开播的新直播。
DeleteLiveRoom删除直播调用DeleteLiveRoom删除直播记录。
PublishLiveRoom发布直播调用PublishLiveRoom发布直播,将直播状态转变为直播中,并获取推拉流地址。
UpdateLiveRoom更新直播信息调用UpdateLiveRoom更新指定直播相关信息。
StopLiveRoom停止直播调用StopLiveRoom停止指定直播,直播状态改变为直播结束。
GetLiveRoom查询直播详情调用GetLiveRoom查询指定直播相关信息。

课堂

API标题API概述
CreateClass创建课程调用CreateClass创建课程。可用于学生上课,职场培训等场景,包含连麦、直播、白板、聊天等功能。
DeleteClass删除课程调用DeleteClass删除课程。
StopClass结束课程调用StopClass执行结束课程动作,会修改课程状态为已下课。
UpdateClass更新课程调用UpdateClass更新课程。
GetClassDetail获取课程详情调用GetClassDetail获取课程详情。可用于查询课程状态,以及相关联的直播,连麦,白板等ID信息。通过这些ID,可进一步查询对应的直播,连麦,白板的详情。
ListClasses获取课程列表调用ListClasses获取课程列表。可基于应用ID和课程状态,分页查询应用对应的所有课程列表。
GetClassRecord获取课程录制信息调用GetClassRecord获取课程录制信息。可用于课程结束后获取回放地址,如果课程未结束,结果为空。
UpdateShareScreenLayout更新共享屏幕布局调用UpdateShareScreenLayout更新共享屏幕布局。可用于课堂场景,直播画面中共享屏幕画面叠加老师摄像头画面。

房间

API标题API概述
CreateRoom创建房间调用CreateRoom创建一个房间,用户可以在房间内使用直播、白板、音视频通信等功能。
DeleteRoom删除房间调用DeleteRoom删除指定房间,删除后房间无法继续使用。
UpdateRoom更新房间信息调用UpdateRoom更新房间所有可修改信息。
KickRoomUser踢出房间用户调用KickRoomUser接口,实现对房间内某特定用户实施踢出房间操作。
SetUserAdmin设置用户管理员调用SetUserAdmin接口,设置房间内某特定用户为管理员。
CancelUserAdmin取消用户管理员调用CancelUserAdmin接口,取消房间内某特定用户管理员身份,变成普通观众。
GetRoom查询房间详情调用GetRoom查询指定房间信息,包含房间信息和使用中的原子能力信息。
ListRooms查询房间列表调用ListRooms查询应用下的房间列表,包含每个房间的信息和正在使用的原子能力信息。
ListRoomUsers查询房间用户列表调用ListRoomUsers分页查询房间内的实时用户列表。

消息

API标题API概述
敏感词敏感词
CreateSensitiveWord自定义敏感词自定义敏感词。
DeleteSensitiveWord删除敏感词调用DeleteSensitiveWord删除敏感词。
ListSensitiveWord查询敏感词调用ListSensitiveWord查询敏感词。
禁言禁言
CancelBanAllComment取消全员禁言调用CancelBanAllComment接口,取消房间内全员禁言的限制。
CancelBanComment取消禁言调用CancelBanComment接口,取消对房间内某特定用户的禁言。
BanAllComment全员禁言调用BanAllComment接口,禁言房间内所有用户。
BanComment禁言调用BanComment接口,实现对房间内某特定用户实施禁言操作。
消息管理消息管理
SendCustomMessageToAll发送自定义消息调用SendCustomMessageToAll向房间中全部在线成员发送自定义消息。
SendCustomMessageToUsers指定房间成员发送自定义消息调用SendCustomMessageToUsers向房间中的指定成员发送自定义消息。
SendComment发送弹幕消息调用SendComment发送弹幕消息,该弹幕消息会推送给房间内所有在线人员。
DeleteComment删除弹幕消息调用DeleteComment删除弹幕消息。
ListComments批量查询弹幕消息调用ListComments批量查询弹幕消息。
DeleteCommentByCreatorId根据创建者ID批量删除弹幕调用DeleteCommentByCreatorId根据创建者ID批量删除弹幕。

连麦

API标题API概述
DeleteConference结束连麦调用DeleteConference结束连麦。一般用于管理后台结束,或长时间未退出时的强制结束。
RemoveMember踢人调用RemoveMember将指定用户从连麦中踢出。
GetConference查询连麦详情调用GetConference查询指定连麦信息,包含连麦标题和连麦状态。也可查询连麦结束后的录制地址。
ListConferenceUsers查询连麦用户列表调用ListConferenceUsers分页查询连麦用户信息。

低代码服务

API标题API概述
GetStandardRoomJumpUrl获取低代码服务跳转链接调用GetStandardRoomJumpUrl获取低代码服务跳转链接。

用量查询

API标题API概述
DescribeMeterImpWatchLiveTimeByLiveId根据直播唯一标识查看观看时长调用DescribeMeterImpWatchLiveTimeByLiveId查看观看时长相关数据,包含普通延迟观看时长,低延迟观看时长。
DescribeMeterImpPlayBackTimeByLiveId查询指定直播资源的回看时长调用DescribeMeterImpPlayBackTimeByLiveId查询指定直播资源的回看时长。

直播(旧)

API标题API概述
CreateLive创建直播创建状态为未开播的新直播。
DeleteLive删除直播删除直播记录。
PublishLive发布直播发布直播,将直播状态转变为直播中,并获取推拉流地址。
UpdateLive更新直播信息更新指定直播相关信息。
StopLive停止直播停止指定直播,直播状态改变为直播结束。
GetLive查询直播详情查询与指定直播相关联的信息。
阿里云首页 低代码音视频工厂 相关技术圈