开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. JS 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
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. JS SDK

快速接入

确认您已完成开放平台权限及账号的申请,如未完成请先申请帐号

引入 SDK#

注:仅支持 https 协议

其中 URL path 中 dist 后为 JSSDK 版本号

初始化 SDK#

SDK 初始化参数说明#

参数类型说明是否必填备注
app_keyString微吼直播开放平台应用 key是点击获取 AppKey
signedatString签名时的时间戳(精确到秒)是当前系统时间,五分钟内有效
signString本次请求签名是签名算法
roomidString微吼直播活动 ID是创建活动接口
accountString用户 ID是此字段指的是第三方账号 ID,当 观看端为 SDK\嵌入页等多端混用场景 下,且多端需要维护统一的第三方观众用户或 email 时,可传递此参数。
注 1:第三方账号 ID,可通过 创建第三方用户接口 创建。
注 2:third_user_id 和 email 一起使用时,需要客户维护两者的唯一对应关系,否则会触发“邮箱已被他人使用”错误
usernameString用户昵称是用户昵称字段长度限制为 50 个字符
videoContentString播放器 Dom id是如: #video-content
docContentString文档区域 Dom id是如:#doc-area
questionarieContainerString问卷容器 Dom id否如果需要问卷功能必填,如:#question-id
examConfigObjectneed:需要快问快答能力, need: true,container:快问快答 dom id,如:#examWrap否3.6.0 及以上版本支持
sign_typeNumber验签规则切换否默认:0。 0: MD5 1:RSA
emailString用户 Email否注:如存在需参与验签, account 备用字段,用于区分用户
pluginsArray微吼直播功能列表否如: [ 'chat', 'player', 'doc','interactTools'],3.5.1 以上版本不需要此参数
x5_video_fullscreenBoolean启用腾讯H 5 全屏方式否默认:false。 true 开启 ,false 关闭
record_idString回放 id否设置房间下的回放 id 优先播放此回放 即使房间正在直播

错误码#

全局错误码

签名说明#

Sign 是微吼直播 JSSDK,所有功能必须参数。 作为用户使用微吼直播 SDK 的唯一合法凭证。

v3.1.0 版本开始支持两种验签规则分别为 MD5 和 RSA 两种方式。

对应初始化 JSSDK 时,需要根据不同规则赋值 sign_type 来驱动 JSSDK 使用

签名方式一 (MD5 签名方式)#

参与签名参数#

字段名称字段说明备注
roomid微吼直播 活动 ID
account用户账号
username用户昵称
app_key微吼直播 开放平台用户应用 Key点击获取 AppKey
signedat签名时的时间戳(精确到秒)系统当前时间戳用于验签

签名算法规则#

安全性说明(重要)
对接使用时,请不要将 secret_key 暴露在前端,demo 中仅为演示。
| 规则序号 | 规则 | 备注 |
| -------- | --------------------------------------------- | --------------------------------------------------------- | --- |
| 1 | 按参数名升序排列 | |
| 2 | 将参与签名的参数 以 Key + Value 形式顺序拼接 | |
| 3 | 在参数拼接完成后的字符串首尾各加上 secret_key | 点击获取 secret_key |
| 4 | 将第三步的得到的字符串进行 md5 加密得到 Sign | | |

签名生成示例代码 PHP#

签名生成示例代码 Java#

安全说明#

MD5(Message Digest Algorithm )为计算机安全领域广泛使用的一种散列函数,用以提供消息的完整性保护。该算法的文件号为 RFC 1321(R.Rivest,MIT Laboratory for Computer Science and RSA Data Security Inc. April 1992)。该算法为单向不可逆算法。
为增加签名安全系数, 微吼直播参与签名字符串长度为 130+,并为 sign 设置了 1 小时时间时效,靠碰撞检测得出相同 sign 的难度为 130+的阶乘(极其耗费算力)。请各位开放平台用户放心使用。

签名方式二 (RSA 签名方式)#

参与签名参数#

字段名称字段说明备注
roomid微吼直播 活动 ID
account用户账号
username用户昵称
app_key微吼直播 开放平台用户应用 Key点击获取 AppKey
signedat签名时的时间戳(精确到秒)系统当前时间戳用于验签

签名算法规则#

| 规则序号 | 规则 | 备注 |
| -------- | -------------------------------------------------------------- | ---------------------------------------------- | --- |
| 1 | 按参数名升序排列 | |
| 2 | 将参与签名的参数 以 Key + Value 形式顺序拼接 | |
| 3 | 将第二步的得到的字符串进行 md5 加密计算 | |
| 4 | 用私钥将第三步的 md5 结果,进行 RSA 签名计算 | 获取私钥 |
| 5 | 将第四步中的结果,进行 base64url_encode 编码,结果作为 sign 值 | | |

签名生成示例代码 PHP#

依赖 php 的 comoser 扩展("phpseclib/phpseclib": "2.0")
require './vendor/autoload.php';
use phpseclib\Crypt\RSA;

/**
 * base64url_encode
 * @param $data
 * @return string
 */
function base64url_encode($data) {
    return rtrim(strtr(base64_encode($data), '+/', '-_'), '=');
}

/**
 * base64url_decode
 * @param $data
 * @return bool|string
 */
function base64url_decode($data) {
    return base64_decode(str_pad(strtr($data, '-_', '+/'), strlen($data) % 4, '=', STR_PAD_RIGHT));
}

//应用信息
$app_key = 'user_app_key';
$rsa_private_key = '';

//参与签名数据
$params = [
    // === 公共参数 ===
    "app_key" => $app_key,
    "signed_at" => '1657892327',
    // === 业务接口参数 ===
    "roomid" => "123456",
    "account" => "123456",
    "username"=> "zhangsan",
];

// 按参数名升序排列
ksort($params);
// 将键值组合
array_walk($params, function (&$value, $key) {
    $value = $key . $value;
});

//加密
$rsa = new RSA();
$rsa->loadKey($rsa_private_key);
$rsa->setSignatureMode(RSA::ENCRYPTION_PKCS1);
$rsa->setHash('md5');
$signString = md5(implode('', $params));
$sign = base64url_encode($rsa->sign($signString));

浏览器兼容性#

浏览器版本备注
Chrome74 版本及以上
edge84 版本及以上
safari12 版本及以上
FireFox79 版本及以上
微信内置浏览器全版本
360 急速浏览器全版本请使用 Chromium 内核
微信小程序不支持微信小程序由于域名校验严格,推荐使用标品 H5 页面嵌入开发
其他手机浏览器绝大部分支持如遇问题请联系商务或邮件我们
其他未涉及浏览器可能出现兼容性问题。 问题反馈联系客服
修改于 2025-05-27 12:18:50
上一页
产品介绍
下一页
SDK 对接示例
Built with