文档中心
简体
文档
备案
控制台
登录
立即注册
企业直播
文档指南
API 参考
aPaaS SDK 参考
企业直播
企业直播
API 参考
请输入
API 发布历史
使用前必读
API 概览
调用方法
使用 HTTP 请求调用
使用 SDK 调用（推荐）
错误码
名词解释
直播间管理
ListActivityAPI - 获取直播间列表信息
ListActivityByCacheAPI - 获取直播间列表信息（非实时）
CreateActivityAPIV2 - 创建直播间
DeleteActivityAPI - 删除直播间
GetCustomActMsgAPI - 自定义查询直播间信息
ListAnActivityStartAndEndTimeAPI - 获取直播间的开播关播时间
直播间基础配置管理
GetActivityAPI - 获取直播间基础信息
GetActivityBasicConfigAPI - 获取直播间基础配置信息
UpdateActivityBasicConfigAPI - 更新直播间基础配置信息
直播间状态和直播频道配置
UpdateActivityStatusAPI - 更新直播间状态
CreateLiveChannelConfig - 新增直播频道
DeleteLiveChannelConfig - 删除直播频道
UpdateLiveChannelConfig - 更新直播频道
ListLiveChannelConfig - 获取直播频道信息列表
GetStreamsAPI - 获取推流直播和拉流直播信息
UpdatePullToPushAPI - 更新直播间拉流状态
直播间回放管理
GenerateActivityStreamSlice - 生成直播流切片
UpdateAnswerRepetition - 开启或关闭答题重现功能
GetActivityReplayPlayerConfig - 获取直播间回放播放器设置
UpdateActivityReplayPlayerConfig - 更新直播间回放播放器设置
UpdateMediaOnlineStatusAPI - 上架/下架/解绑回放视频
MediasMergeAPI - 合并回放视频
直播间维度数据统计
GetAdvertisementDataDetailAPI - 获取直播间营销推广点击数据
ListAwardRecordStatistics - 获取直播间实时抽奖参与或中奖名单
GetTaskAwardRecordStatisticsAPI - 获取直播间累计观看抽奖参与或中奖名单
GetActivityCouponPickData - 获取直播间内指定卡券领取信息
GetActivityAllCouponsPickData - 获取直播间内所有卡券领取信息
GetLinkUserAmount - 获取实时连麦人数
ListWaitLinkAudience - 获取申请连麦观众列表
ExportActivityData - 导出直播间数据
GetActivityExportFile - 获取直播间导出数据文件
GetAdvertisementDataAPIV2 - 获取直播间营销数据信息
GetPageWatchDataAPIV2 - 获取直播间基础数据
ListUserBehaviorDataAPIV2 - 获取观众行为数据信息
ListQuestionnaireAnswerDataAPIV2 - 获取直播间问卷数据信息
GetRealTimeOnlineNumberAPI - 获取直播间在线人数
AnalysisUserBehaviorPeopleV2 - 获取直播间不同观看时长的人数
GetVoteStatisticsAPI - 获取直播间投票数据
GetActivityReservationAPIV2 - 获取直播预约信息
ListPosterInviteAPI - 获取邀请榜单数据
ListRedPacketRecordAPI - 获取直播间内红包的参与名单或中奖名单
GetCheckInRecordStatisticsAPI - 获取直播间签到名单
ListQuizRecordAPI - 获取直播间答题或简答参与名单
GetActivityThumbUpNumber - 获取直播间点赞数值
直播间评论
PresenterChatAPIV2 - 主持人发言
PollingChatAPI - 获取直播间评论
GetHotChatAPI - 获取直播间热门评论
GetTopChatAPI - 获取直播间置顶评论
DeleteChatAPI - 删除直播间评论
LikeChatAPI - 评论点赞
TopChatAPI - 评论置顶
EmptyChatAPI - 清空直播间评论
UpdateChatReviewStatusAPI - 更改直播间评论先审后发状态
ConfirmReviewChatAPI - 评论过审
SilenceUserAPI - 用户禁言
GetSilenceUserListAPI - 获取禁言用户列表
菜单管理
GetActivityMenus - 获取菜单列表
ModifyActivityMenus - 更新菜单排序和名称及启用状态
GetActivityProducts - 获取商品卡片菜单的配置信息
UpdateActivityProduct - 新增或更新商品卡片菜单配置信息
UpdateSingleActivityProduct - 新增、更新或删除单个商品卡片
DeleteActivityProduct - 删除商品卡片菜单
ExplainProduct - 更新商品卡片的讲解状态或浮窗展示状态
UpdateProductReminderInfo - 更新商品的热卖或库存提醒
EnableActivityMultiProductExplain - 开启或关闭多商品讲解功能
GetActivityEmbeddedUrls - 获取内嵌链接菜单的配置信息
UpdateActivityEmbeddedUrl - 新增或更新内嵌链接菜单配置信息
DeleteActivityEmbeddedUrl - 删除内嵌链接菜单
GetActivityBands - 获取图文介绍菜单的配置信息
UpdateActivityBand - 新增或更新图文介绍菜单配置信息
DeleteActivityBand - 删除图文介绍菜单
GetActivityCommentConfig - 获取聊天互动菜单基础配置信息
UpdateActivityCommentConfig - 更新聊天互动菜单基础配置信息
ListActivityCustomEmojiSets - 获取自定义表情专辑列表
GetActivityCustomEmojiSetDetail - 获取自定义表情专辑详情
ModifyActivityCustomEmojiSets - 更新自定义表情专辑排序
DeleteActivityCustomEmojiSet - 删除自定义表情专辑
CreateOrUpdateActivityCustomEmojiSet - 新增或更新自定义表情专辑
UpdateActivityCustomEmojiSetStatus - 更新自定义表情专辑的启用状态
UpdateProductOutOfStock - 更新商品卡片的售罄状态
HideProductPrice - 更新商品卡片价格的隐藏状态
认真度检测
UpdateAttentionDetectionConfig - 更新认真度检测配置信息
GetAttentionDetectionConfig - 获取认真度检测配置信息
观看限制
GetViewingRestrictionInfo - 获取观看限制配置信息
UpdateViewingRestriction - 更新观看限制配置信息
InsertWhiteList - 新增白名单观看限制中的白名单
GetWhiteList - 获取白名单观看限制中的白名单列表
DeleteWhiteList - 删除白名单观看限制中的白名单
InsertPhoneList - 新增手机号观看限制中的白名单手机号
GetPhoneList - 获取手机号观看限制中的白名单手机号列表
DeletePhoneList - 删除手机号观看限制中的白名单手机号
渠道推广
ListChannelAPI - 获取直播间的渠道列表
营销广告
UpdateFloatingAdvertisement - 更新浮标广告配置信息
UpdateHostAccount - 新增或更新主播账号信息
DeleteHostAccount - 删除主播账号
UpdateActivityHostAccount - 更新直播间关联主播账号设置
ListHostAccounts - 获取主播账号列表
GetBusinessAccountInfo - 获取直播间的关联主播账号信息
UpdateInPageAdvertisement - 新增、更新或删除页中广告
GetInPageAdvertisement - 获取页中广告配置信息
互动工具
UpdateActivityQuizConfig - 更新答题或简答配置信息
ListActivityQuizConfigs - 获取答题或简答配置信息
ListQuizStatisticsAPI - 获取直播间答题或简答列表
GetQuizDataAPI - 获取直播间答题或简答详情
GetAwardItemList - 获取奖品库奖品列表
UpdateAwardItem - 新增或更新奖品库奖品
DeleteAwardItem - 删除奖品库奖品
UpdateAwardConfig - 新增、更新或删除实时抽奖
SendAward - 直播间内发送实时抽奖
WithdrawAward - 直播间内撤回实时抽奖
ListAwardConfigs - 获取直播间实时抽奖配置信息
GetTaskAwardItemListAPI - 获取直播间累计观看抽奖奖品列表
CreateCoupons - 新增卡券库卡券
UpdateCoupon - 更新卡券库卡券信息
ListCoupons - 获取卡券库卡券列表
DeleteCoupons - 删除卡券库卡券
GetCoupon - 查询卡券库卡券信息
CreateActivityCoupons - 直播间内新增卡券互动工具
UpdateActivityCoupon - 直播间内更新卡券互动工具信息
DeleteActivityCoupons - 直播间内删除卡券互动工具
ListActivityCoupons - 直播间内获取卡券互动工具列表
SendActivityCoupon - 直播间内发送卡券互动工具
StopActivityCoupon - 直播间内停止发放卡券
ResendActivityCoupon - 直播间内重新发放卡券
CreateActivityRedPacket - 直播间内新增红包
UpdateActivityRedPacket - 直播间内更新红包配置信息
DeleteActivityRedPacket - 直播间内删除红包
GetActivityRedPacket - 获取直播间内指定红包配置信息
ListActivityRedPacket - 获取直播间内红包列表
ListRedPacketDataAPI - 获取直播间红包数据
CreateVipOrBlackListUserInfo - 新增优先中奖名单或中奖黑名单用户信息
GetVipOrBlackListUserInfo - 获取优先中奖名单或中奖黑名单用户信息
DeleteVipOrBlackListUserInfo - 删除优先中奖名单或中奖黑名单用户信息
ListQuestionnaireDataAPIV2 - 获取直播间问卷列表
GetVoteListAPI - 获取直播间投票配置信息
GetCheckInListAPI - 获取直播间签到列表
直播分享
UpdateActivityPoster - 更新直播分享配置信息
GetActivityPoster - 获取直播分享配置信息
GetInviterToken - 获取分享人的专属 Token
直播报名
ListUserSubmitEnterReviewAPI - 获取用户填写的报名信息
ReviewUserEnterFormAPI - 审核报名表单
直播敏感词
GetActivityAntidirtAPI - 查询敏感词
AddActivityAntidirtAPI - 添加敏感词
DelActivityAntidirtAPI - 删除敏感词
助播管理
GetTeachAssistantConfig - 获取助播平台的页面设置
UpdateTeachAssistantConfig - 更新助播平台的页面设置
ListTeachAssistantAccounts - 获取助播账号信息列表
UpdateTeachAssistantAccount - 新增或更新助播账号信息
DeleteTeachAssistantAccount - 删除助播账号
安全管控
GetSecurityControlConfig - 获取直播间安全管控配置信息
UpdateSecurityControlConfig - 更新直播间安全管控配置信息
踢出与封禁
UpdateAccountBanStatus - 账号维度封禁或解禁观众
UpdateActivityUserBanStatus - 直播间维度封禁、踢出或解除封禁观众或设备
GetActivityBanUsers - 获取直播间被封禁的观众和设备列表
系统消息
SendProductOrderMessage - 发送商品下单购买消息
SendCustomSystemMessageAPI - 发送自定义系统消息
GetActivityMessageConfig - 获取直播间系统消息设置
UpdateActivityMessageConfig - 更新直播间系统消息设置
开播工具相关
GetActivityLinks - 获取直播间链接信息
GetDownloadLiveClient - 获取直播伴侣一键开播地址或嘉宾连麦登录地址
GetWebPushLiveClientAPI - 获取网页直播一键开播地址
GetTemporaryLoginTokenAPI - 获取开播密钥
直播间标签
ListSiteTagAPIV2 - 获取直播间标签列表
UpdateSiteTagAPIV2 - 更新直播间标签信息
客户端 SDK 相关
GetSDKTokenAPI - 获取观众进入直播间的授权 Token
GetActivityLoginSecret - 获取直播间登录秘钥
直播分组
GetAudienceGroupConfig - 获取直播分组配置信息
UpdateAudienceGroupConfig - 更新直播分组配置信息
ListAudienceGroupUser - 获取直播分组的观众信息列表
UpdateAudienceGroupUserConfig - 更新观众的直播分组
AddAudienceGroup - 新增直播分组
ModifyAudienceGroup - 更新直播分组
DeleteAudienceGroup - 删除直播分组
录播直播
ListLoopVideos - 获取录播直播配置信息
UpdateLoopVideos - 更新录播直播配置信息
UpdateLoopVideoStatus - 更新录播直播开启状态
ListPrograms - 获取节目单列表
UpdateProgram - 新增或更新节目单配置信息
DeleteProgram - 删除节目单
伴侣转播
AddActivityPartnerRebroadcast - 添加伴侣转播直播间
DeleteActivityPartnerRebroadcast - 删除伴侣转播直播间
GetActivityPartnerRebroadcast - 获取伴侣转播直播间信息
签名相关
GetLoginLivesaasSts - 获取企业直播 STS 签名
点播播放器
UpdateVodPlayerConfig - 新增或更新点播播放器信息
DeleteVodPlayerConfig - 删除点播播放器
UpdateDefaultVodPlayerConfig - 设置默认点播播放器
GetVodPlayerConfig - 获取点播播放器配置信息
ListVodPlayerConfig - 获取点播播放器列表
GetVodPlayerToken - 获取点播播放器 Token
子账号
GetLarkSubAccountInfo - 获取飞书子账号信息
CreateSubAccount - 创建子账号
UpdateSubAccount - 更新子账号信息
DeleteSubAccount - 删除子账号
ListSubAccounts - 获取子账号列表
GetSubAccount - 查询子账号
ListSubAccountRoles - 获取子账号角色列表
ListSubAccountOrganizations - 获取子账号组织列表
直播模板
GetAccountTemplateAPI - 获取直播模板列表
UpdateAccountTemplateStatusAPI - 更新直播模版状态
UpdateDefaultTemplateStatusAPI - 更新默认直播模版
观众等级
GetViewerLevelConfig - 获取观众等级配置
CreateViewerLevelConfig - 新增观众等级配置
UpdateViewerLevelConfig - 更新观众等级配置
ReorderViewerLevelConfig - 调整观众等级配置次序
DeleteViewerLevelConfig - 删除观众等级配置
UpdateViewerLevelGroupConfig - 新增或更新观众等级库
ListAccountViewerLevelGroup - 获取观众等级库列表
DeleteViewerLevelGroup - 删除观众等级库
账号维度数据统计
GetAccountAggregatedStatistics - 获取账号维度的核心统计数据
ListAccountActivityData - 获取账号维度的直播间统计数据
ListAccountUserData - 获取账号维度的用户画像数据
GetAccountUserTrackData - 获取观众的用户画像详情
GetLiveTrafficPostPayData - 获取直播流量使用信息
GetLiveLinkDurationData - 获取连麦时长使用信息
GetAccountRealTimeOnlineNumber - 获取账号维度实时在线人数
媒资库
GetVideoLibraryFolderTree - 获取视频库分类信息（包含子分类）
SearchVideoLibraryFolderTree - 获取视频库分类信息（不包含子分类）
MediaCut - 剪辑视频
UpdateActivityMediaInfo - 更新媒资库视频信息
ListActivityMediaAPI - 获取媒资库视频信息
TempToMediaActivityMediaAPI - 直播暂存转存视频库
UploadMediaByURL - 批量上传视频至视频库
QueryUploadMediaByURL - 获取批量上传视频的结果
DeleteMediaLibraryVideoAPI - 批量删除媒资库视频
开发集成
ListCallbackEvents - 获取回调消息类型
AddCallbackConfig - 新增回调配置信息
UpdateCallbackConfig - 更新回调配置信息
ListCallbackConfigs - 获取回调配置信息
DeleteCallbackConfig - 删除回调配置信息
AddWebSDKDomain - 新增 Web SDK 域名配置
ListWebSDKDomainConfigs - 获取 Web SDK 域名配置列表
DeleteWebSDKDomain - 删除 Web SDK 域名配置
直播消息回调
直播状态变化回调
直播间创建或删除回调
直播间基础配置变化回调
直播预约结果回调
实时抽奖结果回调
评论发送回调
累计观看抽奖结果批量聚合回调
直播回放生成回调
红包结果回调
合并回放视频结果回调
剪辑视频结果回调
直播预约点击回调
观众状态变化回调
卡券领取批量聚合回调
飞书客户端内企业直播子账号申请回调
直播间数据导出回调
聊天 AI 分析结果回调
切片录制视频生成回调
商品卡片配置变化回调
参与实时抽奖回调
批量上传视频至视频库结果回调
媒资库视频转码完成回调
签到状态变化回调
签到参与回调
自有账号系统积分接口
关注主播接口
历史 API
查询观众奖券奖品的中奖情况
获取直播预约信息
获取问卷列表信息
获取问卷数据信息
获取直播间不同观看时长的人数
获取营销数据信息
获取观众行为数据信息
获取直播间基础数据
主持人发言
获取菜单栏列表
获取商品卡片配置
更新商品卡片配置
获取直播间实时抽奖配置信息
获取直播伴侣一键开播地址
获取直播间的主播/品牌方信息
获取主播账号列表
获取直播间自定义观看限制的配置信息
更新直播间观看账号配置信息
修改主持人名称
修改弹幕开关
更新内嵌链接配置信息
获取内嵌链接配置信息
修改卡片浮窗展示状态
修改卡片上下架状态
获取直播间实时抽奖参与或中奖名单
GetActivityBanIps - 获取直播间被封禁的 IP 列表
UpdateActivityIpBanStatus - 直播间维度封禁或解禁 IP 地址
文档首页
企业直播
开播工具相关
企业直播
开播工具相关
GetActivityLinks - 获取直播间链接信息
GetDownloadLiveClient - 获取直播伴侣一键开播地址或嘉宾连麦登录地址
GetWebPushLiveClientAPI - 获取网页直播一键开播地址
GetTemporaryLoginTokenAPI - 获取开播密钥
