You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
企业直播
API 发布历史
复制全文
下载 pdf
API 发布历史

本文介绍企业直播服务端 OpenAPI 的文档动态。

2026 年 10 月

API发布时间变更记录关联功能
修改 UpdateAttentionDetectionConfig2026-10-19请求参数和返回参数 AttentionDetectionType 新增取值 6,支持配置静音停播检测踢出。认真度检测
修改 GetAttentionDetectionConfig返回参数 AttentionDetectionType 新增取值 6,支持获取静音停播检测踢出配置。
修改 UpdateAwardConfig请求参数 AwardItemConfigs.AwardItemCount 新增取值 -1,支持配置无限数量奖品。实时抽奖
修改 ListAwardConfigs返回参数 AwardItemInfo.AwardItemCount 新增取值 -1,支持获取无限数量奖品配置。
新增 CreateHighlightClipTask2026-10-09支持对媒资库下视频库或直播暂存中的指定视频创建高光智剪任务。AI 高光智剪
新增 ListHighlightClipTasks支持分页查询高光智剪任务列表。
新增 GetHighlightClipTaskDetail支持查询指定高光智剪任务的配置、剪辑结果和导出记录。
新增 UpdateHighlightClipResult支持更新指定高光智剪任务的名称、封面,以及生成的高光片段的描述和剪辑范围。
新增 ExportHighlightClip支持将指定的高光片段合成为一个视频并导出。
新增 DeleteHighlightClipTask支持删除指定的高光智剪任务。
新增 GetHighlightClipPromptConfig支持获取高光智剪场景的默认提示词。
修改 AddCallbackConfig请求参数 CallbackType 新增取值 35 和 36,支持新增 AI 高光智剪结果回调和 AI 高光智剪片段导出结果回调。
修改 ListCallbackConfigs请求参数 CallbackType 新增取值 35 和 36,支持查询 AI 高光智剪结果回调和 AI 高光智剪片段导出结果回调的配置。
修改 ListCallbackEvents返回参数新增 CallbackType 取值 35 和 36,支持获取 AI 高光智剪结果回调和 AI 高光智剪片段导出结果回调。
新增 UpdateActivityLiveInspectConfig支持更新指定直播间的自动质检配置,包括是否开启自动质检、质检项目、质检场景和违规消音配置。自动质检
新增 GetActivityLiveInspectConfig支持获取指定直播间当前的自动质检配置,包括自动质检开关、质检项目、质检场景和违规消音配置。

2026 年 08 月

API发布时间变更记录关联功能
修改 UpdateActivityCommentConfig2026-08-12请求参数新增 IsQuickAudiencePolling,支持开启观众端低延迟获取评论功能。聊天互动
修改 GetActivityCommentConfig返回参数新增 IsQuickAudiencePolling,支持获取是否开启观众端低延迟获取评论功能。

2026 年 07 月

API发布时间变更记录关联功能
修改 UpdateActivityQuizConfig2026-07-28请求参数新增 SendType 和 AutoSendTime,支持配置答题的手动发送或定时发送。互动工具
修改 ListActivityQuizConfigs返回参数新增 SendType 和 AutoSendTime,支持获取答题的发送方式和定时发送时间。
修改 UpdateTeachAssistantAccount请求参数 TeachAssistantFeatures 新增取值 11,支持为助播开启聊天审核权限。助播管理
修改 ListTeachAssistantAccounts返回参数 TeachAssistantFeatures 新增取值 11,支持返回助播的聊天审核权限。
修改 DeleteTeachAssistantAccount返回参数 TeachAssistantFeatures 新增取值 11,支持返回已删除助播账号的聊天审核权限。
修改 GetActivityProducts返回参数新增 DetailRedirectUrl、EnableAddCart、AddCartUrl、EnableViewCart、ViewCartUrl、EnableViewOrder 和 ViewOrderUrl,支持获取商品详情跳转、加入购物车、查看购物车和查看订单相关配置。商品卡片
修改 UpdateActivityProduct请求参数和返回参数新增 DetailRedirectUrl、EnableAddCart、AddCartUrl、EnableViewCart、ViewCartUrl、EnableViewOrder 和 ViewOrderUrl,支持配置商品详情跳转、加入购物车、查看购物车和查看订单相关信息。
修改 UpdateSingleActivityProduct请求参数和返回参数新增 DetailRedirectUrl、EnableAddCart 和 AddCartUrl,支持配置商品详情跳转和加入购物车相关信息。
修改 商品卡片配置变化回调回调参数新增 DetailRedirectUrl、EnableAddCart 和 AddCartUrl。商品详情跳转链接、展示加购按钮开关或加入购物车链接变化时会触发回调。

修改 CreateOrUpdateActivityCustomEmojiSet

  • 请求参数 EmojiSetType 取值含义变更为小图和大图。
  • 请求参数 EmojiName 支持通过竖线(|)分隔配置多语言含义词。
  • 请求参数 EmojiImage 不再限制图片宽高,仍支持配置大小不超过 500 KB 的 JPG、PNG 和 GIF 格式图片。

聊天互动

修改 ListActivityCustomEmojiSets返回参数 EmojiSetType 取值含义变更为小图和大图。
修改 GetActivityCustomEmojiSetDetail返回参数 EmojiSetType 和 EmojiType 取值含义变更为小图和大图。
新增 AddActivityCommentReviewExemption2026-07-20支持添加聊天审核豁免词。直播豁免词
新增 DelActivityCommentReviewExemption支持删除聊天审核豁免词。
新增 GetActivityCommentReviewExemption支持查询聊天审核豁免词。
修改 UpdateTeachAssistantAccount2026-07-01请求参数 TeachAssistantFeatures 新增取值 9 和 10,支持为助播开启敏感词和观众数据权限。助播管理
修改 ListTeachAssistantAccounts返回参数 TeachAssistantFeatures 新增取值 9 和 10,支持返回助播的敏感词和观众数据权限。
修改 DeleteTeachAssistantAccount
新增 UpdateActivityVideoAISummaryConfig支持修改指定直播间或点播间的视频 AI 视频总结设置,包括是否开启中英双语生成、AI 总结生成后是否自动发布总结内容等。AI 视频总结
新增 GetActivityVideoAISummaryConfig支持获取指定直播间或点播间的 AI 视频总结设置,包括是否开启中英双语生成、AI 总结生成后是否自动发布总结内容等。
新增 GenerateVideoAISummary支持对指定直播间或点播间的视频生成 AI 视频总结。
新增 TerminateVideoAISummary支持终止尚未开始生成 AI 总结内容的任务。
新增 UpdateVideoAISummary支持更新指定直播间或点播间指定视频的 AI 总结内容,包括摘要和知识点总结中的文本内容。
新增 GetVideoAISummary支持获取指定直播间或点播间内指定视频 AI 总结内容的任务状态和文本内容。
新增 UpdateVideoAISummaryStatus支持发布或取消发布指定直播间或点播间指定视频的 AI 总结内容。

2026 年 06 月

API发布时间变更记录关联功能
修改 GetPageWatchDataAPIV22026-06-17请求参数新增 VideoRoomId,支持获取点播间的观看数据,包括累计访问或观看次数、人数、时长及最高同时在线人数等。数据统计
新增 CreateVideoRoom支持创建一个知识课程点播间,或复制已有点播间。成功创建后,您可获取到点播间 ID,并根据此 ID 调用其他接口管理点播间。点播间管理
新增 DeleteVideoRoom支持删除点播间。
新增 ListVideoRooms支持查询所有或指定点播间的基础信息,包括点播间 ID、名称、观看地址等。
新增 GetVideoRoomBasicInfo支持获取单个点播间的基础信息,包括点播间的名称、观看地址、封面图、描述等信息。
新增 UpdateVideoRoomBasicInfo支持更新单个点播间的基础信息。
新增 AddVideoRoomMedias支持在指定点播间中添加视频。
新增 ListVideoRoomMedias支持获取指定点播间内的视频列表信息。
新增 DeleteVideoRoomMedias支持在指定点播间内删除指定视频。
新增 ReorderVideoRoomMedias支持修改指定点播间内视频的顺序。
新增 UpdateActivityAutoReplyCommentConfig支持更新直播间自动回复中的配置内容。开启自动回复后,当观众发送的评论内容中包含您设置的关键词时,系统将自动发送预设的回复。聊天互动
新增 GetActivityAutoReplyCommentConfig支持获取指定直播间内自动回复的配置内容。
修改 CreateCoupons请求参数新增 IsBlockRepeatPickup 并废弃 IsRepeatPickupEnable。IsBlockRepeatPickup 可代替废弃参数,并支持设置观众领取卡券的次数。卡券
修改 UpdateCoupon
修改 GetCoupon返回参数新增 IsBlockRepeatPickup 并废弃 IsRepeatPickupEnable。IsBlockRepeatPickup 可代替废弃参数,并支持获取观众领取卡券的次数。

修改 ListCoupons

  • 请求参数新增 SupportIdSearch,支持将其设为 true 后,通过 Name 字段传入卡券的完整 ID 精准搜索卡券。
  • 返回参数新增 TotalUnfilteredCount,支持获取当前账号卡券库中未过滤的卡券总数。
新增 UpdateActivityLiveAnalysisConfig2026-06-03支持设置是否开启指定直播间的 AI 直播复盘功能。AI 直播复盘
新增 GetActivityLiveAnalysisConfig支持获取指定直播间是否开启了 AI 直播复盘功能。
新增 ListActivityLiveAnalysisHistories支持获取指定直播间指定场次的复盘报告数据,包括直播诊断、全场曲线、内容分析等模块的信息和数据。
新增 GetLiveAnalysisReportOverview支持获取指定直播间的直播复盘场次列表,包括场次 ID、场次起始时间、场次评分等。
新增 ListActivityContentAnalysis支持获取直播间指定场次复盘报告中的内容分析数据,如对商品讲解、高光时刻、问题时刻等内容类型的分析。
新增 AI 直播复盘任务状态回调当直播复盘任务状态变化时,企业直播会对所设置的接口地址进行回调通知。
修改 AddCallbackConfig请求参数 CallbackType 新增取值 33,支持新增直播复盘任务状态回调。
修改 ListCallbackConfigs返回参数 CallbackType 新增取值 33,支持获取直播复盘任务状态回调。
修改 ListCallbackEvents
修改 ListActivityMediaAPI请求参数新增 IsCloseDated,对于直播暂存中的视频,支持筛选 30 天内到期的视频。直播暂存

2026 年 05 月

API发布时间变更记录关联功能
修改 ListCoupons2026-05-20返回参数新增 MaxCount,支持获取当前账号的卡券库中支持添加的卡券数量上限。卡券库

2026 年 04 月

API发布时间变更记录关联功能
新增 CreateActivityQuestionnaire2026-04-29支持在指定直播间内新增问卷。问卷
新增 UpdateActivityQuestionnaire支持在指定直播间内更新指定问卷。
新增 DeleteActivityQuestionnaire支持在指定直播间内删除指定问卷。
新增 GetActivityQuestionnaire支持在指定直播间内查询指定问卷配置信息,包含问卷题目、选项等。
新增 PublishActivityQuestionnaire支持在指定直播间内发布指定问卷。
新增 CopyActivityQuestionnaire支持在指定直播间内复制指定问卷。
新增 ListActivityQuestionnaire支持在指定直播间内获取问卷列表。
新增 OfflineActivityQuestionnaire支持在指定直播间内下线指定问卷。
新增 UpdateQuickCommentContent支持更新指定直播间的快捷评论内容。快捷评论
新增 ListQuickCommentContent支持获取指定直播间内快捷评论的内容。
修改 TopChatAPI请求参数新增 TopStatusV2,支持最多置顶 3 条评论消息。置顶评论
修改 GetTopChatAPI返回参数新增 DataV2,支持获取所有置顶评论的配置信息。
修改 PresenterChatAPIV2请求参数新增 TopStatusV2,支持最多置顶 3 条评论消息。

修改 ListUserBehaviorDataAPIV2

2026-04-15

  • 请求参数新增 UserIds,支持根据用户 ID 列表,单次获取多个观众的行为数据信息。
  • 返回参数新增 ClientType,支持获取观众访问直播间的客户端类型。

数据统计

修改 GetActivityReservationAPIV2返回参数新增 ClientType,支持获取观众访问直播间的客户端类型。
修改 CreateActivityRedPacket请求参数新增 Animation,支持开启或关闭观看页观众抢红包的红包雨动效。红包
修改 GetActivityRedPacket返回参数新增 Animation,支持获取观看页是否开启了观众抢红包的红包雨动效。
修改 ListActivityRedPacket
修改 UpdateActivityRedPacket请求参数新增 Animation,支持开启或关闭观看页观众抢红包的红包雨动效。
修改 红包结果回调参数新增 RedPacketId,支持返回红包 ID。

修改 CreateActivityBonusTask

  • 支持具备直播控制权限的子账号调用该接口。
  • 请求参数新增 WithdrawConfig,支持设置现金提现的跳转地址。

福利任务

修改 UpdateActivityBonusTask

修改 GetActivityBonusTask

  • 支持具备直播控制权限的子账号调用该接口。
  • 返回参数新增 WithdrawConfig,支持获取设置的现金提现跳转地址。
修改 ListActivityBonusTaskWinners返回参数新增 WithdrawConfig,支持获取设置的现金提现跳转地址。

修改 ListActivityBonusTasks

  • 支持具备直播控制权限的子账号调用该接口。
  • 返回参数新增 WithdrawConfig,支持获取设置的现金提现跳转地址。
修改 DeleteActivityBonusTask支持具备直播控制权限的子账号调用该接口。
修改 ChangeActivityBonusTaskStatus支持具备直播控制权限的子账号调用该接口。

2026 年 03 月

API发布时间变更记录关联功能

修改 UpdateAwardConfig

2026-03-31

  • 请求参数新增 IsOnlineUser,支持设置观众必须在开奖前 3 分钟内在线观看直播。
  • 请求参数新增 RepeatedAwardLimit,支持设置同一观众在当前直播间 30 天内允许中奖的次数。
  • 请求参数新增 IsManualSendBarragePwd,支持设置需要观众手动发送弹幕口令。

实时抽奖

修改 ListAwardConfigs

  • 返回参数新增 IsOnlineUser,支持设置观众必须在开奖前 3 分钟内在线观看直播。
  • 返回参数新增 RepeatedAwardLimit,支持设置同一观众在当前直播间 30 天内允许中奖的次数。
  • 返回参数新增 IsManualSendBarragePwd,支持设置需要观众手动发送弹幕口令。
修改 GetActivityProducts返回参数新增 CustomContent,支持获取透传的自定义扩展信息,可用于展示更多商品信息等。商品卡片
修改 UpdateActivityProduct请求参数新增 CustomContent,支持传入自定义扩展信息,可用于展示更多商品信息等。
修改 UpdateSingleActivityProduct
修改 商品卡片配置变化回调回调参数新增 CustomContent,支持获取自定义扩展信息,可用于展示更多商品信息等。
新增 SendActivityRedPacket支持在指定直播间中发送一个已创建的红包。红包
新增 DrawActivityRedPacket支持手动为红包开奖。开奖后,已参与活动的观众可以查看自己领取的红包金额。
修改 ListUserBehaviorDataAPIV2返回参数新增 VideoViewDuration,支持获取观众观看直播间时长详情,包括观众分别观看直播、预告、和回放视频的时长。数据统计
新增 ListUserChatAPI支持获取指定直播间内指定用户的评论。直播间评论
修改 GetCheckInListAPI2026-03-16请求参数新增 CheckInId,支持获取指定签到的信息。签到
新增 UpdateCheckInConfig支持在指定直播间创建或更新签到配置信息。
新增 SendCheckIn支持在指定直播间发送指定签到。
新增 StopCheckIn支持在指定直播间停止指定签到。
新增 WithdrawCheckIn支持在指定直播间撤回指定签到。
新增 DeleteCheckIn支持在指定直播间删除指定签到。
修改 评论发送回调回调参数新增 Sign 和 EventType 字段。评论

修改 CreateActivityBonusTask

  • 请求参数新增 Icon,支持设置福利任务的图标。
  • 请求参数新增 SubTask,在统计观看时长时,支持统计观看预告视频和回放视频的时长。

福利任务

修改 UpdateActivityBonusTask

  • 请求参数新增 Icon,支持更新福利任务的图标。
  • 请求参数新增 SubTask,在统计观看时长时,支持统计观看预告视频和回放视频的时长。

修改 GetActivityBonusTask

  • 返回参数新增 Icon,支持获取福利任务图标的 URL。
  • 返回参数新增 SubTask,支持获取观看时长中观看预告视频和回放视频的时长。
修改 ListActivityBonusTaskWinners返回参数新增 SubTask,支持获取观看时长中观看预告视频和回放视频的时长。

修改 ListActivityBonusTasks

  • 返回参数新增 Icon,支持获取福利任务图标的 URL。
  • 返回参数新增 SubTask,支持获取观看时长中观看预告视频和回放视频的时长。
修改 GetActivityProducts2026-03-09返回参数新增 MemberPrice,支持获取商品卡片中商品的会员价。商品卡片
修改 UpdateActivityProduct请求参数新增 MemberPrice,支持设置商品卡片中商品的会员价。
修改 UpdateSingleActivityProduct
修改 UpdateActivityBasicConfigAPI请求参数新增 IsLinkMicEnable,支持设置是否允许当前直播间使用连麦功能。连麦
修改 GetActivityBasicConfigAPI返回参数新增 IsLinkMicEnable,支持获取当前直播间是否允许使用连麦功能。
修改 CreateActivityAPIV2请求参数新增 IsLinkMicEnable,支持设置是否允许当前直播间使用连麦功能。

2026 年 02 月

API发布时间变更记录关联功能
修改 GetActivityCommentConfig2026-02-03返回参数新增 IsQuickCommentEnable,支持返回聊天互动菜单是否开启了快捷评论功能。快捷评论
修改 UpdateActivityCommentConfig请求参数新增 IsQuickCommentEnable,支持开启或关闭聊天互动菜单的快捷评论功能。
新增 UpdateActivityViewerLevel支持修改直播间指定观众的观众等级。观众等级
修改 CreateViewerLevelConfig返回参数新增 CreatedLevelIds,支持返回本次调用新增的观众等级 ID 列表。
修改 UpdateViewerLevelGroupConfig返回参数新增 ViewerLevelGroupId,支持返回本次变更的等级库 ID。

2026 年 01 月

API发布时间变更记录关联功能
新增 CreateActivityBonusTask2026-01-21支持在指定直播间内新增直播福利任务。福利任务
新增 UpdateActivityBonusTask支持在指定直播间内更新直播福利任务。
新增 GetActivityBonusTask支持获取指定直播间内指定直播福利任务的详情信息。
新增 DeleteActivityBonusTask支持在指定直播间内删除直播福利任务。
新增 ChangeActivityBonusTaskStatus支持在指定直播间内修改直播福利任务状态,如开启任务或结束任务。
新增 ListActivityBonusTaskWinners支持获取指定直播间内福利任务的获奖名单。
新增 ListActivityBonusTasks支持获取或查询指定直播间内的福利任务列表。
新增 福利任务奖励接收批量聚合回调当观众在观看页完成福利任务中的一个或多个子任务并收到奖励后,企业直播会向您设置的回调地址发送回调消息。
修改 AddCallbackConfig请求参数 CallbackType 新增取值 30,支持新增福利任务奖励接收批量聚合回调
修改 ListCallbackConfigs请求参数 CallbackType 新增取值 30,支持获取福利任务奖励接收批量聚合回调。
修改 ListCallbackEvents返回参数 CallbackType 新增取值 30,支持返回福利任务奖励接收批量聚合回调。
新增 ForbidLiveChannel支持封禁指定直播间的所有直播频道。封禁
新增 ResumeLiveChannel支持解禁指定直播间的所有频道。

修改 GetAccountUserTrackData

  • 请求参数新增 ScrollId、PageItemCount 和 PageNo 参数,支持通过滚动查询或分页查询方式获取返回数据。
  • 返回参数新增 UserId 和 WatchType 参数,支持当通过 ExternalId 查询用户画像时,返回该 ID 对应的所有用户数据。

数据中心-用户画像

修改 AddWebSDKDomain2026-01-06新增请求参数 WhitelistScenes,支持配置 URL 域名生效的场景。Web SDK 配置
修改 ListWebSDKDomainConfigs新增返回参数 WhitelistScenes,支持获取 URL 域名配置生效的场景。
新增 UpdateWebSDKDomain支持更新 Web SDK 域名配置中 URL 域名生效的场景。
新增 AddWxMiniAppFile支持新增微信小程序校验文件配置,用于完成微信小程序平台要求的安全校验,确保企业直播观看页在微信小程序内可正常使用。观看页 iframe 嵌入
新增 ListWxMiniAppFiles支持获取微信小程序校验文件配置列表。
新增 DeleteWxMiniAppFile支持删除已添加的微信校验小程序文件配置。

新增 违规和举报消息回调

当您在企业直播控制台的消息中心接收到以下类型的消息时,企业直播会对所设置的接口地址进行回调通知:

  • 直播违规警告
  • 直播违规中断
  • 评论举报
  • 直播举报

消息中心

修改 AddCallbackConfig请求参数 CallbackType 新增取值 31,支持新增违规和举报消息回调类型。
修改 ListCallbackConfigs请求参数 CallbackType 新增取值 31,支持获取违规和举报消息回调类型信息。
修改 ListCallbackEvents返回参数 CallbackType 新增取值 31,支持返回违规和举报消息回调类型。
修改 CreateActivityCoupons请求参数新增 SendCouponType 和 AutoSendTime,支持定时或手动发送卡券。卡券
修改 UpdateActivityCoupon
修改 ListActivityCoupons返回参数新增 SendCouponType 和 AutoSendTime,支持获取发送卡券的方式和定时发送卡券的时间。
修改 CreateActivityRedPacket请求参数新增 SendCouponType 和 AutoSendTime,支持定时或手动发送红包。红包
修改 UpdateActivityRedPacket
修改 GetActivityRedPacket返回参数新增 SendCouponType 和 AutoSendTime,支持获取发送红包的方式和定时发送红包的时间。
修改 ListActivityRedPacket
修改 CreateVipOrBlackListUserInfo配置红包中的优先中奖名单时,支持按关联用户 ID 新增观众。

2025 年 12 月

API发布时间变更记录关联功能
修改 UpdateAwardItem2025-12-04支持通过请求参数 AwardItemNum 传入关联卡券 ID,绑定您商城系统中的卡券,方便后续卡券的发放以及在商城内的核销。卡券
修改 GetAwardItemList支持通过返回参数 AwardItemNum 获取关联卡券 ID。
修改 ListAwardConfigs
修改 GetTaskAwardItemListAPI
修改 实时抽奖结果回调支持通过回调参数 AwardItemNum 获取到关联卡券 ID。
修改 累计观看抽奖结果批量聚合回调
修改 UpdateAwardConfig请求参数新增 BlackUserInfoId 和 VipUserInfoId,支持在新增或更新实时抽奖时,设置优先中奖名单和中奖黑名单。实时抽奖
修改 CreateVipOrBlackListUserInfo请求参数新增 ExternalUserId,支持传入关联用户 ID,从而支持将名单添加至实时抽奖中。
修改 DeleteVipOrBlackListUserInfo请求参数新增 ExternalUserId,支持基于关联用户 ID 删除用户信息。
修改 GetVipOrBlackListUserInfo返回参数新增 ExternalUserId,支持获取关联用户 ID。

2025 年 11 月

API发布时间变更记录关联功能
修改 UpdateAttentionDetectionConfig2025-11-12请求参数 AttentionDetectionType 新增取值 5,支持无互动检测踢出类型。认真度检测
修改 GetAttentionDetectionConfig返回参数 AttentionDetectionType 新增取值 5,支持无互动检测踢出类型。
修改 SendProductOrderMessage请求参数新增 Amount,支持设置下单人数。商品卡片
修改 商品卡片配置变化回调回调参数新增 Timestamp,支持返回商品卡片配置发生变化的时间。
新增 UpdateAwardConfig2025-11-04支持在直播间内新增、更新或删除实时抽奖。实时抽奖
新增 SendAward支持在直播间内发送实时抽奖。
新增 WithdrawAward支持在直播间内撤回已发送的实时抽奖。

修改 ListAwardConfigs

  • 请求参数新增 All,支持获取所有的实时抽奖的配置信息,包括未发送的抽奖。
  • 返回参数 Status 新增取值 1,支持返回未发送状态的抽奖配置信息。
新增 签到状态变化回调当签到状态发生变化时,包括签到创建、删除、发送、截止或其它状态变化,企业直播会向您设置的回调地址发送回调消息。签到
新增 签到参与回调当观众参与签到时,企业直播会向您设置的回调地址发送回调消息。
修改 ListCallbackEvents返回参数 CallbackType 新增取值 28 和 29,支持返回签到状态变化回调和签到参与回调。
修改 ListCallbackConfigs
修改 AddCallbackConfig请求参数 CallbackType 新增取值 28 和 29,支持新增签到状态变化回调和签到参与回调。
修改 CreateActivityCoupons请求参数新增 IsViewerLevelLimit 和 ViewerLevelConfigIds,支持设置仅满足指定观众等级的用户才可领取卡券。卡券
修改 UpdateActivityCoupon请求参数新增 IsViewerLevelLimit 和 ViewerLevelConfigIds,支持设置仅满足观众等级的用户才可领取卡券。
修改 ListActivityCoupons返回参数新增 IsViewerLevelLimit 和 ViewerLevelConfigMetas,支持获取卡券是否开启了观众等级参与条件和具体观众等级配置。
新增 GetActivityThumbUpNumber支持获取直播间的点赞数值。点赞
新增 GetActivityLoginSecret支持获取观众通过 Web 观播 SDK 进入直播间或点播间所需的登录秘钥。该秘钥为直播间或点播间维度并支持长期使用。观播 SDK

2025 年 10 月

API发布时间变更记录关联功能
修改 CreateActivityAPIV22025-10-16请求参数新增 AutoStartConfig,支持在直播间自动开播时,设置重复开播的方式、频率和截止日期。自动开播
修改 UpdateActivityBasicConfigAPI
修改 GetActivityBasicConfigAPI返回参数新增 AutoStartConfig,支持返回直播间自动开播重复开播的配置,包括重复开播的方式、频率和截止日期。
修改 UploadMediaByURL新增支持上传 FLV 格式的视频文件。上传视频
新增 批量上传视频至视频库结果回调在通过 UploadMediaByURL 接口批量上传视频至媒资库下的视频库后,企业直播会向您设置的回调地址发送回调消息。
新增 媒资库视频转码完成回调当媒资库中的视频转码完成后,企业直播会向您设置的回调地址发送回调消息。
修改 AddCallbackConfig请求参数 CallbackType 新增取值 26 和 27,支持新增批量上传视频至视频库结果回调和媒资库视频转码完成回调。
修改 ListCallbackEvents返回参数 CallbackType 新增取值 26 和 27,支持返回批量上传视频至视频库结果回调和媒资库视频转码完成回调。
修改 ListCallbackConfigs

2025 年 09 月

API发布时间变更记录关联功能
新增 HideProductPrice2025-09-26支持更新直播间内已有商品卡片售卖价格的隐藏状态。商品卡片
新增 UpdateProductOutOfStock支持更新直播间内已有商品卡片的售罄状态。
修改 UpdateSingleActivityProduct请求参数新增 PriceHidden 和 OutOfStock,支持设置和更新商品卡片的售罄状态和价格的隐藏状态。
修改 UpdateActivityProduct
修改 GetActivityProducts返回参数新增 PriceHidden 和 OutOfStock,支持返回商品卡片的售罄状态和价格的隐藏状态。
修改 UpdateActivityUserBanStatus请求参数新增 ExternalUserIds,支持传入关联用户 ID。踢出与封禁

修改 CreateActivityRedPacket

  • 请求参数 RewardPointNumber 新增枚举值 -1,支持发放不限量指定金额的红包。
  • 请求参数新增 Name,支持自定义红包名称。

红包

修改 UpdateActivityRedPacket

修改 GetActivityRedPacket

  • 返回参数 RewardPointNumber 新增枚举值 -1,表示发放的红包不限制个数。
  • 返回参数新增 Name,支持返回自定义红包名称。
修改 ListActivityRedPacket

修改 ListRedPacketDataAPI

  • 返回参数 TotalAmount 新增枚举值 -1,表示红包总金额或总积分无限制。
  • 返回参数新增 Name,支持返回自定义红包名称。
新增 参与实时抽奖回调当观众在直播间点击立即参与并成功参与实时抽奖时,企业直播会对所设置的接口地址进行回调通知。实时抽奖
修改 AddCallbackConfig请求参数 CallbackType 参数新增取值 25,支持新增参与实时抽奖回调。
修改 ListCallbackEvents返回参数 CallbackType 参数新增取值 25,支持返回参与实时抽奖回调。
修改 ListCallbackConfigs
新增 UpdateViewerLevelGroupConfig支持增、删、改、查指定观众等级库。观众等级
新增 ListAccountViewerLevelGroup
新增 DeleteViewerLevelGroup
修改 CreateViewerLevelConfig请求参数新增 ViewerLevelGroupId,支持指定观众等级库。
修改 UpdateViewerLevelConfig
修改 ReorderViewerLevelConfig
修改 DeleteViewerLevelConfig
修改 GetViewerLevelConfig返回参数新增 ViewerLevelGroupId,支持返回指定的观众等级库 ID。
修改 UpdateActivityBasicConfigAPI请求参数新增 BindAccountLevelGroupId,支持直播间绑定指定观众等级库。
修改 GetActivityBasicConfigAPI返回参数新增 BindAccountLevelGroupId,支持返回直播间绑定的观众等级库 ID。
修改 GetTaskAwardRecordStatisticsAPI2025-09-09返回参数新增 AwardEmail,用于获取中奖观众填写的邮箱地址。累计观看抽奖
修改 ListAwardRecordStatistics实时抽奖
修改 UpdateAwardItem请求参数 WinnerInfoType 新增取值 4,支持在配置实物奖品时设置中奖人填写邮箱。奖品库
修改 GetAwardItemList返回参数 WinnerInfoType 新增取值 4,支持返回中奖观众填写的邮箱地址。

2025 年 08 月

API发布时间变更记录关联功能
新增 GetAccountRealTimeOnlineNumber2025-08-26支持获取账号下实时在线的所有观看人数。直播间基础数据
修改 UpdateLoopVideos请求参数新增 PlayType、LoopNumber、AutoStartTime 和 AutoEndTime,用于设置多次轮播,支持按次数或时间段设置。录播直播
修改 ListLoopVideos返回参数新增 PlayType、LoopNumber、AutoStartTime 和 AutoEndTime,用于获取录播直播设置。
新增 累计观看抽奖结果批量聚合回调2025-08-12当观众参与累计观看抽奖并点击开奖时,企业直播会向您设置的回调地址发送回调消息。单次回调最多包含 1000 条中奖观众信息。累计观看抽奖
修改 ListCallbackEvents返回参数 CallbackType 参数新增取值 24,支持返回累计观看抽奖结果批量聚合回调。
修改 ListCallbackConfigs
修改 AddCallbackConfig请求参数 CallbackType 参数新增取值 24,支持新增累计观看抽奖结果批量聚合回调。
修改 ListAwardConfigs返回参数新增 AwardFloatingIcon,支持获取自定义的抽奖图标链接。实时抽奖

2025 年 07 月

API发布时间变更记录关联功能
新增 ListCallbackEvents2025-07-31获取企业直播支持的回调消息类型,以及对应的配置数量和回调通知事件类型。回调配置
新增 AddCallbackConfig支持增、删、改、查指定类型的回调配置信息。
新增 UpdateCallbackConfig
新增 DeleteCallbackConfig
新增 ListCallbackConfigs
新增 AddWebSDKDomain支持增、删、查 Web SDK 域名配置。Web SDK 域名配置
新增 ListWebSDKDomainConfigs
新增 DeleteWebSDKDomain
新增 GetViewerLevelConfig支持增、删、改、查账户中心 > 观众等级页面的配置信息。观众等级
新增 CreateViewerLevelConfig
新增 UpdateViewerLevelConfig
新增 DeleteViewerLevelConfig
新增 ReorderViewerLevelConfig支持调整账户中心 > 观众等级页面的等级顺序。
修改 GetSDKTokenAPI请求参数新增 LevelId,用于与您的自有账号系统对接,在观看页展示对应的观众等级。
修改 ListUserBehaviorDataAPIV2返回参数新增 LevelName 和 ViewerLevelOrder,支持获取观众的等级名称和等级序号。
修改 UpdateActivityBasicConfigAPI请求参数新增 IsViewerLevelShowEnable,支持设置直播间是否开启观众等级功能。
修改 GetActivityBasicConfigAPI返回参数新增 IsViewerLevelShowEnable,支持获取直播间是否开启了观众等级功能。
新增 商品卡片配置变化回调2025-07-15当商品卡片配置发生变化时,例如上架商品卡片、调整商品卡片顺序、更新商品图等,企业直播会对所设置的接口地址进行回调通知。商品卡片
新增 UpdateSingleActivityProduct支持在直播间中新增、更新或删除单个商品卡片。
新增 GetLiveLinkDurationData支持获取指定直播间或指定账号创建的所有直播间在指定时间范围内连麦时长预付费和后付费的使用情况。连麦时长
新增 UpdateInPageAdvertisement支持在直播间中新增、更新或删除页中广告。页中广告
新增 GetInPageAdvertisement支持获取直播间中页中广告的图片、跳转链接等配置信息。
修改 ListMediasAPI返回参数新增 StartTime 和 EndTime,支持获取回放视频对应的直播开始和结束时间。回放
修改 直播回放生成回调新增回调参数 LiveStartTime 和 LiveEndTime,支持将回放视频对应的直播开始和结束时间提交给您自定义的回调接口地址。
修改 切片录制视频生成回调
修改 CreateCoupons请求参数新增 IsRepeatPickupEnable,支持设置卡券是否允许重复领取。卡券
修改 CreateActivityCoupons请求参数新增 IsWatchLiveLimit,支持设置是否开启观看直播参与条件。
修改 UpdateActivityCoupon
修改 ListActivityCoupons返回参数新增 IsWatchLiveLimit 和 IsRepeatPickupEnable,支持获取是否开启观看直播参与条件以及卡券是否允许重复领取。
修改 UpdateCoupon请求参数新增 IsRepeatPickupEnable,支持设置卡券是否允许重复领取。
修改 ListCoupons返回参数新增 IsRepeatPickupEnable,支持获取卡券是否允许重复领取。
修改 GetCoupon返回参数新增 IsRepeatPickupEnable,支持获取卡券是否允许重复领取。
修改 GetPageWatchDataAPIV2请求参数新增 LineId,支持根据直播频道筛选直播间数据。直播频道
新增 EnableActivityMultiProductExplain2025-07-02支持开启或关闭指定直播间的多商品讲解功能。多商品讲解
修改 UpdateActivityProduct返回参数新增 FloatingTime,支持获取最近一次浮窗展示商品卡片的时间。

修改 GetActivityProducts

  • 返回参数新增 FloatingTime,支持获取最近一次浮窗展示商品卡片的时间。
  • 返回参数新增 IsMultiProductExplainEnable,支持获取是否开启多商品讲解功能。
修改 CreateLiveChannelConfig新增错误码 OperationDenied.DeniedByMultiProductExplain,开启多商品讲解功能期间,无法开启直播时移功能。
修改 UpdateLiveChannelConfig

修改 UpdateActivityUserBanStatus

  • 踢出功能变更:
    • 不再支持解除观众的踢出状态。
    • 观众被踢出直播间后,由原来的无法再次进入当前直播间,变更为可以点击继续观看重新进入当前直播间。
  • 封禁功能变更:由原来的任何使用被封禁 IP 的观众均无法进入或继续停留在当前直播间,变更为仅被封禁的观众无法进入或继续停留在当前直播间。
  • 接口用途变更:由原来的用于踢出或解除踢出观众或设备,变更为封禁、踢出或解除封禁观众或设备。
  • 请求参数新增 BanType,用于设置操作类型。
  • 请求参数 BanStatus 含义变更:由原来的踢出或解除踢出,变更为封禁或解除封禁。

踢出与封禁

修改 GetActivityBanUsers

  • 踢出功能变更:观众被踢出直播间后,由原来的无法再次进入当前直播间,变更为可以点击继续观看重新进入当前直播间。
  • 封禁功能变更:由原来的任何使用被封禁 IP 的观众均无法进入或继续停留在当前直播间,变更为仅被封禁的观众无法进入或继续停留在当前直播间。
  • 接口用途变更:由原来的获取直播间被踢出的观众和设备列表,变更为获取直播间被封禁的观众和设备列表。
  • 请求参数新增 PageNo 和 PageItemCount,支持分页查询。
修改 UpdateSecurityControlConfig请求参数新增 BanTip 和 KickTip,支持自定义观众被封禁或踢出后,观看页显示的提示信息。
修改 GetSecurityControlConfig返回参数新增 BanTip 和 KickTip,支持获取观众被封禁或踢出后,观看页显示的提示信息。

2025 年 06 月

API发布时间变更记录关联功能
修改 GetAccountUserTrackData2025-06-19返回参数新增 CheckInCount,用于获取观众签到的次数。用户画像
修改 ListAccountUserData
修改 UpdateProductReminderInfo2025-06-04请求参数 Stock(库存提醒数量)的字符长度上限提升至 5。商品卡片

修改 UpdateActivityProduct

  • 请求参数 Title(商品名称)的字符长度上限提升至 100。
  • 请求参数 Stock(库存提醒数量)的字符长度上限提升至 5。

2025 年 05 月

API发布时间变更记录关联功能

修改 UpdateTeachAssistantAccount

2025-05-27

  • 请求参数新增 LoginType,支持新增或更新邀请登录类型的助播账号。助播可通过邀请链接在 PC 端或手机端进入观看页,并在登录直播间(仅输入昵称除外)后,在聊天互动菜单下管理直播间。
  • 返回参数新增 LoginType 和 UserId,用于获取助播的登录方式以及邀请登录类型助播的用户 ID。

助播账号

修改 ListTeachAssistantAccounts返回参数新增 LoginType 和 UserId,用于获取助播的登录方式以及邀请登录类型助播的用户 ID。
修改 DeleteTeachAssistantAccount
修改 UpdateActivityBasicConfigAPI2025-05-20请求参数新增 IsAvatarShowEnable,支持设置是否在观看页展示观众头像。观众头像
修改 GetActivityBasicConfigAPI返回参数新增 IsAvatarShowEnable,支持获取是否在观看页展示观众头像。
修改 ListPosterInviteAPI返回参数新增 InviterAvatar,支持获取分享人的头像地址。
修改 ListUserBehaviorDataAPIV2返回参数新增 InviterAvatar 和 AvatarUrl,支持获取分享人和观众的头像地址。
修改 ListAccountUserData返回参数新增 AvatarUrl,支持获取观众的头像地址。
修改 UpdateActivityCommentConfig新增错误码 OperationDenied.InsufficientLLMCallBalance,当无可用大模型资源包时,聊天 AI 分析功能开启失败。聊天 AI 分析

2025 年 04 月

API发布时间变更记录关联功能
修改 GetAccountUserTrackData2025-04-28请求参数新增 ExternalId 和 WatchType,支持根据关联用户 ID 筛选观众的用户画像。用户画像
新增 ResendActivityCoupon支持重新发放卡券。卡券
新增 卡券领取批量聚合回调当观众在观看页领取卡券时,企业直播会对所设置的接口地址进行回调通知。回调消息中最多可以包含 1000 条领取卡券的观众信息。
新增 切片录制视频生成回调2025-04-15当成功调用 GenerateActivityStreamSlice 接口生成直播流切片或通过直播伴侣生成录制切片时,企业直播会对所设置的接口地址进行回调通知。切片录制
修改 ExplainProduct新增错误码 OperationDenied.InteractionScriptExecuting,当正在播放的录播直播视频包含商品脚本时,更新直播间中商品卡片的讲解状态或浮窗展示状态失败。商品脚本
修改 GetCheckInListAPI2025-04-09返回参数新增 CannotWatchLivePrompt,支持获取未按时签到的观众被踢出直播间后的提示信息。签到

2025 年 03 月

API发布时间变更记录关联功能
修改 ListUserBehaviorDataAPIV22025-03-31返回参数新增 ViewDuration,支持获取秒级观看页访问时长或播放器观看时长。当根据设备 ID(Cookie)或用户 ID(UserId)合并同一设备或同一观众的多条观众行为记录时,建议采用该参数的时长数据,从而避免误差。观众行为数据
修改 GetVideoLibraryFolderTree2025-03-20返回参数新增 FolderTypeForSubAccount,支持获取调用接口的子账号对分类的操作权限。视频库分类
修改 直播间基础配置变化回调新增回调参数 SubAccountName,支持将创建直播间的账号提交给您自定义的回调接口地址。直播间信息
修改 直播预约结果回调
修改 实时抽奖结果回调
修改 评论发送回调
修改 直播回放生成回调
修改 红包结果回调
修改 直播预约点击回调
修改 直播流状态变化回调
修改 直播间数据导出回调
修改 观众状态变化回调
修改 聊天 AI 分析结果回调
修改 合并回放视频结果回调新增回调参数 SubAccountName 和 VideoSubAccountName,支持将创建直播间和视频的账号提交给您自定义的回调接口地址。直播间和视频信息
修改 剪辑视频结果回调新增回调参数 VideoSubAccountName,支持将创建视频的账号提交给您自定义的回调接口地址。视频信息

修改 ListUserBehaviorDataAPIV2

2025-03-13

  • 请求参数新增 UserId 和 ExternalUserId,支持根据观众的用户 ID 和关联用户 ID 筛选观众行为数据。
  • 请求参数新增 InviterId 和 InviterExternalId,支持根据分享人的用户 ID 和关联用户 ID 进行筛选,返回该分享人邀请的观众行为数据。

观众行为数据

新增 CreateActivityRedPacket2025-03-06支持在直播间内增、删、改、查红包,以及增、删、查红包优先中奖名单或中奖黑名单的用户信息。红包
新增 UpdateActivityRedPacket
新增 DeleteActivityRedPacket
新增 GetActivityRedPacket
新增 ListActivityRedPacket
新增 CreateVipOrBlackListUserInfo
新增 GetVipOrBlackListUserInfo
新增 DeleteVipOrBlackListUserInfo

2025 年 02 月

API发布时间变更记录关联功能

修改 CreateActivityAPIV2

2025-02-27

  • 请求参数新增 ActivityType,支持将直播模式设置为视频直播或伪直播。
  • 请求参数新增 IsAutoStartEnable,支持设置是否开启自动开播功能。
  • 请求参数新增 LoopVideos,支持设置伪直播视频列表。

创建直播间

修改 CreateActivityAPIV22025-02-26请求参数新增 Vid,支持通过传入视频库或直播暂存中视频的 Vid,创建直播间。新创建的直播间状态为回放,同时该视频会作为直播间的回放上架观看页。
修改 GetTopChatAPI2025-02-18返回参数新增 LLMAnalyzeResult,支持获取聊天 AI 分析的结果。聊天 AI 分析
修改 GetHotChatAPI
修改 PollingChatAPI
修改 UpdateActivityCommentConfig请求参数新增 IsCommentLLMAnalyzeEnable,支持设置是否开启聊天 AI 分析功能。
修改 GetActivityCommentConfig返回参数新增 IsCommentLLMAnalyzeEnable,支持获取是否开启聊天 AI 分析功能。
新增 聊天 AI 分析结果回调当产生聊天 AI 分析结果时,企业直播会对所设置的接口地址进行回调通知。
修改 UpdateActivityPoster2025-02-13请求参数新增 EnableMiniApp、MiniAppId 和 MiniAppRedirectUrl,支持开启并设置微信小程序跳转功能。直播分享
修改 GetActivityPoster返回参数新增 EnableMiniApp、MiniAppId 和 MiniAppRedirectUrl,支持获取是否开启微信小程序跳转功能以及相关配置。

2025 年 01 月

API发布时间变更记录关联功能
修改 CreateCoupons2025-01-24请求参数新增 OwnerSubAccountName,支持通过主账号调用接口替指定子账号新增卡券。卡券
修改 GetStreamsAPI请求参数新增 NeedRefreshPushUrl,支持设置是否手动刷新推流地址。推流地址
新增 UpdateActivityUserBanStatus支持在直播间中踢出或解除踢出观众或设备,以及获取直播间中被踢出的观众和设备列表。封禁与踢出
新增 GetActivityBanUsers
新增 UpdateActivityIpBanStatus支持在直播间中封禁或解禁 IP 地址,以及获取直播间中被封禁的 IP 列表。
新增 GetActivityBanIps
修改 CreateActivityAPIV22025-01-21请求参数新增 IsReplayAutoOnlineEnable,支持设置在直播结束后,是否自动将直播回放上架到观看页。自动上架回放

修改 ListActivityByCacheAPI

  • 请求参数新增 FollowerUserName,支持根据创建直播间的账号筛选直播间。
  • 返回参数新增 SubAccountName,支持获取创建直播间的账号。

直播间信息

修改 ListActivityAPI
修改 直播状态变化回调新增回调参数 SubAccountName,支持将创建直播间的账号提交给您自定义的回调接口地址。
修改 直播间创建或删除回调
修改 SendCustomSystemMessageAPI当 MessageType 取值为 2 时,请求参数 Content 的最大字符长度从 600 变更为 1200。自定义系统消息
修改 观众状态变化回调新增回调参数 UsageType,支持将观众所在的观看页的接入方式提交给您自定义的回调接口地址。观看页接入方式
新增 GetActivityReplayPlayerConfig支持获取和更新指定直播间的回放播放器设置,包括是否显示进度条、清晰度选择和倍速选择按钮。回放
新增 UpdateActivityReplayPlayerConfig
修改 ListLoopVideos返回参数新增 InteractionScriptEnabled 和 InteractionScriptId,支持获取是否开启互动脚本以及伪直播视频绑定的互动脚本 ID。互动脚本

修改 UpdateLoopVideos

  • 请求参数新增 InteractionScriptEnabled 和 InteractionScriptId,支持更新是否开启互动脚本以及伪直播视频绑定的互动脚本 ID。
  • 返回参数新增 InteractionScriptEnabled 和 InteractionScriptId,支持获取是否开启互动脚本以及伪直播视频绑定的互动脚本 ID。
修改 ListActivityMediaAPI返回参数新增 InteractionScriptId,支持获取媒资库视频的互动脚本 ID。
新增 UpdateActivityMediaInfo支持更新媒资库下视频库或直播暂存中视频的信息,包括视频 ID、互动脚本 ID 和视频名称。媒资库
新增 GetActivityMessageConfig2025-01-09支持获取和更新指定直播间的系统消息配置,包括是否开启或关闭抽奖通知、送礼消息、进场消息等。系统消息
新增 UpdateActivityMessageConfig

修改 UpdateActivityProduct

2025-01-03

  • 请求参数新增 PromotionTagType、PromotionTagUrl、SellingPointTag、ReminderType、HotSale、Stock、IsOrderMsgEnable,支持设置商品卡片的活动标签、卖点标签、热卖提醒、库存提醒以及是否开启下单消息。
  • 返回参数新增 PromotionTagType、PromotionTagUrl、SellingPointTag、ReminderType、HotSale、Stock、IsOrderMsgEnable,支持获取商品卡片的活动标签、卖点标签、热卖提醒、库存提醒以及是否开启下单消息。

商品卡片

修改 GetActivityProducts返回参数新增 PromotionTagType、PromotionTagUrl、SellingPointTag、ReminderType、HotSale、Stock、IsOrderMsgEnable,支持获取商品卡片的活动标签、卖点标签、热卖提醒、库存提醒以及是否开启下单消息。
修改 UpdateActivityCommentConfig请求参数新增 IsViewInPurchaseEnable 和 IsViewOrderEnable,支持设置是否开启查看商品消息和下单购买消息。聊天互动
修改 GetActivityCommentConfig返回参数新增 IsViewInPurchaseEnable 和 IsViewOrderEnable,支持获取是否开启查看商品消息和下单购买消息。
修改 PresenterChatAPIV2请求参数新增 TopStatus,用于设置是否置顶当前评论。置顶评论
新增 UpdateProductReminderInfo支持更新商品的热卖或库存提醒。在商品讲解期间,移动端的浮窗商品卡片和商品卡片菜单中,可以动效展示该商品的热卖或库存情况,促进下单。商品卡片
新增 SendProductOrderMessage支持发送商品下单购买消息。移动端观众可在聊天区域查看下单购买消息,点击消息中的立即购买,即可跳转至指定商品的详情页,从而提高商品成单率。

2024 年 12 月

API发布时间变更记录关联功能
新增 GetInviterToken2024-12-20支持获取直播间指定分享人的专属 Token。您可将获取的 Token 拼接到 iframe 的嵌入链接中,从而统计 iframe 嵌入场景的分享人和邀请人数。直播分享
新增 UpdateActivityPoster2024-12-16支持更新和获取指定直播间的直播分享配置信息,包含自定义分享地址、邀请海报和邀请榜单等信息。
新增 GetActivityPoster
修改 ListUserBehaviorDataAPIV2返回参数新增 InviterExternalId,支持获取分享人的关联用户 ID。观众行为数据
修改 CreateActivityAPIV2返回参数新增 ViewUrl,支持获取直播间的观看页地址。观看地址

2024 年 11 月

API发布时间变更记录关联功能
新增 CreateSubAccount2024-11-26支持创建子账号,从而实现子账号的权限管理和资源隔离。子账号
新增 UpdateSubAccount支持更新子账号信息、删除子账号、根据账号查询子账号,以及获取子账号及其角色和组织的列表。
新增 DeleteSubAccount
新增 ListSubAccounts
新增 GetSubAccount
新增 ListSubAccountRoles
新增 ListSubAccountOrganizations

新增 飞书客户端内企业直播子账号申请回调

当不具备企业直播子账号的飞书用户在飞书客户端的直播入口点击申请子账号时,企业直播会对所设置的接口地址进行回调通知。
Image
如需在飞书用户点击申请子账号后跳转到指定的飞书机器人,而非火山引擎企业直播飞书机器人,可使用该回调。

修改 CreateActivityAPIV2请求参数新增 CreatorName,用于指定创建直播间的账号。主子账号
新增 ExportActivityData支持导出直播间的数据并获取导出的数据文件。目前仅支持导出直播间的人次、人数、人数峰值等页面访问和播放器观看的基础数据。直播间基础数据
新增 GetActivityExportFile
新增 直播间数据导出回调在成功调用 ExportActivityData 接口导出直播间数据时,企业直播会对所设置的接口地址进行回调通知。
新增 GetLinkUserAmount支持获取指定直播间已加入连麦的人数,包括观众、嘉宾和主持人。连麦
新增 ListWaitLinkAudience支持获取指定直播间中,已申请连麦但上麦申请尚未通过的观众列表。
修改 ListAccountUserData返回参数新增 ThumbUpNumber,支持获取观众的直播间点赞数量。数据中心 > 用户画像
修改 GetAccountUserTrackData
修改 ListUserBehaviorDataAPIV2数据统计 > 观众行为数据
修改 GetTemporaryLoginTokenAPI返回参数新增 TmpSecretKey 和 ExpireTime,支持获取直播间的临时开播密钥及其过期时间。开播密钥
修改 GetWebPushLiveClientAPI返回参数新增 TmpUrl 和 ExpireTime,支持获取临时的网页直播一键开播地址及其过期时间。网页直播一键开播地址
修改 GetDownloadLiveClient返回参数新增 TmpUrl 和 ExpireTime,支持获取直播伴侣的临时一键开播地址及其过期时间。直播伴侣一键开播地址
修改 GetDownloadLiveClientAPI
修改 GetActivityLinks返回参数新增 TmpUrl 和 ExpireTime,支持获取临时的网页直播一键开播地址及其过期时间,以及直播伴侣的临时一键开播地址及其过期时间。网页直播一键开播地址、直播伴侣一键开播地址
新增 CreateCoupons2024-11-15支持新增、更新、获取、删除、查询卡券库卡券。卡券
新增 UpdateCoupon
新增 ListCoupons
新增 DeleteCoupons
新增 GetCoupon
新增 CreateActivityCoupons支持在直播间内新增、更新、删除、获取、发送卡券互动工具。
新增 UpdateActivityCoupon
新增 DeleteActivityCoupons
新增 ListActivityCoupons
新增 SendActivityCoupon
新增 GetActivityCouponPickData支持获取直播间内指定和所有卡券的领取信息。
新增 GetActivityAllCouponsPickData
新增 StopActivityCoupon支持停止发放卡券。
修改 GetAccountUserTrackData返回参数新增 CouponPickupCount,支持获取观众领取的卡券数量。
修改 ListAccountUserData
修改 ListAwardConfigs2024-11-12返回参数新增 DeadLineSecond、AwardSendType 和 AwardSendTime,支持获取开奖倒计时中的秒数、抽奖发送方式(手动或定时)以及抽奖定时发送的时间。实时抽奖
修改 GetAccountTemplateAPI2024-11-06返回参数新增 LiveLayout,用于区分直播模式(三分屏或纯视频)。直播模式
修改 GetActivityBasicConfigAPI
修改 GetActivityAPI
修改 CreateActivityAPIV2请求参数新增 LiveLayout,用于指定待创建直播间的直播模式(三分屏或纯视频)。

修改 ListActivityByCacheAPI

  • 请求参数新增 LiveLayout,用于筛选指定直播模式(三分屏或纯视频)的直播间。
  • 返回参数新增 LiveLayout,用于区分直播模式(三分屏或纯视频)。
修改 ListActivityAPI

2024 年 10 月

API发布时间变更记录关联功能
修改 ListActivityByCacheAPI2024-10-29请求参数新增 SortBy 和 SortOrder,用于设置返回直播间的排序规则和顺序。直播间列表
修改 ListActivityAPI

新增 观众状态变化回调

2024-10-23

当发生以下事件导致观众状态变化时,企业直播会对所设置的接口地址进行回调通知。

  • 观众进入直播间
  • 观众离开直播间
  • 观众开始观看预告
  • 观众停止观看预告
  • 观众开始观看直播
  • 观众停止观看直播
  • 观众开始观看回放
  • 观众停止观看回放

回调

新增 UpdateAwardItem2024-10-15支持增、删、改、查奖品库奖品。奖品库
新增 GetAwardItemList
新增 DeleteAwardItem
新增 UpdateAnswerRepetition2024-10-09支持开启或关闭直播间的答题重现功能。功能开启后,直播中发送的答题和简答,将在直播回放的对应时间点自动弹出重现。回放管理 > 答题重现
修改 CreateActivityAPIV2请求参数新增 IsAnswerRepetitionEnable,支持设置是否开启新建直播间的答题重现功能。功能开启后,直播中发送的答题和简答,将在直播回放的对应时间点自动弹出重现。
新增 UpdateActivityQuizConfig支持更新直播间未发送的答题或简答的配置信息。互动工具 > 答题、简答
新增 ListActivityQuizConfigs支持获取直播间的答题或简答配置信息。
修改 ListQuizStatisticsAPI返回参数新增 QuizType,用于区分返回数据的类型(答题或简答)。

2024 年 09 月

API发布时间变更记录关联功能
新增 GetLarkSubAccountInfo2024-09-19支持获取用户类型为飞书成员的子账号信息。账户中心 > 权限管理 > 用户管理

修改 ListUserBehaviorDataAPIV2

返回参数新增 EmployeeNo,支持获取观众的工号。

说明

该参数仅在满足指定条件后才会有值。

数据统计 > 观众行为数据

新增 GetLiveTrafficPostPayData支持获取指定直播间或指定账号在指定时间范围内直播流量预付费和后付费的使用情况。直播流量
新增 UpdateAccountBanStatus2024-09-09支持根据用户 ID 封禁或解禁一个或多个观众。观众被封禁后,无法进入当前主账号及其子账号的任一直播间。数据中心 > 用户画像

修改 ListAccountUserData

  • 新增请求参数 BanStatus 和 UserIds,支持根据观众的封禁状态和用户 ID 筛选数据。
  • 返回参数新增 BanStatus,支持获取观众的封禁状态。
修改 ListUserBehaviorDataAPIV2返回参数新增 InviterName、InviterId、CheckInNumber,支持获取分享人的昵称、分享人的用户 ID 和观众签到的次数。数据统计 > 观众行为数据
新增 GetViewingRestrictionInfo2024-09-06支持改、查以下观看限制的配置信息:公开、密码、白名单、自定义、手机号。观看页管理 > 观看限制
新增 UpdateViewingRestriction
新增 InsertWhiteList当观看限制被设置为白名单时,支持增、删、查观众白名单。
新增 GetWhiteList
新增 DeleteWhiteList
新增 InsertPhoneList当观看限制被设置为手机号且开启白名单模式功能时,支持增、删、查白名单手机号。
新增 GetPhoneList
新增 DeletePhoneList

2024 年 8 月

发布时间

API/回调

说明

相关文档

2024-08-20

ListActivityUsers

新增获取实时观众列表接口

获取实时观众列表

2024-08-20

GetCheckInListAPI

返回参数新增 DeadlineSecond、CannotWathcLiveWhenNotCheckIn、SendType 和 AutoSendTime。

获取直播间签到列表

2024 年 7 月

发布时间

API/回调

说明

相关文档

2024-07-23

GetLoginLivesaasSts

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

获取企业直播 STS 签名

2024-07-23

ActivityClickReservationCallBack

新增直播预约点击回调

直播预约点击回调

2024-07-23

GenerateActivityStreamSlice

新增生成直播流切片接口

生成直播流切片

2024-07-23

GetActivityReservationAPIV2

请求参数新增 NickName 和 ExternalId

获取直播预约信息

2024-07-23

ListActivityMediaAPI

请求和返回参数 SourceType 新增取值 4

获取媒资库视频信息

2024-07-23

ListMediasAPI

返回参数 SourceType 新增取值 4

获取回放文件列表

2024-07-04

CreateLiveChannelConfig

新增新增直播频道接口

新增直播频道

2024-07-04

DeleteLiveChannelConfig

新增删除直播频道接口

删除直播频道

2024-07-04

UpdateLiveChannelConfig

新增更新直播频道接口

更新直播频道

2024-07-04

ListLiveChannelConfig

新增获取直播频道信息列表接口

获取直播频道信息列表

2024 年 6 月

发布时间

API/回调

说明

相关文档

2024-06-27

AddActivityPartnerRebroadcast

新增添加伴侣转播直播间接口

添加伴侣转播直播间

2024-06-27

DeleteActivityPartnerRebroadcast

新增删除伴侣转播直播间接口

删除伴侣转播直播间

2024-06-27

GetActivityPartnerRebroadcast

新增获取伴侣转播直播间信息接口

获取伴侣转播直播间信息

2024-06-27

GetDownloadLiveClient

新增获取直播伴侣一键开播跳转地址接口

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

2024-06-26

  • UpdateActivityBasicConfigAPI
  • CreateActivityAPIV2

请求参数新增 IsAutoEndEnable 和EndTime

2024-06-26

  • GetActivityBasicConfigAPI
  • GetActivityAPI

返回参数新增 IsAutoEndEnable 和EndTime

2024-06-19

MediaCut

新增剪辑视频接口

剪辑视频

2024-06-19

MediaCutResultCallBack

新增剪辑视频结果回调

剪辑视频结果回调

2024-06-19

UpdateLoopVideos

新增更新视频轮播配置信息接口

更新视频轮播配置信息

2024-06-19

UpdateLoopVideoStatus

新增更新视频轮播的开启状态接口

更新视频轮播的开启状态

2024-06-19

ListLoopVideos

新增获取视频轮播配置信息接口

获取视频轮播配置信息

2024-06-19

ListPrograms

新增获取节目单列表接口

获取节目单列表

2024-06-19

UpdateProgram

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

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

2024-06-19

DeleteProgram

新增删除节目单接口

删除节目单

2024-06-19

UpdateFloatingAdvertisement

新增更新浮标广告配置信息接口

更新浮标广告配置信息

2024-06-19

UpdateHostAccount

新增新增或更新主播账号信息接口

新增或更新主播账号信息

2024-06-19

DeleteHostAccount

新增删除主播账号接口

删除主播账号

2024-06-19

UpdateActivityHostAccount

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

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

2024-06-19

ListHostAccounts

新增获取主播账号列表接口

获取主播账号列表

2024-06-19

GetBusinessAccountInfo

新增获取直播间的关联主播账号信息接口

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

2024-06-19

GetAudienceGroupConfig

新增获取直播分组配置信息接口

获取直播分组配置信息

2024-06-19

UpdateAudienceGroupConfig

新增更新直播分组配置信息接口

更新直播分组配置信息

2024-06-19

ListAudienceGroupUser

新增获取直播分组的观众信息列表接口

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

2024-06-19

UpdateAudienceGroupUserConfig

新增更新观众的直播分组接口

更新观众的直播分组

2024-06-19

AddAudienceGroup

新增新增直播分组接口

新增直播分组

2024-06-19

ModifyAudienceGroup

新增更新直播分组接口

更新直播分组

2024-06-19

DeleteAudienceGroup

新增删除直播分组接口

删除直播分组

2024-06-19

  • GetTopChatAPI
  • GetHotChatAPI
  • PollingChatAPI
  • PresenterChatAPIV2

请求和返回参数新增 AudienceGroupId

2024-06-19

  • ListTeachAssistantAccounts
  • DeleteTeachAssistantAccount

返回参数新增 AudienceGroupIds

2024-06-19

UpdateTeachAssistantAccount

请求和返回参数新增 AudienceGroupIds

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

2024-06-19

GetActivityCommentConfig

返回参数新增 IsSendCommentEnable

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

2024-06-19

UpdateActivityCommentConfig

请求参数新增 IsSendCommentEnable

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

2024 年 5 月

发布时间

API/回调

说明

相关文档

2024-05-21

SendCustomSystemMessageAPI

请求参数新增 MessageType

发送自定义系统消息

2024 年 4 月

发布时间

API/回调

说明

相关文档

2024-04-28

UpdateVodPlayerConfig

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

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

2024-04-28

DeleteVodPlayerConfig

新增删除点播播放器接口

删除点播播放器

2024-04-28

UpdateDefaultVodPlayerConfig

新增设置默认点播播放器接口

设置默认点播播放器

2024-04-28

ListVodPlayerConfig

新增获取点播播放器配置信息接口

获取点播播放器配置信息

2024-04-28

GetVodPlayerConfig

新增获取点播播放器列表接口

获取点播播放器列表

2024-04-28

GetVodPlayerToken

新增获取点播播放器 Token 接口

获取点播播放器 Token

2024-04-28

GetVideoLibraryFolderTree

新增获取视频库分类信息(包含子分类)接口

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

2024-04-28

SearchVideoLibraryFolderTree

新增获取视频库分类信息(不包含子分类)接口

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

2024-04-28

ListActivityMediaAPI

请求参数新增 FolderId、IncludeSubFolder,返回参数新增 VideoWidth、VideoHeight、FolderName、FolderId

获取媒资库视频信息

2024-04-28

TempToMediaActivityMediaAPI

请求参数新增 FolderId

直播暂存转存视频库

2024-04-28

QueryUploadMediaByURL

返回参数新增 FolderId

获取批量上传视频的结果

2024-04-28

UploadMediaByURL

请求参数新增 FolderId

批量上传视频至媒资库

2024-04-23

GetActivityLinks

新增获取直播间链接信息接口

获取直播间链接信息

2024-04-23

ListAwardConfigs

新增获取直播间实时抽奖配置信息接口

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

2024-04-23

ListAwardRecordStatistics

新增获取直播间实时抽奖参与或中奖名单接口

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

2024-04-23

ActivityAwardInfoCallBack

新增 AwardId 和 Name 参数

实时抽奖结果回调

2024-04-12

ExplainProduct

新增更新卡片浮窗展示状态接口

更新卡片浮窗展示状态

2024-04-02

ListAccountActivityData

返回参数新增 LiveCount、LivePromotionLiveCount、LivePromotionLiveDuration、LivePromotionPlatformCount、AppTemplateLiveCount 和 AppTemplateLiveDuration

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

2024 年 3 月

发布时间

API/回调

说明

相关文档

2024-03-14

GetActivityCommentConfig

新增获取聊天互动菜单基础配置信息接口

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

2024-03-14

UpdateActivityCommentConfig

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

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

2024-03-14

ListActivityCustomEmojiSets

新增获取自定义表情专辑列表接口

获取自定义表情专辑列表

2024-03-14

GetActivityCustomEmojiSetDetail

新增获取自定义表情专辑详情接口

获取自定义表情专辑详情

2024-03-14

ModifyActivityCustomEmojiSets

新增更新自定义表情专辑排序接口

更新自定义表情专辑排序

2024-03-14

DeleteActivityCustomEmojiSet

新增删除自定义表情专辑接口

删除自定义表情专辑

2024-03-14

CreateOrUpdateActivityCustomEmojiSet

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

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

2024-03-14

UpdateActivityCustomEmojiSetStatus

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

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

2024-03-14

UpdateSecurityControlConfig

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

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

2024-03-14

GetSecurityControlConfig

新增获取直播间安全管控配置信息接口

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

2024-03-14

GetCheckInListAPI

返会参数新增 IsSendComment 和 CommentContent

获取直播间签到列表

2024-03-01

ListUserBehaviorDataAPIV2

返回参数新增 UserCredit

获取观众行为数据信息

2024-03-01

GetAdvertisementDataDetailAPI

新增获取直播间营销推广点击数据接口

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

2024 年 2 月

发布时间

API/回调

说明

相关文档

2024-02-23

  • ListTeachAssistantAccounts
  • UpdateTeachAssistantAccount
  • DeleteTeachAssistantAccount

返回参数新增 OneStepLoginUrl

2024-02-20

PresenterChatAPIV2

升级接口至 V2 版本

主持人发言

2024-02-01

GetTeachAssistantConfig

新增获取直播助教平台的页面设置接口

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

2024-02-01

UpdateTeachAssistantConfig

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

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

2024-02-01

ListTeachAssistantAccounts

新增获取直播助教账号信息列表接口

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

2024-02-01

UpdateTeachAssistantAccount

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

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

2024-02-01

DeleteTeachAssistantAccount

新增删除直播助教账号接口

删除直播助教账号

2024 年 1 月

发布时间

API/回调

说明

相关文档

2024-01-16

  • ListQuizStatisticsAPI
  • ListRedPacketDataAPI
  • ListQuestionnaireDataAPIV2

返回参数新增 IsDelete

2023 年 12 月

发布时间

API/回调

说明

相关文档

2023-12-13

UpdateAttentionDetectionConfig

新增更新认真度检测配置信息接口

更新认真度检测配置信息

2023-12-13

GetAttentionDetectionConfig

新增获取认真度检测配置信息接口

获取认真度检测配置信息

2023-12-13

ListUserBehaviorDataAPIV2

返回参数新增 ShiftScreenNumber、MuteNumber 和 NoInteractNumber

获取观众行为数据信息

2023 年 11 月

发布时间

API/回调

说明

相关文档

2023-11-23

GetAccountAggregatedStatistics

新增获取主账号下的核心统计数据接口

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

2023-11-23

ListAccountActivityData

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

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

2023-11-23

ListAccountUserData

新增获取主账号下的用户画像数据接口

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

2023-11-23

GetAccountUserTrackData

新增获取观众的用户画像详情接口

获取观众的用户画像详情

2023 年 9 月

发布时间

API/回调

说明

相关文档

2023-09-22

GetActivityProducts

新增获取商品卡片菜单的配置信息接口

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

2023-09-22

UpdateActivityProduct

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

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

2023-09-22

DeleteActivityProduct

新增删除商品卡片菜单接口

删除商品卡片菜单

2023-09-22

GetActivityEmbeddedUrls

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

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

2023-09-22

UpdateActivityEmbeddedUrl

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

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

2023-09-22

DeleteActivityEmbeddedUrl

新增删除内嵌链接菜单接口

删除内嵌链接菜单

2023-09-22

GetActivityBands

新增获取图文介绍菜单的配置信息接口

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

2023-09-22

UpdateActivityBand

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

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

2023-09-22

DeleteActivityBand

新增删除图文介绍菜单接口

删除图文介绍菜单

2023-09-22

GetActivityMenus

新增获取菜单列表接口

获取菜单列表

2023-09-22

ModifyActivityMenus

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

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

2023 年 8 月

发布时间

API/回调

说明

相关文档

2023-08-03

  • GetCustomActMsgAPI
  • ListActivityByCacheAPI
  • ListActivityAPI

返回参数新增 VerticalCoverImage

2023-08-03

ActivityBasicConfigModifyCallBack

新增 VerticalCoverImage 参数

保存基础配置时回调

2023 年 7 月

发布时间

API/回调

说明

相关文档

2023-07-20

GetTaskAwardItemListAPI

返回参数新增 AwardStartTime 和 AwardEndTime

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

2023-07-20

GetAwardConfigListAPI

返回参数新增 AwardTheme

获取直播间实时抽奖奖品列表

2023-07-20

  • ActivityModifyCallBack
  • ActivityBasicConfigModifyCallBack

新增 ActivityTags 参数

2023-07-20

ListQuestionnaireAnswerDataAPIV2

返回参数新增 ExternalId

获取直播间问卷数据信息

2023-07-07

MediaMergeResultCallBack

新增合并回放文件结果回调

合并回放文件结果回调

2023-07-07

MediasMergeAPI

新增合并回放文件接口

合并回放文件

2023-07-04

UpdateActivityBasicConfigAPI

请求参数新增 UseDefaultThumbUpEffect 和 ThumbUpEffectUrls

更新直播页面基础信息

2023-07-04

GetActivityBasicConfigAPI

返回参数新增 UseDefaultThumbUpEffect 和 ThumbUpEffectUrls

获取直播页面基础信息

2023 年 6 月

发布时间

API/回调

说明

相关文档

2023-06-15

UpdateActivityBasicConfigAPI

请求参数新增 IsReservationSmsEnable 和 AutoReservationWindowEnable

更新直播页面基础信息

2023-06-15

GetActivityBasicConfigAPI

返回参数新增 IsReservationSmsEnable 和 AutoReservationWindowEnable

获取直播页面基础信息

2023-06-15

UpdateActivityViewPermissionAPI

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

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

2023-06-15

DeleteMediaLibraryVideoAPI

新增批量删除媒资库视频文件接口

批量删除媒资库视频文件

2023-06-15

ActivityReservationInfoCallBack

新增 ViewUrl 和 LiveTime 参数

直播预约结果回调

2023-06-15

GetActivityProductAPI

返回参数新增 DisplayEnable

获取商品卡片配置

2023-06-15

UpdateActivityProductAPI

请求参数新增 DisplayEnable

更新商品卡片配置

2023-06-05

ListRedPacketDataAPI

返回参数新增 RedPacketType 和 RewardsPointsUnit

获取直播间红包列表

2023-06-05

ListRedPacketRecordAPI

返回参数新增 IsPriorityUser

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

2023-06-05

ActivityRedPacketInfoCallBack

新增红包结果回调

红包结果回调

2023 年 5 月

发布时间

API/回调

说明

相关文档

2023-05-18

GetActivityProductAPI

返回参数新增 DefaultRedirectImage

获取商品卡片配置

2023-05-18

UpdateActivityProductAPI

请求参数新增 DefaultRedirectImage

更新商品卡片配置

2023-05-18

GetCustomViewingRestrictionInfoAPI

返回参数新增 ErrorRedirectUrl

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

2023-05-18

UpdateCustomizationViewPermissionAPI

请求参数新增 ErrorRedirectUrl

修改直播间观看限制/评论限制中自定义观看的登录链接

2023-05-11

UpdateActivityBasicConfigAPI

请求参数新增 PcLoginBackgroundImageUrl 和 MobileLoginBackgroundImageUrl

更新直播页面基础信息

2023-05-11

GetActivityBasicConfigAPI

返回参数新增 PcLoginBackgroundImageUrl 和 MobileLoginBackgroundImageUrl

获取直播页面基础信息

2023-05-11

ActivityAutoReplayCallBack

新增直播回放回调

直播回放回调

2023 年 4 月

发布时间

API

说明

相关文档

2023-04-27

GetActivityProductAPI

返回参数新增 ProductsPosition

获取卡片配置

2023-04-27

UpdateActivityProductAPI

请求参数新增 ProductsPosition

更新卡片配置

2023-04-20

  • CreateActivityAPIV2
  • UpdateActivityBasicConfigAPI

请求参数新增 VerticalCoverImage

2023-04-20

  • GetActivityBasicConfigAPI
  • GetActivityAPI

返回参数新增 VerticalCoverImage

2023-04-13

GetActivityMenuAPI

返回参数 Type 取值变更

获取菜单栏列表

2023-04-04

GetAwardConfigListAPI

返回参数新增 AwardItemType、TaskAwardIcon、AwardItemNum、AwardItemAmounts、AwardLotteryTicketAddr、AwardCondition

获取直播间实时抽奖奖品列表

2023-04-04

GetAwardRecordStatisticsAPI

返回参数新增 IsPriorityUser

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

2023 年 3 月

发布时间

API

说明

相关文档

2023-03-23

CreateActivityAPIV2

请求参数新增 LiveMode

创建直播间

2023-03-23

  • ListActivityAPI
  • ListActivityByCacheAPI

请求参数和返回参数新增 LiveMode

2023-03-23

ListUserBehaviorDataAPIV2

请求参数 PlayStatus 取值变更

获取观众行为数据信息

2023-03-23

GetActivityAPI

返回参数新增 LiveMode

获取直播基础信息

2023-03-16

GetCustomViewingRestrictionInfoAPI

新增获取直播间自定义观看限制配置信息接口

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

2023 年 2 月

发布时间

API/回调

说明

相关文档

2023-02-24

ListUserBehaviorDataAPIV2

请求和返回参数新增 ScrollId

获取观众行为数据信息

2023-02-24

ListUserSubmitEnterReviewAPI

请求和返回参数新增 Extra

获取用户填写的报名信息

2023-02-24

GetStreamsAPI

返回参数新增 Ratio

获取直播流信息

2023-02-24

ActivityAwardInfoCallBack

新增 Telephone 参数

实时抽奖结果回调

2023-02-16

GetActivityAPI

返回参数新增 LiveReviewStatus

获取直播基础信息

2023-02-16

  • ListActivityAPI
  • ListActivityByCacheAPI

请求参数和返回参数新增 LiveReviewStatus

2023-02-07

  • ListActivityAPI
  • ListActivityByCacheAPI

请求参数新增 Name

2023 年 1 月

发布时间

API/回调

说明

相关文档

2023-01-31

GetVoteListAPI

新增获取直播间投票列表信息接口

获取直播间投票列表信息

2023-01-31

GetVoteStatisticsAPI

新增获取直播间投票数据接口

获取直播间投票数据

2023-01-31

GetAwardConfigListAPI

新增获取直播间实时抽奖奖品列表接口

获取直播间实时抽奖奖品列表

2023-01-31

GetAwardRecordStatisticsAPI

新增获取直播间实时抽奖参与或中奖名单接口

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

2023-01-31

GetTaskAwardItemListAPI

新增获取直播间累计观看抽奖奖品列表接口

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

2023-01-31

GetTaskAwardRecordStatisticsAPI

新增获取直播间累计观看抽奖的参与或中奖名单接口

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

2023-01-31

ListRedPacketDataAPI

新增获取直播间红包列表接口

获取直播间红包列表

2023-01-31

ListRedPacketRecordAPI

新增获取直播间红包参与或中奖名单接口

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

2023-01-31

GetCheckInListAPI

新增获取直播间签到列表接口

获取直播间签到列表

2023-01-31

GetCheckInRecordStatisticsAPI

新增获取直播间签到名单接口

获取直播间签到名单

2023-01-31

GetAccountTemplateAPI

新增获取直播模板列表接口

获取直播模版列表

2023-01-31

UpdateAccountTemplateStatusAPI

新增更新直播模版状态接口

更新直播模版状态

2023-01-31

UpdateDefaultTemplateStatusAPI

新增更新默认直播模版接口

更新默认直播模版

2023-01-31

ListQuizStatisticsAPI

新增获取直播间答题列表接口

获取直播间答题列表

2023-01-31

GetQuizDataAPI

新增获取直播间答题详情接口

获取直播间答题详情

2023-01-31

ListQuizRecordAPI

新增获取直播间答题参与名单接口

获取直播间答题参与名单

2023-01-31

ListUserSubmitEnterReviewAPI

返回参数新增 UserAgent、ExternalId、UserTel、Ip、Email、UserForm、WatchActivityTime 和 IsWatchLive

获取用户填写的报名信息

2023-01-31

ActivityStatusModifyCallBack

新增 IsLockPreview 参数

直播状态回调

2023-01-31

  • GetPageWatchDataAPIV2
  • GetActivityReservationAPIV2
  • ListQuestionnaireDataAPIV2
  • ListQuestionnaireAnswerDataAPIV2
  • AnalysisUserBehaviorPeopleV2
  • GetAdvertisementDataAPIV2
  • ListUserBehaviorDataAPIV2

升级接口至 V2 版本,新增 Channel 参数,同时删除了原有的 Source 参数

2023-01-31

ListChannelAPI

新增获取直播间的渠道信息列表接口

获取直播间的渠道列表

2023-01-12

  • PollingChatAPI
  • GetHotChatAPI
  • GetTopChatAPI

返回参数新增 IsTipOff

2022 年 12 月

发布时间

API

说明

相关文档

2022-12-20

DelActivityAntidirtAPI

请求参数新增 DeleteAll

删除敏感词

2022-12-8

GetActivityProductAPI

返回参数新增 EnableMiniApp 和 MiniAppId

获取卡片配置

2022-12-8

UpdateActivityProductAPI

请求参数新增 EnableMiniApp 和 MiniAppId

更新卡片配置

2022-12-8

GetSDKTokenAPI

请求参数新增 CustomComment

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

2022 年 11 月

发布时间

回调

说明

相关文档

2022-11-30

评论回调

新增评论回调

评论回调

2022-11-22

ActivityReservationInfoCallBack

新增直播预约结果回调

直播预约结果回调

2022-11-22

ActivityAwardInfoCallBack

新增实时抽奖结果回调

实时抽奖结果回调

2022 年 10 月

发布时间

API

说明

相关文档

2022-10-31

ListUserBehaviorDataAPI

返回参数新增 SilenceStatus

获取观众行为数据信息

2022 年 9 月

发布时间

API

说明

相关文档

2022-09-16

  • UpdateActivityEmbeddedUrlAPI
  • GetActivityEmbeddedUrlAPI

新增更新和获取内嵌链接菜单接口

2022-09-15

  • CreateActivityAPIV2
  • ListActivityAPI
  • UpdateActivityBasicConfigAPI
  • GetActivityBasicConfigAPI
  • UpdateSiteTagAPIV2
  • ListSiteTagAPIV2

接口新增查询或更新分类标签和文本标签

2022-09-15

ListActivityByCacheAPI

新增非实时查询直播间列表信息接口

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

2022-09-15

GetCustomActMsgAPI

新增自定义查询直播间信息接口

自定义查询直播间信息

2022-09-06

GetUserTaskAwardResultAPI

新增查询观众奖券奖品中奖情况接口

查询观众奖券奖品的中奖情况

2022-09-06

ListPosterInviteAPI

新增获取邀请榜单数据接口

获取邀请榜单数据

2022 年 8 月

发布时间

API

说明

相关文档

2022-08-15

  • ListSiteTagAPI
  • UpdateSiteTagAPI

新增获取和更新直播间标签信息相关接口

2022-08-12

ListHostAccountAPI

新增获取主播账号列表接口

获取主播账号列表

2022-08-12

GetBusinessAccountInfoAPI

新增获取直播间的主播/品牌方信息接口

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

2022 年 7 月

发布时间

API

说明

相关文档

2022-07-29

  • ListUserSubmitEnterReviewAPI
  • ReviewUserEnterFormAPI

新增直播报名相关接口

2022-07-29

SendCustomSystemMessageAPI

新增发送自定义系统消息接口

发送自定义系统消息

2022-07-29

GetActivityReservationAPI

新增获取直播预约信息接口

获取直播预约信息

2022-07-29

  • TempToMediaActivityMediaAPI
  • ListActivityMediaAPI

新增直播暂存转存视频库及获取
媒资库视频文件接口

2022-07-15

  • AddActivityAntidirtAPI
  • DelActivityAntidirtAPI
  • GetActivityAntidirtAPI

新增敏感词的增删查接口

2022-07-13

  • AddLivePromotionsAPI
  • DeleteLivePromotionsAPI
  • ListLivePromotionsAPI
  • UpdateLivePromotionsStatusAPI

新增直播推广的增删查改接口

  • 批量添加直播推广自定义平台
  • 删除直播推广的自定义平台
  • 更新直播推广状态
  • 获取直播推广的平台列表

2022 年 6 月

发布时间

API

说明

相关文档

2022-06-30

GetWebPushLiveClientAPI

新增获取网页直播一键开播跳转地址接口

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

2022 年 5 月

发布时间

API

说明

相关文档

2022-05-25

GetTemporaryLoginTokenAPI

新增获取直播间临时登录密钥接口

获取临时登录密钥

2022-05-25

AnalysisUserBehaviorPeople

新增获取直播间不同观看时长人数接口

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

2022-05-17

GetDownloadLiveClientAPI

新增获取直播伴侣一键开播跳转地址接口

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

2022 年 4 月

发布时间

API

说明

相关文档

2022-04-17

  • EnableProductAPI
  • ExplainProductAPI

新增修改卡片上下架及浮窗展示状态接口

2022-04-12

  • UploadMediaByURL
  • QueryUploadMediaByURL

新增批量上传视频及查询上传结果接口

2022 年 3 月

发布时间

API

说明

相关文档

2022-03-29

  • CreateActivityAPIV2
  • DeleteActivityAPI
  • ListActivityAPI

新增直播间的增删查接口

2022-03-29

UpdateActivityAPI

新增变更直播间状态接口

变更直播间状态

2022-03-29

UpdatePullToPushAPI

新增修改直播间拉流状态接口

开始/关闭拉流

2022-03-29

  • GetActivityAPI
  • GetStreamsAPI

新增获取直播间和直播流信息接口

2022-03-25

  • UpdateActivityBasicConfigAPI
  • GetActivityBasicConfigAPI

新增直播页面配置与查询接口

2022-03-25

  • UpdateLoopVideoAPI
  • UpdateLoopVideoStatusAPI

新增轮播的配置与开启/关闭接口

  • 编辑轮播
  • 开启/关闭轮播

2022-03-25

  • UploadReplayAPI
  • ListMediasAPI
  • UpdateMediaOnlineStatusAPI

新增回放管理相关接口

2022-03-22

  • GetPageWatchDataAPI
  • GetAdvertisementDataAPI
  • ListUserBehaviorDataAPI
  • ListQuestionnaireAnswerDataAPI
  • ListQuestionnaireDataAPI
  • ListAnActivityStartAndEndTimeAPI

新增数据查询相关接口

2022-03-22

  • PresenterChatAPI
  • PollingChatAPI
  • GetHotChatAPI
  • GetTopChatAPI
  • DeleteChatAPI
  • LikeChatAPI
  • TopChatAPI
  • EmptyChatAPI
  • UpdateChatReviewStatusAPI
  • ConfirmReviewChatAPI
  • SilenceUserAPI
  • GetSilenceUserListAPI

新增评论设置相关接口

2022-03-21

  • GetActivityMenuAPI
  • UpdateActivityMenuAPI
  • GetActivityProductAPI
  • UpdateActivityProductAPI
  • DeleteGraphicMessageAPI
  • UpdatePresenterNameAPI
  • UpdateBulletScreensSwitchAPI

新增菜单栏控制相关接口

2022-03-18

UpdateCustomizationViewPermissionAPI

新增观看限制接口

修改直播间观看限制/评论限制中自定义观看的登录链接

2022-03-18

GetSDKTokenAPI

新增获取观众进入直播间的授权
Token接口

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

最近更新时间:2026.10.20 14:28:22
这个页面对您有帮助吗?
有用
有用
无用
无用