开放平台
首页平台概述
开发者文档
  • 接入指南
  • 集成方案
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者文档
  • 接入指南
  • 集成方案
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. 服务端API
  • 平台概述
  • 动态与公告
  • 接入指南
    • 业务流程
    • 接入指南
    • 开通账号/权限
    • 基础概念说明
  • 系统集成
    • 轻量化集成方案
    • 定制化集成方案
  • 内嵌场景指南
    • 直播观看嵌入指南
      • 产品介绍
      • 嵌入说明
      • 嵌入示例
      • 嵌入页消息推送
      • 微信小程序嵌入说明
      • 嵌入模式支付对接
      • 嵌入页第三方K值验证
    • 聚合站点嵌入指南
      • 聚合页嵌入指南
      • 小程序嵌入指南
      • 创建三方用户「站点专用」
      • 更新三方用户「站点专用」
    • 直播管理嵌入指南
      • 产品介绍
      • 嵌入说明
      • 嵌入示例
    • 授权服务
      • 获取观众登录Token
      • 获取控制台登陆Token
      • 获取控制台免登录地址
    • APP嵌入指南
      • 支付方式唤起说明
      • 商品配置说明
  • 服务端API
    • 产品介绍
    • 更新记录
    • 接入必读
      • 快速接入
      • 签名示例
      • 全局状态码
      • 调用频率说明
    • 账号管理
      • 子账号角色
        • 创建子账号角色
        • 获取子账号角色列表
        • 获取子账号角色详情
      • 子账号管理
        • 创建子账号
        • 更新子账号信息(含角色绑定)
        • 获取子账号个数
        • 获取子账号列表
        • 获取子账号详情
        • 创建子账号应用信息
        • 主账号套餐资源下发​
      • 三方用户管理
        • 创建三方用户
        • 更新三方用户
        • 获取微吼用户ID
        • 获取第三方用户ID
    • 活动中心
      • 标签管理
        • 创建标签
        • 删除标签
        • 更新标签
        • 置顶标签
        • 获取标签列表
        • 批量查询活动标签
        • 活动标签列表排序重置
      • 活动管理
        • 创建活动
        • 创建活动(点播/定时直播)
        • 删除活动
        • 修改活动信息
        • 活动列表接口
        • 获取活动详情
        • 批量获取活动详情
        • 获取活动场次列表
        • 获取当前视频分辨率详情(定时直播)
      • 多语言管理
        • 创建活动语种
        • 删除活动语种
        • 修改活动语种
        • 查询活动语种列表
      • 角色权限
        • 角色邀请开关
        • 角色名称修改
        • 角色密码修改
        • 角色权限修改
        • 获取活动角色配置
        • 取消嘉宾/助理身份
        • 设置主持人身份信息
        • 获取B端用户参会地址
      • 观看限制
        • 全局踢出
          • 批量移除全局踢出观众
          • 查询全局踢出观众列表
          • 新增/编辑全局踢出观众
        • 观众组管理
          • 创建观众组
          • 指定观众组添加新用户
          • 获取观众组分组列表
          • 获取观众组下用户列表
          • 批量移除观众组用户
        • 平台观看限制
          • 设置活动观看限制
          • 查询活动观看限制
        • 外部观众鉴权
          • 外部观众获取活动票据-生成ticket
        • 第三方K值鉴权
          • 设置全局K值鉴权
          • 设置单个活动K值鉴权
          • 删除活动下的k_id
          • 设置活动多K值校验
          • 查询多K值详情列表
          • 查询活动K值详情配置
      • 互动管理
        • 问答
          • 设置问答名称
          • 获取问答名称
          • 删除问答记录
          • 批量删除问答记录
          • 获取问答管理页面
        • 聊天
          • 批量添加聊天屏蔽词
          • 批量删除聊天屏蔽词
          • 清空聊天屏蔽词
          • 修改聊天屏蔽词
          • 获取聊天屏蔽词列表
          • 保存聊天严禁词配置
          • 获取聊天严禁词配置
          • 删除聊天消息
          • 批量删除聊天消息
          • 发送自定义消息
          • 获取直播聊天过滤页面
          • 设置/取消全体用户禁言
          • 获取活动禁言详情
          • 聊天机器人消息发送
        • 签到
          • 获取进行中的签到任务
          • 创建并配置签到推送
          • 批量删除签到记录
          • 结束签到
          • 获取签到详情
        • 礼物
          • 修改礼物
          • 创建活动礼物
          • 创建礼物
          • 删除礼物
          • 活动关联礼物
          • 获取礼物发送记录
          • 获取礼物收益
          • 观看端_获取活动使用的礼物列表
          • 设置活动下礼物排序
          • 设置活动下礼物是否展示
          • 账号下礼物列表
        • 在线抽奖
          • 抽奖管理
            • 创建或更新抽奖信息
            • 保存或更新抽奖条件与中奖用户设置
            • 保存或更新领奖页设置
            • 复制抽奖
            • 删除抽奖
          • 奖品管理
            • 创建或更新奖品
            • 批量删除活动下奖品
            • 保存抽奖奖品设置
            • 获取活动下奖品信息
            • 获取活动的奖品列表
          • 获取抽奖详情信息
            • 获取抽奖条件和用户设置
            • 获取抽奖配置基本信息
            • 获取抽奖领奖页设置
            • 获取活动下抽奖列表
          • 推送抽奖
            • 推送抽奖
          • 结束抽奖
            • 结束抽奖
        • 报名表单
          • 报名审核-批量审核
        • 推屏卡片
          • 创建推屏卡片
          • 发起端-导出点击列表
          • 发起端-推送推屏卡片
          • 发起端-获取推送中的卡片 ID
          • 复制推屏卡片
          • 批量删除推屏卡片
          • 编辑推屏卡片
          • 获取推屏卡片列表
          • 获取推屏卡片点击数据
      • 观看页设置
        • 品牌设置
          • 获取活动标识
          • 设置活动标识
        • 观看协议
          • 保存观看协议
          • 获取观看协议
          • 观看端-用户同意观看协议
          • 观看端-获取观看协议
        • 虚拟人数
          • 增加虚拟人数
          • 获取虚拟观众基数
        • 开屏海报
          • 获取开屏海报设置
          • 设置开屏海报
        • 公众号展示
          • 公众号展示设置
          • 获取公众号设置
        • 功能开关配置
          • 活动配置开关获取
          • 设置功能开关
    • 转推流设置
      • 活动开关播
        • 开始直播
        • 结束直播
      • 平台推流到三方
        • 获取活动下已添加推流地址列表
        • 创建三方推流地址
        • 删除三方推流地址
        • 编辑三方推流地址
        • 开启/关闭三方推流
      • 平台拉流并开播
        • 拉流并开播
      • 获取当前活动推流状态
        • 获取直播间流状态
      • 获取当前活动推流地址
        • 获取直播间推流地址
    • 播放器设置
      • 其他信息设置
      • 获取其他信息设置
      • 水印设置
      • 获取水印设置
      • 跑马灯设置
      • 获取跑马灯设置
    • 回放管理
      • AI创作
        • 获取智能字幕详情
        • 提交智能字幕解析任务
        • 智能字幕-编辑及保存
      • 保存章节-章节打点
      • 创建回放
      • 删除点播与章节关联-章节打点
      • 回放列表
      • 回放删除
      • 回放加密
      • 回放编辑
      • 回放重制
      • 查询章节信息-章节打点
      • 获取回放时长
      • 获取录制文件信息
      • 裁剪回放
      • 设置默认回放
      • 回放下载接口
      • 获取回放分辨率信息
      • 回放清晰度转换接口
      • 获取回放下载信息
    • 专题管理
      • 创建专题
      • 删除专题
      • 修改专题
      • 获取专题列表
      • 获取专题详情接口(专题预览)
    • 营销设置
      • 渠道管理
        • 创建/编辑渠道信息
        • 删除渠道信息
        • 查询活动绑定渠道信息
        • 查询渠道信息列表
        • 活动绑定渠道
        • 活动解绑渠道
        • 选择渠道列表
    • 商品中心
      • 商品池
        • 创建商品
        • 更新商品
        • 商品详情
        • 商品列表
        • 复制商品
        • 批量删除
      • 活动商品
        • 获取当前活动未关联商品
        • 活动关联商品
        • 活动商品列表
        • 批量删除活动商品
        • 活动商品上架设置
        • 设置活动商品排序
        • 设置活动商品销售状态
        • 设置活动商品推送状态
        • 获取活动下商品统计数据
      • 优惠券
        • 优惠券作废
        • 优惠券创建
        • 优惠券批量删除
        • 优惠券数据总览
        • 优惠券更新
        • 活动下优惠券批量删除
        • 活动下优惠券新增
        • 用券商品列表
        • 获取优惠券下商品列表
        • 获取优惠券信息
        • 获取优惠券列表
        • 获取活动下优惠券列表
        • 领用券用户列表
      • 订单管理
        • 查询订单列表
        • 获取订单详情
        • 活动订单设置
        • 查询活动订单设置
    • 媒资中心
      • 图片上传
        • 图片上传
      • 文档管理
        • 删除文档
        • 获取文档详情
        • 获取文档章节
        • 获取活动下的文档列表
        • 上传文档
        • 活动关联文档
      • 音视频管理
        • 视频预览
        • 音视频删除
        • 音视频修改
        • 音视频列表
        • 音视频详情
    • 数据统计
      • 互动数据
        • 基础统计
          • 预约
            • 活动预约列表
          • 报名表单
            • 获取报名表单记录
          • 邀请排名
            • 获取邀请榜
            • 获取邀请列表
            • 获取邀请卡详情
            • 邀请详情
          • 分享排名
            • 获取分享排名记录
        • 互动统计
          • 聊天
            • 获取历史聊天记录
          • 问答
            • 获取问答记录总数
            • 获取问答记录列表
          • 点赞
            • 获取房间的点赞数量
          • 快问快答
            • 获取快问快答成绩排行榜
            • 获取快问快答试卷统计列表
            • 获取快问快答题目统计信息
          • 问卷
            • 获取活动下问卷列表
            • 获取活动下问卷使用数据概览
            • 获取问卷ID对应问卷答案
            • 获取问卷提交人数
            • 获取问卷答案详情
          • 签到
            • 获取已推送的签到记录列表
            • 获取活动下已签到的用户记录
            • 获取活动签到统计列表
            • 签到用户列表接口(聚合表查询数据)
          • 现金红包
            • 获取红包发送记录
            • 获取红包领取列表
            • 获取活动下红包统计数据
          • 口令红包
            • 获取红包明细
            • 获取发送红包记录
            • 获取活动下红包统计数据
          • 打赏
            • 获取活动打赏列表
            • 获取活动打赏统计
          • 文件下载
            • 文档下载次数
            • 已下载资料数据列表
          • 连麦
            • 获取用户上麦记录
      • 活动维度数据
        • 数据报告
          • 活动统计信息
          • 观看人数趋势
        • 终端信息统计
          • 活动设备信息
          • 活动浏览器信息
        • 地理位置统计
          • 省份信息统计
          • 城市信息统计
        • 获取活动热度信息
          • 活动热度信息
        • 获取活动在线人数
          • 获取当前在线人数
          • 获取指定时间段内在线人数统计
        • 获取活动并发数据
          • 每天并发趋势
          • 获取当前活动最高并发
          • 获取指定时间段内活动最大并发
          • 获取当前活动指定时间段内最高并发
        • 获取用户观看明细
          • 获取用户观看明细(新)
          • 获取用户观看明细(旧)
      • 账号维度数据
        • 数据总览
        • 活动数据列表接口
        • 获取指定日期内最高并发
        • 获取指定时间段内并发数据
    • 开发设置
      • 回调事件说明
      • 回调事件列表
      • 回调事件管理
        • 回调事件查询接口
        • 回调事件修改接口
        • 回调事件创建接口
      • 回调事件汇总
        • 活动信息
          • 活动删除
          • 活动创建
          • 活动信息更新
        • 活动状态
          • 活动状态
          • 活动推流状态
          • 活动状态改变
          • 活动恢复预告
        • 回放
          • 生成回放
          • 裁剪回放
          • 回放分辨率
          • 回放下载
          • 回放重制
        • 媒资
          • 视频转码
          • 文档转码
          • 音视频转码进度
        • 订单
          • 订单状态变更
        • AI创作
          • 智能解析
        • 报名
          • 报名表单提交
        • 抽奖
          • 中奖结果通知
          • 抽奖管理
          • 复制抽奖
          • 推送抽奖
          • 结束抽奖
          • 抽奖奖品管理
        • 快问快答
          • 答题记录
        • 签到
          • 推送签到
          • 结束签到
          • 签到管理
        • 商城奖励
          • 领取奖励回调
        • 观看时长
          • 时长达标
        • 房间消息
          • 上下线消息
    • 财务中心
      • 套餐数据查询
        • 并发消费查询
          • 财务总览-并发-消费账单
        • 流量数据查询
          • 6.查询用户流量
          • 查询某段时间内流量使用情况
          • 财务总览-流量-消费账单
        • 时常数据查询
          • 查询每天用户时长使用量
          • 查询指定时间内时长使用情况
          • 财务总览-时长-消费账单
      • 短信数据查询
        • 获取一定时间内短信使用量
        • 获取指定时间内短信消耗总值
        • 财务总览-短信-消费账单-分页明细
  • SDK文档
    • DEMO示例
    • JS SDK
      • 产品介绍
      • 快速接入
      • SDK 对接示例
      • 观看直播
      • 暖场视频
      • 房间消息说明
      • 互动连麦
      • 文档白板
      • 全局事件
      • 全局错误码
      • 版本更新记录
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-聊天
        • 互动-优惠券
        • 互动-点赞
      • 直播间拓展功能
        • 资料下载
        • 观看限制验证
        • 观看协议
        • 回放章节
      • 点播SDK
        • 点播上传SDK
        • 更新记录
    • iOS SDK
      • 整体介绍
      • 快速接入
      • SDK 登录
      • 暖场视频
      • 视频轮询
      • 直播彩排
      • 高级美颜
      • 云导播
      • 观看协议
      • 文档白板演示
      • 聊天功能
      • 视频直播
        • 发起视频直播
        • 观看视频直播
      • 互动直播
        • 观众互动
        • 推流摄像头
        • 互动直播API
        • 主播发起互动直播
        • 嘉宾加入互动直播
      • 无延迟直播
        • 主播发起无延迟直播
        • 观众观看无延迟直播
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-章节打点
        • 互动-公告
        • 互动-商品
        • 互动-计时器
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-优惠券
        • 互动-点赞
      • 直播间拓展能力
        • 直播间特色功能配置项
        • 文件下载
        • 修改角色昵称
        • 观看权限校验
        • 投屏
        • 虚拟人数
      • 观看回放
        • 观看回放
      • 防录屏
        • 跑马灯
      • 字段说明
        • 互动活动详情字段
        • 错误码说明
        • 常量定义
        • 活动详情字段说明
      • 版本更新说明
        • 版本更新信息
        • v2.3.0 到 v2.4.0 升级说明
        • v3.0.1 到 v3.2.0 升级说明
        • V2.9.0到v3.0.1升级说明
        • v6.3.0
        • v6.2.1
        • v3.2.0 到 v4.0.1
        • v2.7.0 到 v2.8.0、v2.9.0 升级说明
        • 6.5.0
        • v5.0.x 到 v6.0.0
        • v6.4.0
    • Adroid SDK
      • 整体介绍
      • 快速接入
      • SDK登录
      • 暖场视频
      • 视频轮巡功能
      • 直播彩排
      • 高级美颜
      • 云导播功能
      • 观看协议
      • 文档白板
      • 聊天功能
      • 房间消息
      • 信息采集说明
      • 视频直播
        • 发起视频直播
        • 观看视频直播
      • 互动直播
        • 互动直播API
        • 主播发起互动直播
        • 嘉宾加入互动直播
        • 观众观看互动直播
      • 无延迟直播
        • 主播发起无延迟直播
        • 观众观看无延迟直播
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-计时器
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-优惠券
        • 互动-点赞
      • 直播拓展功能
        • 修改角色名称
        • 文件下载
        • 投屏演示
        • 虚拟人数
        • 观看权限校验
        • 直播间特色功能配置项
      • 观看回放
        • 观看回放/点播
      • 防录屏
        • 直播水印
        • 跑马灯
      • 字段说明
        • 房间消息字段说明
        • 聊天消息字段说明
        • 活动详情字段说明
      • 更新记录
        • 更新记录
      • 版本更新说明
        • v6.4.0
        • v6.3.0
        • v6.2.3
        • v6.2.1
        • v6.2.0
        • v6.1.0
        • v6.0.0
        • v5.0.0
        • v4.1.0
        • v4.0.0
        • v3.3.0
    • Harmony SDK
    • 小程序 SDK
    • 相关协议
      • 微吼直播 SDK 隐私政策
      • 微吼直播 SDK 开发者使用规范
  • 常见问题
    • 平台兼容性说明
    • 直播筹备阶段
    • 直播执行阶段
    • 直播观看阶段
    • 内容数据沉淀阶段
    • 直播相关问题
    • 设备相关问题
    • 对接阶段问题
    • 点播回放相关问题
    • 自动播放策略说明
    • 视频直播OBS推流配置建议
    • 快直播OBS推流配置建议
    • 网络安全策略(防火墙配置)
  • 示例中心
  1. 服务端API

更新记录

API更新记录
日期更新概述更新内容
2023-09-281.新增直播活动渠道管理相关接口;
2.新增商品、优惠券及订单管理相关接口
技术文档调整如下:
1.渠道管理
2.商品/优惠券/订单管理
2023-07-261.直播支持设置实时字幕功能
2.新增推屏卡片互动功能
技术文档调整如下:
1.创建直播活动新增实时字幕
2.创建推屏卡片
3.获取推屏卡片点击数据
2022-12-211.新增快问快答数据查询接口
2.角色权限相关接口补充快问快答字段
技术文档调整如下:
1.获取快问快答成绩排行榜
2.获取快问快答试卷统计列表
3.角色权限修改
4.获取活动角色配置
2022-10-211.化蝶活动支持多k值验证
2.开放活动禁言接口
3.开放获取云导播活动机位推流地址接口
技术文档调整如下:
1.活动下创建多k值
2.设置/取消全体用户禁言
3.获取活动禁言详情
4.获取云导播机位推流地址
2022-07-06活动标签相关接口技术文档调整如下:
1.活动标签创建
2.活动标签修改
3.活动标签删除
4.活动标签置顶
5.活动标签排序重置
6.活动标签列表接口
2022-07-06活动创建接口活动创建接口
2022-06-02问答支持昵称编辑问答昵称编辑
2022-06-02获取问答昵称获取问答昵称
2022-05-27活动观看数据列表入参调整活动观看数据列表
2022-05-09角色权限新增“视频轮询”权限项技术文档调整如下:
1.获取活动角色配置
2.角色权限修改
2022-05-07新增活动删除回调,调整回调信息技术文档调整如下:
1.通用设置管理-回调事件操作-回调介绍
2.通用设置管理-回调事件操作-回调查询
3.通用设置管理-回调事件操作-回调创建
4.通用设置管理-回调事件操作-回调修改
5.通用设置管理-回调事件操作-活动删除回调
2022-04-28新增观看协议技术文档调整如下:
1.活动管理-品牌设置-获取观看协议
2.观看端-观看协议-获取观看协议信息
3.活动管理-品牌设置-保存观看协议
4.观看端-观看协议-用户同意观看协议
2022-04-251.获取用户签到记录出参调整
2.获取活动聊天历史记录出参调整
3.获取收到礼物列表出参调整
4.获取连麦记录出参调整
5.获取中奖用户列表出参调整
6.获取红包领取列表出参调整
7.问卷对应答案信息出参调整
2022-04-061. 活动创建接口入参调整
2.活动修改接口文档入参调整
3. 活动详情接口文档出参调整
4.批量活动详情文档出参调整
5.活动列表文档出参调整
2022-03-10创建回放回调时间添加字段
2022-02-17①: /v3/webinars/privilege/edit-role-name①:添加修改特殊角色名称接口
涉及技术文档如下
2022-02-10①:/v3/interacts/chat/get-list①:聊天列表新增发送人邮箱email字段
2021-12-31①:/v3/data-center/user/user-duration
②:/v3/data-center/business-total/user-duration-pay
③: /v3/data-center/business-total/user-duration-pay-detail
①:查询每天用户时长使用量
②:查询某段时间内的时长使用情况
③:查询某段时间内时长使用详情
2021-12-23/v3/webinars/webinar-language/create活动语种创建接口
2021-12-23/v3/webinars/webinar-language/edit活动语种修改接口
2021-12-23/v3/webinars/webinar-language/delete活动语种删除接口
2021-12-23/v3/webinars/webinar-language/list活动语种列表接口
2021-11-08//v3/webinars/audience/post-additional-list新增白名单用户接口
2021-10-28/v3/webinars/webinar/info活动详情接口,webinar_type字段新增活动类型:5定时直播
2021-10-28/v3/webinars/webinar/edit活动修改接口,新增描述:
①定时直播正在直播时,时间不支持修改
②定时直播不支持恢复为预告。③直播中,定时直播不支持更换视频源。
2021-10-28/v3/webinars/webinar/get-list获取活动列表,webinar_type字段新增活动类型:5定时直播
2021-10-28/v3/webinars/webinar/create-demand回放发布为点播接口,新增回放发布为定时直播参数:
①新增is_timing参数,1是定时直播,默认为0点播
②新增start_time参数:定时直播的开始时间
③新增错误码:512103,含义为:创建定时直播失败,没有此权限。
2021-10-21①:/v3/interacts/sign/get-user-sign-list①:修复signer_id为字符串情况返回0的错误
② 移除返回值参数app_id无效参数
2021-10-12①: /v3/webinars/record/push-entry-video
①回放/点播视频支持加密
2021-10-12①:/v3/webinars/live/get-role-url
①嘉宾助理支持传头像地址,如果传头像地址则嘉宾和助理会显示用户自己传的头像图片,建议140*140px,1M以内,jpg、png、gif、bmp,如果不传使用默认头像
2021-10-12①: /v3/webinars/webinar/create
②: /v3/webinars/webinar/edit
③:/v3/webinars/webinar/get-list
④: /v3/webinars/webinar/batch-get-webinar-info
①创建活动接口支持选择连麦人数,,举例:1v5(6人连麦),1v15(16人连麦),如果用户开通的最大连麦人数是1v1,用户自己传了1v2,接口会进行提示:您的账号最大连麦人数是1v1
②:查询活动详情、活动列表、活动修改支持查询和修改连麦人数1
2021-09-17①:/v3/webinars/verify/save
②:/v3/webinars/webinar/get-webinar-verify
①针对观看限制为密码、邀请码、白名单,支持用户自己设置自定义提示语,此提示语生效于观看端
②针对观看限制为免费且未设置报名表单时,支持观看端预约按钮;点播活动不支持此功能
2021-09-03①:/v3/webinars/webinar/get-list
②:/v3/webinars/webinar/create
③:/v3/webinars/webinar/info
④:/v3/webinars/webinar/batch-get-webinar-info
⑤:/v3/webinars/subject/info
增加无延迟直播字段,1是,0否
2021-08-05/v3/interacts/qa/get-questions-list获取问答记录列表增加邮箱字段
2021-05-24/v3/webinars/webinar/get-list活动列表增加简介字段
2021-05-20/v3/vss/lottery/lottery-user-detail获取中奖用户列表新增字段:中奖用户昵称、参会ID、中奖时间
2021-05-20/v3/users/open-user/get-token-login控制台支持免登录,链接有效期4小时
2021-05-13-回调事件优化。新增消息组织格式,新增失败重试
2021-03-29/v3/webinars/record/record-remake支持课件重制,将已经生成的直播回放片断和直播中演示的文档,通过视频混流生成在同一视频文件中,支持下载至本地。
2021-03-12全部接口API接口优化
修改于 2025-08-29 08:43:59
上一页
产品介绍
下一页
快速接入
Built with