本文为您介绍了企业直播服务的所有 API 接口。如果想获得更加便捷的接入体验,可以使用 Java SDK 来调用 API。
API | 说明 |
---|---|
ListActivityAPI | 获取直播间列表信息 |
ListActivityByCacheAPI | 获取直播间列表信息(非实时) |
CreateActivityAPIV2 | 创建直播间 |
DeleteActivityAPI | 删除直播间 |
GetActivityAPI | 获取直播间基础信息 |
GetActivityBasicConfigAPI | 获取直播间基础配置信息 |
UpdateActivityBasicConfigAPI | 更新直播间基础配置信息 |
GetCustomActMsgAPI | 自定义查询直播间信息 |
GetStreamsAPI | 获取推流直播和拉流直播信息 |
UpdatePullToPushAPI | 更新直播间拉流配置 |
UpdateActivityStatusAPI | 更新直播间状态 |
GetAccountTemplateAPI | 获取直播模板列表 |
UpdateAccountTemplateStatusAPI | 更新直播模版状态 |
UpdateDefaultTemplateStatusAPI | 更新默认直播模版 |
UpdatePopularitySettingsAPI | 更新直播间互动人气设置 |
GetPopularitySettingsAPI | 获取直播间互动人气设置 |
API | 说明 |
---|---|
GenerateActivityStreamSlice | 生成直播流切片 |
UpdateAnswerRepetition | 开启或关闭答题重现功能 |
GetActivityReplayPlayerConfig | 获取直播间回放播放器设置 |
UpdateActivityReplayPlayerConfig | 更新直播间回放播放器设置 |
UploadReplayAPI | 关联媒资库视频文件和直播间 |
ListMediasAPI | 获取回放视频列表 |
UpdateMediaOnlineStatusAPI | 上架/下架/解绑回放视频 |
MediasMergeAPI | 合并回放文件 |
API | 说明 |
---|---|
PresenterChatAPIV2 | 主持人发言 |
PollingChatAPI | 获取直播间评论 |
GetHotChatAPI | 获取直播间热门评论 |
GetTopChatAPI | 获取直播间置顶评论 |
DeleteChatAPI | 删除直播间评论 |
LikeChatAPI | 评论点赞 |
TopChatAPI | 评论置顶 |
EmptyChatAPI | 清空直播间评论 |
UpdateChatReviewStatusAPI | 更改直播间评论先审后发状态 |
ConfirmReviewChatAPI | 评论过审 |
SilenceUserAPI | 用户禁言 |
GetSilenceUserListAPI | 获取禁言用户列表 |
API | 说明 |
---|---|
GetActivityMenus | 获取菜单列表 |
ModifyActivityMenus | 更新菜单排序和名称及启用状态 |
GetActivityProducts | 获取商品卡片菜单的配置信息 |
UpdateActivityProduct | 新增或更新商品卡片菜单配置信息 |
DeleteActivityProduct | 删除商品卡片菜单 |
ExplainProduct | 更新商品卡片浮窗展示状态 |
UpdateProductReminderInfo | 更新商品的热卖或库存提醒 |
GetActivityEmbeddedUrls | 获取内嵌链接菜单的配置信息 |
UpdateActivityEmbeddedUrl | 新增或更新内嵌链接菜单配置信息 |
DeleteActivityEmbeddedUrl | 删除内嵌链接菜单 |
GetActivityBands | 获取图文介绍菜单的配置信息 |
UpdateActivityBand | 新增或更新图文介绍菜单配置信息 |
DeleteActivityBand | 删除图文介绍菜单 |
GetActivityCommentConfig | 获取聊天互动菜单基础配置信息 |
UpdateActivityCommentConfig | 更新聊天互动菜单基础配置信息 |
ListActivityCustomEmojiSets | 获取自定义表情专辑列表 |
GetActivityCustomEmojiSetDetail | 获取自定义表情专辑详情 |
ModifyActivityCustomEmojiSets | 更新自定义表情专辑排序 |
DeleteActivityCustomEmojiSet | 删除自定义表情专辑 |
CreateOrUpdateActivityCustomEmojiSet | 新增或更新自定义表情专辑 |
UpdateActivityCustomEmojiSetStatus | 更新自定义表情专辑的启用状态 |
API | 说明 |
---|---|
UpdateAttentionDetectionConfig | 更新认真度检测配置信息 |
GetAttentionDetectionConfig | 获取认真度检测配置信息 |
API | 说明 |
---|---|
GetViewingRestrictionInfo | 获取观看限制配置信息 |
UpdateViewingRestriction | 更新观看限制配置信息 |
InsertWhiteList | 新增白名单观看限制中的白名单 |
GetWhiteList | 获取白名单观看限制中的白名单列表 |
DeleteWhiteList | 删除白名单观看限制中的白名单 |
InsertPhoneList | 新增手机号观看限制中的白名单手机号 |
GetPhoneList | 获取手机号观看限制中的白名单手机号列表 |
DeletePhoneList | 删除手机号观看限制中的白名单手机号 |
API | 说明 |
---|---|
UpdateFloatingAdvertisement | 更新浮标广告配置信息 |
UpdateHostAccount | 新增或更新主播账号信息 |
DeleteHostAccount | 删除主播账号 |
UpdateActivityHostAccount | 更新直播间关联主播账号设置 |
ListHostAccounts | 获取主播账号列表 |
GetBusinessAccountInfo | 获取直播间的关联主播账号信息 |
UpdateActivityQuizConfig | 更新答题或简答配置信息 |
ListActivityQuizConfigs | 获取答题或简答配置信息 |
GetAwardItemList | 获取奖品库奖品列表 |
UpdateAwardItem | 新增或更新奖品库奖品 |
DeleteAwardItem | 删除奖品库奖品 |
ListAwardConfigs | 获取直播间实时抽奖配置信息 |
CreateCoupons | 新增卡券库卡券 |
UpdateCoupon | 更新卡券库卡券信息 |
ListCoupons | 获取卡券库卡券列表 |
DeleteCoupons | 删除卡券库卡券 |
GetCoupon | 查询卡券库卡券信息 |
CreateActivityCoupons | 直播间内新增卡券互动工具 |
UpdateActivityCoupon | 直播间内更新卡券互动工具信息 |
DeleteActivityCoupons | 直播间内删除卡券互动工具 |
ListActivityCoupons | 直播间内获取卡券互动工具列表 |
SendActivityCoupon | 直播间内发送卡券互动工具 |
GetActivityCouponPickData | 获取直播间内指定卡券领取信息 |
GetActivityAllCouponsPickData | 获取直播间内所有卡券领取信息 |
StopActivityCoupon | 直播间内停止发放卡券 |
UpdateActivityPoster | 更新直播分享配置信息 |
GetActivityPoster | 获取直播分享配置信息 |
GetInviterToken | 获取分享人的专属 Token |
ListLivePromotionsAPI | 获取直播转推的平台列表 |
AddLivePromotionsAPI | 批量添加直播转推自定义平台 |
UpdateLivePromotionsStatusAPI | 更新直播转推自定义平台 |
DeleteLivePromotionsAPI | 删除直播转推的自定义平台 |
ListChannelAPI | 获取直播间的渠道列表 |
API | 说明 |
---|---|
GetVideoLibraryFolderTree | 获取视频库分类信息(包含子分类) |
SearchVideoLibraryFolderTree | 获取视频库分类信息(不包含子分类) |
MediaCut | 剪辑视频 |
UpdateActivityMediaInfo | 更新媒资库视频信息 |
ListActivityMediaAPI | 获取媒资库视频信息 |
TempToMediaActivityMediaAPI | 直播暂存转存视频库 |
UploadMediaByURL | 批量上传视频至媒资库 |
QueryUploadMediaByURL | 获取批量上传视频的结果 |
DeleteMediaLibraryVideoAPI | 批量删除媒资库视频 |
API | 说明 |
---|---|
ListUserSubmitEnterReviewAPI | 获取用户填写的报名信息 |
ReviewUserEnterFormAPI | 审核报名表单 |
API | 说明 |
---|---|
GetActivityAntidirtAPI | 查询敏感词 |
AddActivityAntidirtAPI | 添加敏感词 |
DelActivityAntidirtAPI | 删除敏感词 |
API | 说明 |
---|---|
GetTeachAssistantConfig | 获取直播助教平台的页面设置 |
UpdateTeachAssistantConfig | 更新直播助教平台的页面设置 |
ListTeachAssistantAccounts | 获取直播助教账号信息列表 |
UpdateTeachAssistantAccount | 新增或更新直播助教账号信息 |
DeleteTeachAssistantAccount | 删除直播助教账号 |
API | 说明 |
---|---|
GetSecurityControlConfig | 获取直播间安全管控配置信息 |
UpdateSecurityControlConfig | 更新直播间安全管控配置信息 |
UpdateAccountBanStatus | 账号维度封禁或解禁观众 |
UpdateActivityUserBanStatus | 直播间维度踢出或解除踢出观众或设备 |
GetActivityBanUsers | 获取直播间被踢出的观众和设备列表 |
UpdateActivityIpBanStatus | 直播间维度封禁或解禁 IP 地址 |
GetActivityBanIps | 获取直播间被封禁的 IP 列表 |
API | 说明 |
---|---|
SendProductOrderMessage | 发送商品下单购买消息 |
SendCustomSystemMessageAPI | 发送自定义系统消息 |
GetActivityMessageConfig | 获取直播间系统消息设置 |
UpdateActivityMessageConfig | 更新直播间系统消息设置 |
API | 说明 |
---|---|
GetActivityLinks | 获取直播间链接信息 |
GetDownloadLiveClient | 获取直播伴侣一键开播地址或嘉宾连麦登录地址 |
GetWebPushLiveClientAPI | 获取网页直播一键开播地址 |
GetTemporaryLoginTokenAPI | 获取开播密钥 |
API | 说明 |
---|---|
ListSiteTagAPIV2 | 获取直播间标签列表 |
UpdateSiteTagAPIV2 | 更新直播间标签信息 |
API | 说明 |
---|---|
GetSDKTokenAPI | 获取观众进入直播间的授权 Token |
API | 说明 |
---|---|
GetLoginLivesaasSts | 获取企业直播 STS 签名 |
API | 说明 |
---|---|
UpdateVodPlayerConfig | 新增或更新点播播放器信息 |
DeleteVodPlayerConfig | 删除点播播放器 |
UpdateDefaultVodPlayerConfig | 设置默认点播播放器 |
GetVodPlayerConfig | 获取点播播放器配置信息 |
ListVodPlayerConfig | 获取点播播放器列表 |
GetVodPlayerToken | 获取点播播放器 Token |
API | 说明 |
---|---|
GetAudienceGroupConfig | 获取直播分组配置信息 |
UpdateAudienceGroupConfig | 更新直播分组配置信息 |
ListAudienceGroupUser | 获取直播分组的观众信息列表 |
UpdateAudienceGroupUserConfig | 更新观众的直播分组 |
AddAudienceGroup | 新增直播分组 |
ModifyAudienceGroup | 更新直播分组 |
DeleteAudienceGroup | 删除直播分组 |
API | 说明 |
---|---|
ListLoopVideos | 获取伪直播配置信息 |
UpdateLoopVideos | 更新伪直播配置信息 |
UpdateLoopVideoStatus | 更新伪直播开启状态 |
ListPrograms | 获取节目单列表 |
UpdateProgram | 新增或更新节目单配置信息 |
DeleteProgram | 删除节目单 |
API | 说明 |
---|---|
CreateInteractionScript | 创建空白互动脚本 |
ListInteractionScriptComments | 获取互动脚本评论列表 |
AddInteractionScriptComments | 新增互动脚本评论 |
EditInteractionScriptComment | 更新互动脚本评论 |
DeleteInteractionScriptComment | 删除互动脚本评论 |
API | 说明 |
---|---|
AddActivityPartnerRebroadcast | 添加伴侣转播直播间 |
DeleteActivityPartnerRebroadcast | 删除伴侣转播直播间 |
GetActivityPartnerRebroadcast | 获取伴侣转播直播间信息 |
API | 说明 |
---|---|
CreateLiveChannelConfig | 新增直播频道 |
DeleteLiveChannelConfig | 删除直播频道 |
UpdateLiveChannelConfig | 更新直播频道 |
ListLiveChannelConfig | 获取直播频道信息列表 |
API | 说明 |
---|---|
GetLarkSubAccountInfo | 获取飞书子账号信息 |
CreateSubAccount | 创建子账号 |
UpdateSubAccount | 更新子账号信息 |
DeleteSubAccount | 删除子账号 |
ListSubAccounts | 获取子账号列表 |
GetSubAccount | 查询子账号 |
ListSubAccountRoles | 获取子账号角色列表 |
ListSubAccountOrganizations | 获取子账号组织列表 |
API | 说明 |
---|---|
CreateAreaConfig | 新增区域 |
UpdateAreaConfig | 更新区域配置 |
DeleteAreaConfig | 删除区域 |
ListAreaConfig | 获取区域列表 |
CreateOfficeConfig | 新增工区 |
UpdateOfficeConfig | 更新工区配置 |
DeleteOfficeConfig | 删除工区 |
ListOfficeConfig | 获取工区列表 |