调用 GetActivityLoginSecret 接口，获取观众通过 Web 观播 SDK 进入直播间或点播间所需的登录秘钥，登录秘钥一次获取后可长期使用。

使用说明

如果观众可以通过您的公司官网等自有账号系统完成登录，您可以选择第三方用户态登录方式，观众使用您自有账号系统中的身份进入直播间或点播间。在此场景下，建议您调用本接口获取直播间或点播间的登录秘钥，并按照以下说明为观众获取授权 Token：

• 当请求参数 Mode 为 1 （公开登录类型）时，该秘钥的值可直接作为 Web 观播 SDK 初始化参数 signToken 的值传入；
• 当请求参数 Mode 为 2 （自定义登录类型）时，您需使用该秘钥自行在本地生成一个 JWT（JSON Web Token）作为 Web 观播 SDK 初始化参数 signToken 的值。JWT 需要使用 HS256 算法生成，需传入的字段如下所示：

{
    "NickName": "Tom", // 观众昵称。必填。
    "UserIdStr": "9807679", // 观众 ID。必填。为避免个人信息泄露，请勿使用手机号、身份证号等信息作为观众 ID。
    "InviterToken": "abcd", // WebSDK 使用直播分享功能时，传入 path（直播分享地址） 上 inviter_token 对应的数据。例如：path 为 https://test.live.com/123/456?inviter_token=abcd，则传入的 InviteToken 为 abcd。
    "CustomComment": "北京", // 中奖名单中观众昵称右侧的自定义信息，例如中奖者所在的地区。仅当 Mode 为 2时该参数会生效。
    "LevelId": "10086", // 观众等级 ID。可通过 GetViewerLevelConfig 接口获取。
    "TimeStamp": 1694502400 // 观众加入直播间或点播间的时间戳，单位为秒。数据类型为 Long。
}

注意事项

• 请求频率：单用户请求频率限制为 120 次/分钟。
• 前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

• 请求方式：GET
• 请求地址：https://livesaas.volcengineapi.com/?Action=GetActivityLoginSecret&Version=2023-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

返回参数

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityLoginSecret&Version=2023-08-01&ActivityId=181****461451&Mode=2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityLoginSecret",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "LoginSecret": "dasd123sdcsd0(/."
    }
}

错误码

访问公共错误码和错误码获取详细信息。