本产品(
低代码音视频工厂/2021-06-30
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用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 | 查询直播详情 | 查询与指定直播相关联的信息。 |