文档中心
文档
备案
控制台
登录
立即注册
导航
企业直播
搜索目录或文档标题
搜索目录或文档标题
产品动态
新功能发布历史
2025 年
2024 年
2023 年
2022 年
2021 年
产品公告
关于停止售卖定制版的公告
企业直播版本功能调整公告
产品简介
产品简介
案例介绍
SaaS 与 aPaaS 功能差异
飞书内直播功能简介
基本概念
产品计费
计费说明
购买说明
查看用量与账单
快速入门
开通企业直播服务
快速开播
下载中心
飞书直播
飞书内开通企业直播
飞书开播
飞书观看限制
直播伴侣
开播环境要求
安装与登录
开播设置
创建直播间
超低延时直播（直播伴侣）
开播页面
三分屏直播
添加直播素材
管理场景
直播设置
直播检测
分享直播
锁定预告（直播伴侣）
直播素材设置
直播素材基础设置
全屏
摄像头
白板（直播伴侣）
云端文档（直播伴侣）
图片
音视频
文字
窗口
截图
NDI
采集
转播
开播与录制
抢占推流
互动玩法
聊天互动（直播伴侣）
Echo 回声智能 AI 助手（直播伴侣）
私聊互动（直播伴侣）
公告（直播伴侣）
文档（直播伴侣）
问卷（直播伴侣）
签到（直播伴侣）
答题（直播伴侣）
简答（直播伴侣）
卡券（直播伴侣）
卡券库（直播伴侣）
实时抽奖（直播伴侣）
奖品库（直播伴侣）
观众列表（直播伴侣）
表扬点赞（直播伴侣）
嘉宾连麦（直播伴侣）
观众连麦（直播伴侣）
直播伴侣最佳实践
直播伴侣连接外部设备开播
直播伴侣直播画布设置
开播方式
手机开播
网页直播
直播伴侣
拉流直播
录播直播
云导播
推流直播
自动开播
自动关播
超低延时直播
开播实践
云端文档（网页直播）
嘉宾连麦（网页直播）
观众连麦（网页直播）
观众列表
白板（网页直播）
直播间定制
直播间装修
装修物料准备规范
播放器能力
复制直播间
直播间嵌入
直播间标签
竖屏直播间
横屏直播间
观看页多语言
菜单管理
聊天互动
互动工具
图文介绍
商品卡片
私聊互动
聚合直播
互动问答
内嵌链接
营销与互动
同步直播到第三方平台
直播分享
直播预约
直播倒计时
预告视频
广告位设置
直播引导页
直播建站
关联主播账号
短信定制
直播报名
自定义系统消息
人气值
渠道推广
实时抽奖
累计观看抽奖
奖品库
卡券奖品
积分奖品
奖券奖品
卡券
卡券库
问卷
投票
签到
红包
礼物打赏
答题
简答
公告
直播助教
直播间点赞
直播频道管理
直播字幕
动态表情包
直播时移
自定义登录页背景
认真度检测
Echo 回声智能 AI 助手
直播分组
表扬点赞
一键复制直播间链接
伴侣转播
直播间文档管理
聊天 AI 分析
聊天脚本
商品脚本
观众头像
安全与审核
安全管控
防录屏
全体禁言
锁定预告
聊天欢迎语
风险提示
聊天审核
直播敏感词
直播审核
踢出与封禁
跑马灯
观看限制
概览
主次观看限制
密码
邀请码
自定义登录
微信
企业微信
手机号
白名单
OAuth 2.0
飞书
试看
点播与剪辑
点播播放
倍速播放
标记打点
云剪辑
直播剪辑
智能字幕（点播字幕）
答题重现
媒资库
视频库
视频管理工具
直播暂存
文档管理（文档库）
点播播放器
数据分析
数据统计
数据中心
数据大屏
分渠道数据统计
全局配置
直播模板
权限管理
品牌定制
控制台品牌定制
登录页品牌定制
直播伴侣品牌定制
消息中心
API 参考
API 发布历史
使用前必读
API 概览
调用方法
使用 HTTP 请求调用
使用 SDK 调用（推荐）
错误码
名词解释
直播间管理
ListActivityAPI - 获取直播间列表信息
ListActivityByCacheAPI - 获取直播间列表信息（非实时）
CreateActivityAPIV2 - 创建直播间
DeleteActivityAPI - 删除直播间
GetCustomActMsgAPI - 自定义查询直播间信息
ListAnActivityStartAndEndTimeAPI - 获取直播间的开播关播时间
直播间基础配置管理
GetActivityAPI - 获取直播间基础信息
GetActivityBasicConfigAPI - 获取直播间基础配置信息
UpdateActivityBasicConfigAPI - 更新直播间基础配置信息
直播间状态和直播频道配置
UpdateActivityStatusAPI - 更新直播间状态
CreateLiveChannelConfig - 新增直播频道
DeleteLiveChannelConfig - 删除直播频道
UpdateLiveChannelConfig - 更新直播频道
ListLiveChannelConfig - 获取直播频道信息列表
GetStreamsAPI - 获取推流直播和拉流直播信息
UpdatePullToPushAPI - 更新直播间拉流状态
直播间人气管理
UpdatePopularitySettingsAPI - 更新直播间互动人气设置
GetPopularitySettingsAPI - 获取直播间互动人气设置
直播间回放管理
GenerateActivityStreamSlice - 生成直播流切片
UpdateAnswerRepetition - 开启或关闭答题重现功能
GetActivityReplayPlayerConfig - 获取直播间回放播放器设置
UpdateActivityReplayPlayerConfig - 更新直播间回放播放器设置
UploadReplayAPI - 关联媒资库视频文件和直播间
ListMediasAPI - 获取回放视频列表
UpdateMediaOnlineStatusAPI - 上架/下架/解绑回放视频
MediasMergeAPI - 合并回放视频
直播间维度数据统计
GetAdvertisementDataDetailAPI - 获取直播间营销推广点击数据
GetActivityLivePromotionData - 获取直播间直播转推数据
GetActivityLivePromotionDetail - 获取直播间直播转推详情
ListAwardRecordStatistics - 获取直播间实时抽奖参与或中奖名单
GetTaskAwardRecordStatisticsAPI - 获取直播间累计观看抽奖参与或中奖名单
GetActivityCouponPickData - 获取直播间内指定卡券领取信息
GetActivityAllCouponsPickData - 获取直播间内所有卡券领取信息
ListActivityUsers - 获取实时观众列表
GetLinkUserAmount - 获取实时连麦人数
ListWaitLinkAudience - 获取申请连麦观众列表
ExportActivityData - 导出直播间数据
GetActivityExportFile - 获取直播间导出数据文件
GetAdvertisementDataAPIV2 - 获取直播间营销数据信息
GetPageWatchDataAPIV2 - 获取直播间基础数据
ListUserBehaviorDataAPIV2 - 获取观众行为数据信息
ListQuestionnaireAnswerDataAPIV2 - 获取直播间问卷数据信息
GetRealTimeOnlineNumberAPI - 获取直播间在线人数
AnalysisUserBehaviorPeopleV2 - 获取直播间不同观看时长的人数
GetVoteStatisticsAPI - 获取直播间投票数据
GetActivityReservationAPIV2 - 获取直播预约信息
ListPosterInviteAPI - 获取邀请榜单数据
ListRedPacketRecordAPI - 获取直播间内红包的参与名单或中奖名单
GetCheckInRecordStatisticsAPI - 获取直播间签到名单
ListQuizRecordAPI - 获取直播间答题或简答参与名单
直播间评论
PresenterChatAPIV2 - 主持人发言
PollingChatAPI - 获取直播间评论
GetHotChatAPI - 获取直播间热门评论
GetTopChatAPI - 获取直播间置顶评论
DeleteChatAPI - 删除直播间评论
LikeChatAPI - 评论点赞
TopChatAPI - 评论置顶
EmptyChatAPI - 清空直播间评论
UpdateChatReviewStatusAPI - 更改直播间评论先审后发状态
ConfirmReviewChatAPI - 评论过审
SilenceUserAPI - 用户禁言
GetSilenceUserListAPI - 获取禁言用户列表
菜单管理
GetActivityMenus - 获取菜单列表
ModifyActivityMenus - 更新菜单排序和名称及启用状态
GetActivityProducts - 获取商品卡片菜单的配置信息
UpdateActivityProduct - 新增或更新商品卡片菜单配置信息
DeleteActivityProduct - 删除商品卡片菜单
ExplainProduct - 更新商品卡片浮窗展示状态
UpdateProductReminderInfo - 更新商品的热卖或库存提醒
GetActivityEmbeddedUrls - 获取内嵌链接菜单的配置信息
UpdateActivityEmbeddedUrl - 新增或更新内嵌链接菜单配置信息
DeleteActivityEmbeddedUrl - 删除内嵌链接菜单
GetActivityBands - 获取图文介绍菜单的配置信息
UpdateActivityBand - 新增或更新图文介绍菜单配置信息
DeleteActivityBand - 删除图文介绍菜单
GetActivityCommentConfig - 获取聊天互动菜单基础配置信息
UpdateActivityCommentConfig - 更新聊天互动菜单基础配置信息
ListActivityCustomEmojiSets - 获取自定义表情专辑列表
GetActivityCustomEmojiSetDetail - 获取自定义表情专辑详情
ModifyActivityCustomEmojiSets - 更新自定义表情专辑排序
DeleteActivityCustomEmojiSet - 删除自定义表情专辑
CreateOrUpdateActivityCustomEmojiSet - 新增或更新自定义表情专辑
UpdateActivityCustomEmojiSetStatus - 更新自定义表情专辑的启用状态
认真度检测
UpdateAttentionDetectionConfig - 更新认真度检测配置信息
GetAttentionDetectionConfig - 获取认真度检测配置信息
观看限制
GetViewingRestrictionInfo - 获取观看限制配置信息
UpdateViewingRestriction - 更新观看限制配置信息
InsertWhiteList - 新增白名单观看限制中的白名单
GetWhiteList - 获取白名单观看限制中的白名单列表
DeleteWhiteList - 删除白名单观看限制中的白名单
InsertPhoneList - 新增手机号观看限制中的白名单手机号
GetPhoneList - 获取手机号观看限制中的白名单手机号列表
DeletePhoneList - 删除手机号观看限制中的白名单手机号
渠道推广
ListChannelAPI - 获取直播间的渠道列表
直播转推
ListLivePromotionsAPI - 获取直播转推的平台列表
AddLivePromotionsAPI - 批量添加直播转推自定义平台
UpdateLivePromotionsStatusAPI - 更新直播转推自定义平台
DeleteLivePromotionsAPI - 删除直播转推的自定义平台
营销广告
UpdateFloatingAdvertisement - 更新浮标广告配置信息
UpdateHostAccount - 新增或更新主播账号信息
DeleteHostAccount - 删除主播账号
UpdateActivityHostAccount - 更新直播间关联主播账号设置
ListHostAccounts - 获取主播账号列表
GetBusinessAccountInfo - 获取直播间的关联主播账号信息
互动工具
UpdateActivityQuizConfig - 更新答题或简答配置信息
ListActivityQuizConfigs - 获取答题或简答配置信息
ListQuizStatisticsAPI - 获取直播间答题或简答列表
GetQuizDataAPI - 获取直播间答题或简答详情
GetAwardItemList - 获取奖品库奖品列表
UpdateAwardItem - 新增或更新奖品库奖品
DeleteAwardItem - 删除奖品库奖品
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 - 获取直播间被踢出的观众和设备列表
UpdateActivityIpBanStatus - 直播间维度封禁或解禁 IP 地址
GetActivityBanIps - 获取直播间被封禁的 IP 列表
系统消息
SendProductOrderMessage - 发送商品下单购买消息
SendCustomSystemMessageAPI - 发送自定义系统消息
GetActivityMessageConfig - 获取直播间系统消息设置
UpdateActivityMessageConfig - 更新直播间系统消息设置
开播工具相关
GetActivityLinks - 获取直播间链接信息
GetDownloadLiveClient - 获取直播伴侣一键开播地址或嘉宾连麦登录地址
GetWebPushLiveClientAPI - 获取网页直播一键开播地址
GetTemporaryLoginTokenAPI - 获取开播密钥
直播间标签
ListSiteTagAPIV2 - 获取直播间标签列表
UpdateSiteTagAPIV2 - 更新直播间标签信息
客户端 SDK 相关
GetSDKTokenAPI - 获取观众进入直播间的授权 Token
直播分组
GetAudienceGroupConfig - 获取直播分组配置信息
UpdateAudienceGroupConfig - 更新直播分组配置信息
ListAudienceGroupUser - 获取直播分组的观众信息列表
UpdateAudienceGroupUserConfig - 更新观众的直播分组
AddAudienceGroup - 新增直播分组
ModifyAudienceGroup - 更新直播分组
DeleteAudienceGroup - 删除直播分组
录播直播
ListLoopVideos - 获取录播直播配置信息
UpdateLoopVideos - 更新录播直播配置信息
UpdateLoopVideoStatus - 更新录播直播开启状态
ListPrograms - 获取节目单列表
UpdateProgram - 新增或更新节目单配置信息
DeleteProgram - 删除节目单
互动脚本
CreateInteractionScript - 创建空白互动脚本
ListInteractionScriptComments - 获取互动脚本评论列表
AddInteractionScriptComments - 新增互动脚本评论
EditInteractionScriptComment - 更新互动脚本评论
DeleteInteractionScriptComment - 删除互动脚本评论
UpdateInteractionScriptRecordConfig - 更新直播间互动脚本录制配置
GetInteractionScriptRecordConfig - 获取直播间互动脚本录制配置
伴侣转播
AddActivityPartnerRebroadcast - 添加伴侣转播直播间
DeleteActivityPartnerRebroadcast - 删除伴侣转播直播间
GetActivityPartnerRebroadcast - 获取伴侣转播直播间信息
签名相关
GetLoginLivesaasSts - 获取企业直播 STS 签名
点播播放器
UpdateVodPlayerConfig - 新增或更新点播播放器信息
DeleteVodPlayerConfig - 删除点播播放器
UpdateDefaultVodPlayerConfig - 设置默认点播播放器
GetVodPlayerConfig - 获取点播播放器配置信息
ListVodPlayerConfig - 获取点播播放器列表
GetVodPlayerToken - 获取点播播放器 Token
子账号
GetLarkSubAccountInfo - 获取飞书子账号信息
CreateSubAccount - 创建子账号
UpdateSubAccount - 更新子账号信息
DeleteSubAccount - 删除子账号
ListSubAccounts - 获取子账号列表
GetSubAccount - 查询子账号
ListSubAccountRoles - 获取子账号角色列表
ListSubAccountOrganizations - 获取子账号组织列表
直播模板
GetAccountTemplateAPI - 获取直播模板列表
UpdateAccountTemplateStatusAPI - 更新直播模版状态
UpdateDefaultTemplateStatusAPI - 更新默认直播模版
账号维度数据统计
GetAccountAggregatedStatistics - 获取账号维度的核心统计数据
ListAccountActivityData - 获取账号维度的直播间实时统计数据
ListAccountUserData - 获取账号维度的用户画像数据
GetAccountUserTrackData - 获取观众的用户画像详情
GetLiveTrafficPostPayData - 获取直播流量使用信息
媒资库
GetVideoLibraryFolderTree - 获取视频库分类信息（包含子分类）
SearchVideoLibraryFolderTree - 获取视频库分类信息（不包含子分类）
MediaCut - 剪辑视频
UpdateActivityMediaInfo - 更新媒资库视频信息
ListActivityMediaAPI - 获取媒资库视频信息
TempToMediaActivityMediaAPI - 直播暂存转存视频库
UploadMediaByURL - 批量上传视频至视频库
QueryUploadMediaByURL - 获取批量上传视频的结果
DeleteMediaLibraryVideoAPI - 批量删除媒资库视频
直播消息回调
直播状态变化回调
直播间创建或删除回调
直播间基础配置变化回调
直播预约结果回调
实时抽奖结果回调
评论发送回调
累计观看抽奖结果回调
直播回放生成回调
红包结果回调
合并回放视频结果回调
剪辑视频结果回调
直播预约点击回调
观众状态变化回调
卡券领取回调
卡券领取批量聚合回调
飞书客户端内企业直播子账号申请回调
直播间数据导出回调
聊天 AI 分析结果回调
切片录制视频生成回调
自有账号系统积分接口
关注主播接口
历史 API
查询观众奖券奖品的中奖情况
获取直播预约信息
获取问卷列表信息
获取问卷数据信息
获取直播间不同观看时长的人数
获取营销数据信息
获取观众行为数据信息
获取直播间基础数据
主持人发言
编辑轮播
开启/关闭轮播
获取菜单栏列表
更新菜单栏列表
获取商品卡片配置
更新商品卡片配置
获取直播间实时抽奖配置信息
获取直播伴侣一键开播地址
获取直播间的主播/品牌方信息
获取主播账号列表
获取直播间自定义观看限制的配置信息
更新直播间观看账号配置信息
修改主持人名称
修改弹幕开关
更新内嵌链接配置信息
获取内嵌链接配置信息
修改卡片浮窗展示状态
修改卡片上下架状态
获取直播间实时抽奖参与或中奖名单
aPaaS SDK 参考
SDK 简介
SDK 概述
SDK 优势
应用场景
发布历史
Android 开播 SDK 发布历史
iOS 开播 SDK 发布历史
Android 观播 SDK 发布历史
iOS 观播 SDK 发布历史
Web 观播 SDK 发布历史
Flutter 直播间观播 SDK 发布历史
微信小程序观播 SDK 发布历史
Flutter 点播播放器 SDK 发布历史
体验 Demo
移动端自有 App 内嵌直播间 H5 页面 Demo
跑通 Demo
Android
iOS
Flutter
获取 License
Android 开播 SDK
集成 Android 开播 SDK
基础功能
进阶功能
iOS 开播 SDK
集成 iOS 开播 SDK
iOS 开播 SDK 升级指南
基础功能
进阶功能
历史文档
集成 iOS 开播 SDK（适用于 1.55.0 及之前的版本）
Android 观播 SDK
集成 Android 观播 SDK
功能列表
基础功能
进阶功能
SDK API 参考
概览
API 详情
TVULiveRoom
TVULiveRoomServer
TVUSinglePlayerView
TVUCommentListView
PlayerView
WSConnector
CommentDataManager
mSettings
CalendarUtils
LanguageManager
FloatUtil
AudienceLinkEntranceView
AudienceLinkPreviewView
AudienceLinkRemoteContainerView
RemoteLinkGroupView
AudienceLinkViewProvider
IAudienceLinkManager
DynamicCustomSettings
回调
类型详情
iOS 观播 SDK
集成 iOS 观播 SDK
功能列表
基础功能
进阶功能
SDK API 参考
API 详情
回调
错误码
类型详情
历史文档
查看历史版本文档
集成 iOS 观播 SDK（适用于 1.55.0 及之前的版本）
Web 观播 SDK
集成 Web 观播 SDK
功能列表
功能实现
SDK API 参考
配置参数
属性及方法
事件
错误码
类型详情
iframe 嵌入
控制台 iframe 嵌入
观看页 iframe 嵌入
观看页 iframe 嵌入
配置参数
事件
类型详情
Flutter 直播间观播 SDK
集成 Flutter 直播间观播 SDK
功能列表
功能实现
类型详情
微信小程序观播 SDK
集成微信小程序观播 SDK
Flutter 点播播放器 SDK
集成 Flutter 点播播放器 SDK
功能实现
Web 上传 SDK
集成 Web 上传 SDK
最佳实践
2022 飞书玩家大会
常见问题
直播间配置常见问题
网页直播常见问题
直播伴侣常见问题
播放器相关问题
观看页常见问题
数据分析常见问题
商品卡片常见问题
直播预约常见问题
观看限制常见问题
Web 观播 SDK 常见问题
iOS 观播 SDK 常见问题
OpenAPI 调用常见问题
观看页 iframe 嵌入常见问题
计费购买常见问题
观看直播相关问题
为什么观众的直播画面卡顿？
为什么观众的直播画面没有声音？
为什么观众看不到直播画面？
观看回放相关问题
直播结束后，为什么观看页没有上架对应回放？
回放内容为什么不完整？
为什么回放画面没有声音？
飞书相关问题
如何绑定与解绑飞书账号？
如何完成飞书授权？
提示暂未开通企业直播服务怎么办？
绑定错误的火山引擎账号到飞书账号怎么办？
PC 端和移动端会议转直播开播方式下，支持转移主持人吗？
其他问题
如何查看电脑处理器的型号？
如何查看电脑的操作系统类型？
最佳实践
移动端 H5 页面观众连麦
企业 SSO 登录企业直播品牌定制控制台
移动端 App 画中画模式实现方案
年会直播支付宝口令红包解决方案
微信小程序接入 SaaS 观看页及跨小程序页面跳转
相关协议
企业直播服务使用协议
企业直播服务等级协议
企业直播平台抽奖活动规则
企业直播平台抽奖活动发起方承诺函
企业直播平台红包功能服务协议
企业直播积分送礼使用规则
企业直播观播 SDK 隐私政策
企业直播观播 SDK 开发者使用合规规范
企业直播开播 SDK 隐私政策
企业直播开播 SDK 开发者使用合规规范
联系我们
直播质检
API 参考
API 发布历史
直播质检平台接口说明
使用 HTTP 请求调用
API
ListProjects - 获取项目列表
ListScenarios - 获取审核场景列表
CreateTask - 创建质检任务
ListTasks - 获取质检任务列表
GetReport - 获取任务质检报告
GetMergedReport - 获取多个任务质检报告
回调
质检消息回调
错误码
文档首页
/
企业直播
/
aPaaS SDK 参考
/
移动端自有 App 内嵌直播间 H5 页面 Demo
移动端自有 App 内嵌直播间 H5 页面 Demo
最近更新时间：2025.05.21 17:00:38
首次发布时间：2025.05.21 11:07:23
我的收藏
有用
有用
无用
无用
文档反馈