You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

自定义登录

最近更新时间：2023.10.10 17:20:35

首次发布时间：2021.12.28 11:46:04

我的收藏

企业直播支持自定义鉴权，即将观看限制设置为自定义后，允许用户通过登录您的自有账号系统观看直播或发送评论等。

注意

如需使用该功能，确保您具备开发资源。

前提条件

  • 您已开通旗舰版或定制版套餐。具体操作，详见服务购买。
  • 确保您拥有火山引擎主账号或具备观看页管理 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

应用场景

  • 将观看账号设置为自定义：用户必须先登录您的自有账号系统，才能进入直播间观看直播等。适用于企业内部培训等保密性较强的直播场景。例如某企业举行内部培训活动，只有公司员工通过员工账号登录公司系统后，才能参与直播培训。
  • 将评论限制设置为自定义：用户必须先登录您的自有账号系统，才能发送评论、参与抽奖等互动活动。适用于产品推广等直播场景。例如在某手机游戏的推广直播活动中，只有登录了该款手游账号的用户才能参与评论与抽奖等，从而提高该款手游的下载量，达到拉新的目的。
  • 观看页免登录方案：相较于以上常规的自定义登录方案，观看页免登录方案更为便捷。例如，用户登录您的 App 后，点击 App 中相应的 URL（即您自行拼接的带有鉴权参数的观看页地址，详见观看页免登录方案，即可进入直播间观看直播、发送评论等。

注意事项

如果直播间是通过 iframe 嵌入方式嵌入到了您自己的页面，您需要通过添加别名记录（CNAME 记录）的方式自定义观看页域名，使您的页面和观看页的域名相同，进而避免浏览器禁止第三方 Cookie 写入的问题。如需添加 CNAME 记录，请联系企业直播技术支持。

流程详解

常规自定义登录方案

将观看限制设置为自定义后，企业直播需要通过您的自有账号系统认证用户身份。详细流程如下所示。
图片

  1. 用户访问企业直播观看页。
  2. 企业直播携带 ActivityId、Timestamp、RedirectUrl 参数将用户重定向至您的自有账号系统登录页面（即登录链接，配置方法详见操作步骤）。
    • 将观看账号设置为自定义：用户访问观看页后，企业直播携带以上参数进行页面的重定向。
    • 将评论限制设置为自定义：用户在观看页发送评论、参与抽奖等互动活动时，企业直播携带以上参数进行页面的重定向。
  3. 用户在您的自有账号系统登录页面完成账号登录。
  4. 您的自有账号系统在通过用户的身份认证后，使用相关参数计算校验签名。
  5. 您的自有账号系统携带 UserId、Nickname、Timestamp、Sign 等参数将用户重定向至企业直播鉴权页面（RedirectUrl）。

    说明

    如需开通鉴权页面地址的唯一性校验，请联系技术支持。开通后，请确保在自有账号系统使用同一用户信息访问鉴权页面时，所携带的参数值是动态的，例如动态的 Timestamp 参数值。

  6. 企业直播在鉴权页面进行签名（Sign 值）校验，判断是否允许用户观看直播或发送评论等。
  7. 校验通过后，即企业直播计算的校验签名与您自有账号系统携带的校验签名值相同，用户即可观看直播或发送评论等。

说明

签名校验未通过会进入自定义鉴权校验失败页面（即错误重定向地址，配置方法详见操作步骤）。

观看页免登录方案

如果您选择使用观看页免登录方案，详细流程如下所示。
图片

  1. 用户在您的自有账号系统登录页面完成账号登录。
  2. 您的自有账号系统在通过用户的身份认证后，使用相关参数计算校验签名。
  3. 将 Sign、Nickname、UserId、Timestamp 等参数作为鉴权参数添加至观看页地址，例如 https://live.bytedance.com/xxx/xxx?Sign=xx&Nickname=xx&UserId=xx&Timestamp=xxx。
  4. 用户访问带有以上鉴权参数的观看页地址。

    说明

    如果用户将带有以上鉴权参数的观看页地址分享给其他人，会导致多人使用同一用户身份登录直播间的问题。为避免该问题的发生，建议采用动态的 Timestamp 参数值并联系技术支持开通观看页地址的唯一性校验，或者开启禁止重复登录功能。有关如何开启禁止重复登录功能，详见安全管控。

  5. 企业直播根据鉴权参数中的信息进行签名（Sign 值）校验，判断是否允许用户观看直播或发送评论等。
  6. 校验通过后，即企业直播计算的校验签名与鉴权参数中的 Sign 值相同，用户即可观看直播或发送评论等。

说明

如果您将观看账号设置为自定义，签名校验未通过会进入自定义鉴权校验失败页面（即错误重定向地址，配置方法详见操作步骤）。如果您将评论限制设置为自定义，签名校验未通过不会进入自定义鉴权校验失败页面。用户会以未登录直播间的状态，在观看页观看直播、预告或回放，但无法发送评论或参与抽奖等互动活动。

参数解释

跳转参数

企业直播携带以下参数从观看页重定向至您的自有账号系统登录页面。

参数

类型

描述

示例值

ActivityId

Integer

直播间活动 ID。

17475526787325

Timestamp

Integer

当前时间。Unix 毫秒级时间戳。

1669808399000

RedirectUrl

String

企业直播鉴权页面地址。在该页面，企业直播会通过签名（Sign 值）校验，判断是否允许用户观看直播或发送评论等。

liveDomain/xxx/xxx

回调参数

  • 常规自定义登录方案：您的自有账号系统携带以下参数从自有账号系统登录页面重定向至企业直播鉴权页面。
  • 观看页免登录方案：您可以将以下参数作为鉴权参数添加至观看页地址。

参数

类型

是否必选

描述

示例值

UserId

String

是

用户在您自有账号系统内的唯一标识。该参数仅用于关联您的自有账号系统和企业直播，不用做数据分析。

说明

为避免个人信息泄露，请勿使用手机号、身份证号等信息作为用户在您自有账号系统的唯一标识。

14039

Nickname

String

是

用户在您自有账号系统内的昵称。您需要对昵称先进行 UTF-8 编码,然后进行 Base64 编码，最后再进行 URL 编码。
例如昵称为员工😁 ABC，则进行 Base64 编码后的值为 5ZGY5bel8J+YgSBBQkM=，再进行 URL 编码后的值为 5ZGY5bel8J%2BYgSBBQkM%3D。

说明

为避免个人信息泄露，请勿使用手机号、身份证号等信息作为用户在您自有账号系统的昵称。

5ZGY5bel8J%2BYgSBBQkM%3D

Timestamp

Integer

是

当前时间。Unix 毫秒级时间戳。

1669808499000

Sign

String

是

校验签名。
完成以下步骤，计算校验签名。

  1. 以 SecretKeyUserIdTimestamp的格式拼接字符串。其中 Secret Key 可在完成控制台操作后获取，详见操作步骤。
  2. 将字符串进行 MD5 加密并转化为 32 位小写密文。

例如 Secret Key、UserId 和 Timestamp 的值分别是 h/macd/b/a、14039 和 1669808499000，则 Sign 的值为 2708f2f2969e38ff5d1863fde50e7b64。

2708f2f2969e38ff5d1863fde50e7b64

CustomComment

String

否

中奖名单中昵称右侧的自定义信息，例如中奖者所在的地区。最多支持 50 个字符。

说明

您必须在新建抽奖时打开中奖者详情开关，才能将该参数值同步至中奖名单。详见实时抽奖。

北京

extra

String

否

同步至企业直播的额外参数，可用于关联用户。例如将您自有账号系统中的用户部门同步至企业直播。

销售部

forceCheck

Boolean

否

是否清空上一次的登录态。默认值：false

  • true：清空上一次的登录态。适用于多人使用同一浏览器或设备的场景。例如用户 A 和用户 B 在同一台设备的同一浏览器访问观看页，用户 B 在用户 A 访问后，必须重新登录您的自有账号系统，从而保证二者能够以各自的身份访问观看页。
  • false：不清空上一次的登录态。适用于浏览器或设备专人专用的场景。例如用户 A 通过同一设备的同一浏览器多次访问观看页，在未清除浏览器 Cookie 期间，无需每次重新登录您的自有账号系统。

true

操作步骤

  1. 登录企业直播控制台。

  2. 在直播列表中，单击进入直播间。

  3. 在左侧导航栏，选择观看页管理 > 观看限制。

  4. 将观看账号或评论限制设置为自定义，并完成以下配置。

    • 将观看账号设置为自定义：用户必须先登录您的自有账号系统，才能进入直播间观看直播等。
      图片
    • 将评论限制设置为自定义：用户必须先登录您的自有账号系统，才能发送评论、参与抽奖等互动活动。

      说明

      您必须先将观看账号设置为公开、密码或邀请码，才能将评论限制设置为自定义。

      图片

    配置项

    描述

    登录账号App

    您的自有账号系统名称。

    登录链接

    您的自有账号系统登录页面的链接。该链接需要包含协议头，例如http://myDomain/auth。

    • 将观看账号设置为自定义：用户访问观看页后，企业直播携带 ActivityId、Timestamp、RedirectUrl 参数将用户重定向至该登录链接。
    • 将评论限制设置为自定义：用户发送评论、参与抽奖等互动活动时，企业直播携带 ActivityId、Timestamp、RedirectUrl 参数将用户重定向至该登录链接。

    说明

    观看页免登录方案中，用户无需重定向至该登录链接。

    Secret Key

    在您填写登录账号 App 和登录链接并保存配置后，可自动生成。用于计算校验签名（Sign值），计算方法详见回调参数。

    错误重定向地址

    自定义鉴权校验失败后，进入的鉴权校验失败页面的地址。该地址需要包含协议头。默认跳转至企业直播的自定义鉴权校验失败页面。

    试看

    打开开关并选择试看时间。在试看时间内，观众可以在不登录直播间的情况下观看直播或回放。详见试看。

    说明

    将评论限制设置为自定义时，不支持试看功能。

    说明

    您也可以打开次要观看账号开关，将次要观看账号或相应的评论限制设置为自定义。关于主次观看限制的配置，详见主次观看限制。

相关文档

观看限制常见问题