API概览

本文为您介绍了互动直播的所有API列表,建议您使用服务端SDK来调用API。

令牌

API

描述

GetAuthToken

调用GetAuthToken获取长链接建连Token,客户端可以用此Token通过长链接和各个原子能力进行通信。

直播

API

描述

CreateLive

调用CreateLive创建状态为未开播的新直播。

DeleteLive

调用DeleteLive删除直播记录。

UpdateLive

调用UpdateLive更新指定直播相关信息。

GetLive

调用GetLive查询与指定直播相关联的信息。

PublishLive

调用PublishLive发布直播,将直播状态转变为直播中,并获取推拉流地址。

StopLive

调用StopLive停止指定直播,直播状态改变为直播结束。

课堂

API

描述

CreateClass

调用CreateClass创建课堂。

GetClassDetail

调用GetClassDetail获取课堂详情。

UpdateClass

调用UpdateClass更新课堂信息。

DeleteClass

调用DeleteClass删除课堂。

StopClass

调用StopClass执行下课,会修改课堂状态为已下课。

房间

API

描述

CreateRoom

调用CreateRoom创建一个房间,用户可以在房间内使用直播、白板、音视频通信等能力。

DeleteRoom

调用DeleteRoom删除指定房间,删除后房间无法继续使用。

UpdateRoom

调用UpdateRoom更新房间所有可修改信息。

ListRooms

调用ListRooms查询应用下的房间列表,包含每个房间的信息和正在使用的原子能力信息。

GetRoom

调用GetRoom查询指定房间信息,包含房间信息和使用中的原子能力信息。

应用

API

描述

CreateApp

调用CreateApp创建互动直播PaaS应用。

DeleteApp

调用DeleteApp删除互动直播PaaS应用。

UpdateApp

调用UpdateApp更新应用信息。

ListApps

调用ListApps分页查询应用列表。

GetApp

调用GetApp查询应用详情。

CreateAppTemplate

调用CreateAppTemplate创建应用模板。

DeleteAppTemplate

调用DeleteAppTemplate删除应用模板。

UpdateAppTemplate

调用UpdateAppTemplate更新应用模板。

ListAppTemplates

调用ListAppTemplates分页查询应用模板信息。

GetAppTemplate

调用GetAppTemplate查询应用模板信息。

UpdateAppTemplateConfig

调用UpdateAppTemplateConfig更新应用模板中的组件配置。

ListComponents

调用ListComponents查询支持的组件列表,以及查询模板中配置的组件详情。

消息

API

描述

SendCustomMessageToAll

调用SendCustomMessageToAll向直播间里全部在线成员发送自定义消息。

SendCustomMessageToUsers

调用SendCustomMessageToUsers向直播间中的指定成员发送自定义消息。

连麦

API

描述

CreateConference

调用CreateConference创建一场会议。

GetConference

调用GetConference查询指定会议信息,包含会议标题和会议状态。

UpdateConference

调用UpdateConference更新指定会议相关信息。

AddMember

调用AddMember邀请成员加入会议。

ListConferenceUsers

调用ListConferenceUsers分页查询会议用户信息。

RemoveMember

调用RemoveMember将指定用户从会议中移除。

DeleteConference

调用DeleteConference删除会议记录。

ApplyLinkMic

调用ApplyLinkMic进行申请连麦。

CancelApplyLinkMic

调用CancelApplyLinkMic取消申请连麦,将指定用户的状态改为取消申请连麦。

AgreeLinkMic

调用AgreeLinkMic完成同意指定用户的申请连麦请求。

RejectLinkMic

调用RejectLinkMic完成拒绝指定用户的申请连麦请求。

ListApplyLinkMicUsers

调用ListApplyLinkMicUsers分页查询申请连麦用户列表信息。

样板间

API

描述

GetStandardRoomJumpUrl

调用GetStandardRoomJumpUrl获取样板间服务跳转链接。