You need to enable JavaScript to run this app.
导航
API 概览
最近更新时间:2024.11.15 11:54:18首次发布时间:2021.02.23 10:42:22

本文为您介绍了企业直播服务的所有 API 接口。如果想获得更加便捷的接入体验,可以使用 Java SDK 来调用 API。

2023-08-01

回放管理

API

说明

GenerateActivityStreamSlice

生成直播流切片

UpdateAnswerRepetition

开启或关闭答题重现功能

数据查询

API

说明

GetAccountAggregatedStatistics

获取主账号下的核心统计数据

ListAccountActivityData

获取主账号下的直播间实时统计数据

ListAccountUserData

获取主账号下的用户画像数据

GetAccountUserTrackData

获取观众的用户画像详情

GetAdvertisementDataDetailAPI

获取直播间营销推广点击数据

GetActivityLivePromotionData

获取直播间直播转推数据

GetActivityLivePromotionDetail

获取直播间直播转推详情

ListAwardConfigs

获取直播间实时抽奖配置信息

ListAwardRecordStatistics

获取直播间实时抽奖参与或中奖名单

ListActivityUsers

获取实时观众列表

GetLiveTrafficPostPayData

获取直播流量使用信息

评论设置

API

说明

AddRobotComments

添加机器人评论

ListRobotComments

获取机器人评论列表

DeleteRobotComments

删除机器人评论

AddRobotNickNames

添加机器人昵称

ListRobotNickNames

获取机器人昵称列表

DeleteRobotNickNames

删除机器人昵称

GetActivityRobotCommentConfig

获取机器人评论配置

UpdateActivityRobotCommentConfig

更新机器人评论配置

菜单栏控制

API

说明

GetActivityProducts

获取商品卡片菜单的配置信息

UpdateActivityProduct

新增或更新商品卡片菜单配置信息

DeleteActivityProduct

删除商品卡片菜单

ExplainProduct

更新卡片浮窗展示状态

GetActivityEmbeddedUrls

获取内嵌链接菜单的配置信息

UpdateActivityEmbeddedUrl

新增或更新内嵌链接菜单配置信息

DeleteActivityEmbeddedUrl

删除内嵌链接菜单

GetActivityBands

获取图文介绍菜单的配置信息

UpdateActivityBand

新增或更新图文介绍菜单配置信息

DeleteActivityBand

删除图文介绍菜单

GetActivityMenus

获取菜单列表

ModifyActivityMenus

更新菜单排序和名称及启用状态

GetActivityCommentConfig

获取聊天互动菜单基础配置信息

UpdateActivityCommentConfig

更新聊天互动菜单基础配置信息

ListActivityCustomEmojiSets

获取自定义表情专辑列表

GetActivityCustomEmojiSetDetail

获取自定义表情专辑详情

ModifyActivityCustomEmojiSets

更新自定义表情专辑排序

DeleteActivityCustomEmojiSet

删除自定义表情专辑

CreateOrUpdateActivityCustomEmojiSet

新增或更新自定义表情专辑

UpdateActivityCustomEmojiSetStatus

更新自定义表情专辑的启用状态

观看限制

API

说明

GetViewingRestrictionInfo

获取观看限制配置信息

UpdateViewingRestriction

更新观看限制配置信息

InsertWhiteList

新增白名单观看限制中的白名单

GetWhiteList

获取白名单观看限制中的白名单列表

DeleteWhiteList

删除白名单观看限制中的白名单

InsertPhoneList

新增手机号观看限制中的白名单手机号

GetPhoneList

获取手机号观看限制中的白名单手机号列表

DeletePhoneList

删除手机号观看限制中的白名单手机号

认真度检测

API

说明

UpdateAttentionDetectionConfig

更新认真度检测配置信息

GetAttentionDetectionConfig

获取认真度检测配置信息

营销与互动

API

说明

UpdateFloatingAdvertisement

更新浮标广告配置信息

UpdateHostAccount

新增或更新主播账号信息

DeleteHostAccount

删除主播账号

UpdateActivityHostAccount

更新直播间关联主播账号设置

ListHostAccounts

获取主播账号列表

GetBusinessAccountInfo

获取直播间的关联主播账号信息

UpdateActivityQuizConfig

更新答题或简答配置信息

ListActivityQuizConfigs

获取答题或简答配置信息

UpdateAwardItem

新增或更新奖品库奖品

GetAwardItemList

获取奖品库奖品列表

DeleteAwardItem

删除奖品库奖品

CreateCoupons

新增卡券库卡券

UpdateCoupon

更新卡券库卡券信息

ListCoupons

获取卡券库卡券列表

DeleteCoupons

删除卡券库卡券

GetCoupon

查询卡券库卡券信息

CreateActivityCoupons

直播间内新增卡券互动工具

UpdateActivityCoupon

直播间内更新卡券互动工具信息

DeleteActivityCoupons

直播间内删除卡券互动工具

ListActivityCoupons

直播间内获取卡券互动工具列表

SendActivityCoupon

直播间内发送卡券互动工具

GetActivityCouponPickData

获取直播间内指定卡券领取信息

GetActivityAllCouponsPickData

获取直播间内所有卡券领取信息

StopActivityCoupon

直播间内停止发放卡券

直播助教

API

说明

GetTeachAssistantConfig

获取直播助教平台的页面设置

UpdateTeachAssistantConfig

更新直播助教平台的页面设置

ListTeachAssistantAccounts

获取直播助教账号信息列表

UpdateTeachAssistantAccount

新增或更新直播助教账号信息

DeleteTeachAssistantAccount

删除直播助教账号

安全与审核

API

说明

UpdateSecurityControlConfig

更新直播间安全管控配置信息

GetSecurityControlConfig

获取直播间安全管控配置信息

UpdateAccountBanStatus

账号维度封禁或解禁观众

媒资库管理

API

说明

GetVideoLibraryFolderTree

获取视频库分类信息(包含子分类)

SearchVideoLibraryFolderTree

获取视频库分类信息(不包含子分类)

MediaCut

剪辑视频

开播工具相关

API

说明

GetActivityLinks

获取直播间链接信息

GetDownloadLiveClient

获取直播伴侣一键开播跳转地址

签名相关

API

说明

GetLoginLivesaasSts

新增获取企业直播 STS 签名接口

点播播放器

API

说明

UpdateVodPlayerConfig

新增或更新点播播放器信息

DeleteVodPlayerConfig

删除点播播放器

UpdateDefaultVodPlayerConfig

设置默认点播播放器

ListVodPlayerConfig

获取点播播放器配置信息

GetVodPlayerConfig

获取点播播放器列表

GetVodPlayerToken

获取点播播放器 Token

直播分组

API

说明

GetAudienceGroupConfig

获取直播分组配置信息

UpdateAudienceGroupConfig

更新直播分组配置信息

ListAudienceGroupUser

获取直播分组的观众信息列表

UpdateAudienceGroupUserConfig

更新观众的直播分组

AddAudienceGroup

新增直播分组

ModifyAudienceGroup

更新直播分组

DeleteAudienceGroup

删除直播分组

视频轮播

API

说明

UpdateLoopVideos

更新视频轮播配置信息

UpdateLoopVideoStatus

更新视频轮播的开启状态

ListLoopVideos

获取视频轮播配置信息

ListPrograms

获取节目单列表

UpdateProgram

新增或更新节目单配置信息

DeleteProgram

删除节目单

伴侣转播

API

说明

AddActivityPartnerRebroadcast

添加伴侣转播直播间

DeleteActivityPartnerRebroadcast

删除伴侣转播直播间

GetActivityPartnerRebroadcast

获取伴侣转播直播间信息

直播频道管理

API

说明

CreateLiveChannelConfig

新增直播频道

DeleteLiveChannelConfig

删除直播频道

UpdateLiveChannelConfig

更新直播频道

ListLiveChannelConfig

获取直播频道信息列表

子账号

API

说明

GetLarkSubAccountInfo

获取飞书子账号信息

2020-06-01

直播间管理

API

说明

ListActivityAPI

获取直播间列表信息

ListActivityByCacheAPI

获取直播间列表信息(非实时)

CreateActivityAPIV2

创建直播间

DeleteActivityAPI

删除直播间

GetActivityAPI

获取直播间基础信息

GetActivityBasicConfigAPI

获取直播间基础配置信息

UpdateActivityBasicConfigAPI

更新直播间基础配置信息

GetCustomActMsgAPI

自定义查询直播间信息

GetStreamsAPI

获取推流直播和拉流直播信息

UpdatePullToPushAPI

更新直播间拉流配置

UpdateActivityStatusAPI

更新直播间状态

UpdateLoopVideoAPI

编辑轮播

UpdateLoopVideoStatusAPI

开启/关闭轮播

GetAccountTemplateAPI

获取直播模板列表

UpdateAccountTemplateStatusAPI

更新直播模板状态

UpdateDefaultTemplateStatusAPI

更新默认直播模板

UpdatePopularitySettingsAPI

更新直播间互动人气设置

GetPopularitySettingsAPI

获取直播间互动人气设置

回放管理

API

说明

UploadReplayAPI

关联媒资库视频文件和直播间

ListMediasAPI

获取回放文件列表

UpdateMediaOnlineStatusAPI

上架/下架/解绑回放

MediasMergeAPI

合并回放文件

数据查询

API

说明

GetAdvertisementDataAPIV2

获取营销数据信息

GetPageWatchDataAPIV2

获取直播间基础数据

ListUserBehaviorDataAPIV2

获取观众行为数据信息

ListQuestionnaireAnswerDataAPIV2

获取问卷数据信息

ListQuestionnaireDataAPIV2

获取直播间问卷列表

ListAnActivityStartAndEndTimeAPI

获取直播间的开播关播时间

GetRealTimeOnlineNumberAPI

获取实时在线人数

AnalysisUserBehaviorPeopleV2

获取直播间不同观看时长的人数

GetVoteListAPI

获取直播间投票列表信息

GetVoteStatisticsAPI

获取直播间投票数据

GetActivityReservationAPIV2

获取直播预约信息

GetAwardConfigListAPI

获取直播间实时抽奖配置信息

GetAwardRecordStatisticsAPI

获取直播间实时抽奖参与或中奖名单

GetTaskAwardItemListAPI

获取直播间累计观看抽奖奖品列表

GetTaskAwardRecordStatisticsAPI

获取直播间累计观看抽奖参与或中奖名单

ListPosterInviteAPI

获取邀请榜单数据

ListRedPacketDataAPI

获取直播间红包列表

ListRedPacketRecordAPI

获取直播间红包参与或中奖名单

GetCheckInListAPI

获取直播间签到列表

GetCheckInRecordStatisticsAPI

获取直播间签到名单

ListQuizStatisticsAPI

获取直播间答题或简答列表

ListQuizRecordAPI

获取直播间答题或简答参与名单

GetQuizDataAPI

获取直播间答题或简答详情

评论设置

API

说明

PresenterChatAPIV2

主持人发言

PollingChatAPI

获取直播间评论

GetHotChatAPI

获取直播间热门评论

GetTopChatAPI

获取直播间置顶评论

DeleteChatAPI

删除直播间评论

LikeChatAPI

评论点赞

TopChatAPI

评论置顶

EmptyChatAPI

清空直播间评论

UpdateChatReviewStatusAPI

更改直播间评论先审后发状态

ConfirmReviewChatAPI

评论过审

SilenceUserAPI

用户禁言

GetSilenceUserListAPI

获取禁言用户列表

菜单栏控制

API

说明

GetActivityMenuAPI

获取菜单栏列表

UpdateActivityMenuAPI

更新菜单栏列表

GetActivityProductAPI

获取商品卡片配置

UpdateActivityProductAPI

更新商品卡片配置

UpdatePresenterNameAPI

修改主持人名称

UpdateBulletScreensSwitchAPI

修改弹幕开关

EnableProductAPI

修改卡片上下架状态

ExplainProductAPI

修改卡片浮窗展示状态

UpdateActivityEmbeddedUrlAPI

更新内嵌链接配置信息

GetActivityEmbeddedUrlAPI

获取内嵌链接配置信息

观看限制

API

说明

GetCustomViewingRestrictionInfoAPI

获取直播间自定义观看限制的配置信息

UpdateActivityViewPermissionAPI

更新直播间观看账号配置信息

营销与互动

API

说明

ListLivePromotionsAPI

获取直播转推的平台列表

AddLivePromotionsAPI

批量添加直播转推自定义平台

UpdateLivePromotionsStatusAPI

更新直播转推自定义平台

DeleteLivePromotionsAPI

删除直播转推的自定义平台

ListHostAccountAPI

获取主播账号列表

GetBusinessAccountInfoAPI

获取直播间的主播/品牌方信息

ListChannelAPI

获取直播间的渠道列表

媒资库管理

API

说明

UploadMediaByURL

批量上传视频至媒资库

QueryUploadMediaByURL

获取批量上传视频的结果

TempToMediaActivityMediaAPI

直播暂存转存视频库

ListActivityMediaAPI

获取媒资库视频信息

DeleteMediaLibraryVideoAPI

批量删除媒资库视频

直播报名配置

API

说明

ListUserSubmitEnterReviewAPI

获取用户填写的报名信息

ReviewUserEnterFormAPI

审核报名表单

敏感词管理

API

说明

GetActivityAntidirtAPI

查询敏感词

AddActivityAntidirtAPI

添加敏感词

DelActivityAntidirtAPI

删除敏感词

系统消息

API

说明

SendCustomSystemMessageAPI

发送自定义系统消息

开播工具相关

API

说明

GetDownloadLiveClientAPI

获取直播伴侣一键开播跳转地址

GetWebPushLiveClientAPI

获取网页直播一键开播跳转地址

GetTemporaryLoginTokenAPI

获取临时登录密钥

账号配置

API

说明

ListSiteTagAPIV2

获取直播间标签列表

UpdateSiteTagAPIV2

更新直播间标签信息

客户端 SDK 相关

API

说明

GetSDKTokenAPI

获取观众进入直播间的授权 Token