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

身份参数说明

初始化身份参数说明#

1. email 与 account#

email 与 account 的本质相同:都是微吼系统与接入方业务系统之间打通用户身份、用于标识用户的字段,不是昵称、头像一类的展示资料。
两者必须且只能传一个,不能同时传,也不能都不传。
推荐使用 email 作为系统间用户唯一标识:它不需要在微吼侧预创建用户,因此用户信息不必在两个系统之间提前预置。email 只承担标识作用,不要求客户系统确实存在用户邮箱字段,可以使用“业务用户 ID + 固定域名”拼装,例如 88888@xxxx.com。
使用 account 时,必须先在业务后端调用创建三方用户接口完成预创建;初始化小程序 SDK 时,微吼侧必须已存在该用户 ID,否则初始化不会成功。
两者都参与服务端签名,前端初始化与服务端签名必须使用同一个字段、同一个值。

2. 参数定义#

email 与 account 的本质相同:都是微吼系统与接入方业务系统之间用于打通用户身份、完成用户识别与数据归属的标识字段。它们不是展示资料,也不承担登录密码等凭证的作用。真正的区别只有两点:身份来自哪里,以及是否需要提前在微吼侧建立用户。

2.1 email(跨系统用户唯一标识)#

这里需要特别澄清:email 的职责是“标识”,不是“通讯邮箱地址”。
客户系统本来就有真实邮箱时,可以直接使用该邮箱,来标识用户唯一;
客户系统没有邮箱字段时,也可以按固定规则拼装一个邮箱格式的标识,例如业务用户 ID 为 88888,拼装为 88888@xxxx.com;
拼装值不要求真实可收信,但必须是稳定的映射:同一个用户在每次初始化时都应得到相同的 email;
不要使用随机数、时间戳或会话 ID 拼装邮箱,否则同一用户会被识别成多个不同身份;
建议将 xxxx.com 替换为接入方统一约定的固定域名,并把映射规则沉淀到用户标识服务中。
拼装后的邮箱总长度不要超过50字符。
email 只负责身份识别,用户在直播间展示的昵称仍由 username 单独传入,头像仍由 head 单独传入。

2.2 account(三方用户 ID)#

account 与 email 最大的区别是:它不是“即传即用”,而是要求两个系统先完成用户打通。 这一前置步骤包括:
1.
业务后端调用微吼创建三方用户接口;
2.
微吼返回用户注册信息;
3.
业务后端持久化保存业务用户与三方用户 ID 的映射;
4.
小程序初始化 SDK 时,传入已存在的三方用户 ID。
如果跳过预创建,或传入了一个微吼侧不存在的ID,SDK 初始化不会成功。
这里的 account 按文档定义应填你方系统内的用户唯一标识,也就是调用创建接口时提交的 third_user_id 对应的值。

2.3 对照表#

维度emailaccount
身份来源以邮箱格式承载的跨系统用户标识接入方自有用户体系中的用户 ID
典型值88888@xxxx.com(可由业务 ID 拼装)88888(创建时的 third_user_id)
是否需要预先创建不需要必须:后端先调用创建三方用户接口
初始化成功前提提供唯一、稳定的邮箱格式标识微吼侧已存在该三方用户 ID

3. 如何选择#

优先使用 email(推荐):
希望系统之间不预置用户资料,以最低耦合完成身份打通;
客户系统没有邮箱字段,也可以按固定规则拼装邮箱格式标识,例如 88888@xxxx.com;
不希望为每位用户额外调用创建三方用户接口,减少接入和运维成本;
可以接受邮箱身份没有默认头像,需要头像时另行传入 head。
email 模式时序:
email 模式无需预创建用户,链路更短。
使用 account:
已经在微吼侧建立了三方用户,或需要以自有用户 ID 关联聊天、问卷等导出数据;
已有稳定的用户体系,愿意维护“业务用户 ID ↔ 三方用户 ID”的映射;
需要将小程序、Web 等多端的用户身份统一到同一个三方用户上;
能够确保每次初始化前该用户 ID 已在微吼侧存在。
account 模式时序:
account 模式必须先完成用户打通,且初始化时该用户 ID 必须已存在。
总结:account 多一步“先创建、后使用”,email 可以直接使用,不需要预置用户。
两种模式的共同要求:
身份标识必须唯一且稳定。同一个业务用户每次进入直播间,生成的 email 或 account 必须一致;
只能传一个身份字段,另一个必须删除,不能留空字符串,也不能传 null 占位;
身份字段参与签名,确定后不要在前端临时替换。
不建议的用法:
同时传 email 和 account,违反互斥约束;
两个都不传,初始化时缺少用户身份;
使用 account 但未预创建,或传入微吼内部 user_id,会导致初始化失败;
用邮箱作为 account 的值来“兼容”两种模式,这不会带来兼容收益,反而会让身份归属混乱;
每次进入都随机拼装不同的 email,会把同一用户拆成多个身份。

4. 参考文档#

快速接入
签名鉴权说明
创建三方用户
修改于 2026-10-22 01:34:52
上一页
版本更新记录
下一页
微吼直播 SDK 隐私政策
Built with