开放平台
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
  1. Harmony SDK
  • DEMO示例
  • JS SDK
    • web 点播 sdk
      • 更新记录
      • 点播上传SDK
    • web 观播 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 隐私政策
    • 微吼直播 SDK 开发者使用规范
  1. Harmony SDK

观看权限校验&预约

权限校验&预约#

关键方法#

方法方法描述
VHSaaSDK.getInstance().getWatchAuth执行观看授权

执行观看授权#

接口 API#

  public getWatchAuth(webinarId: string, type: string, verifyCode: string, callback: VHWatchAuthQueryCallback) 

接口入参#

参数名称是否必须示例备注
webinarId是398887625活动id
type是xxx0:免费(默认),1:密码
verifyCode否xxx如果为1或2时对应的验证码
callback是xxxVHWatchAuthQueryCallback

接口使用示例#

通过获取活动基础信息接口获取is_subscribe是否已经预约过,没有预约判断verify类型。目前SDK只支持密码验证。
if (this.webinar_info?.join_info?.is_subscribe == 0) { //如果没有预约成功
              //如果配置了密码没有通过密码验证
              if (this.webinar_info?.webinar?.verify == 1 && this.webinar_info?.join_info?.verified == 0) {
                let params = new inputParam();
                params.holder = this.webinar_info?.webinar?.verify_tip!;
                params.verify = this.webinar_info?.webinar?.verify!;
                if (this.webinar_info?.webinar?.verify_tip.length === 0) {
                  if (this.webinar_info?.webinar?.verify === 1) {
                    params.holder = '请输入密码';
                  }
                }
                
                params.join = (pwd: string) => {
                  console.log("用户输入内容:", pwd); // 此处处理密码或白名单信息
                  PromptActionClass.closeDialog();
                  this.loadingContentNode = new ComponentContent(this.getUIContext(), wrapBuilder(createLoadingView));
                  PromptActionClass.setContext(this.getUIContext());
                  PromptActionClass.setContentNode(this.loadingContentNode);
                  PromptActionClass.setOptions({
                    alignment: DialogAlignment.Center,
                    isModal: true,
                    maskRect: {
                      x: 0,
                      y: 0,
                      width: '100%',
                      height: '100%'
                    }
                  });
                  PromptActionClass.openDialog();

                  const webinarId = this.webinar_info?.webinar?.id.toString()!;
                  //1 密码,2 白名单 进行验证。验证通过则预约成功
                  VHSaaSDK.getInstance()
                    .checkWatchAuth(webinarId, this.webinar_info?.webinar?.verify == 1 ? "1" : "2", pwd, {
                      onSucceed: (data: VHWatchAuthInfo) => {
                        PromptActionClass.closeDialog();
                        //直播中
                        if (this.webinar_info?.webinar?.type == 1) {
                          let param: object = new Object()
                          param['webinars'] = this.webinar_info;
                          param['player_config'] = this.player_config;
                          //需要断点消息连接
                          this.imBase?.leave();
                          this.isEnterRoom = true;
                          this.pageInfos.replacePath({ name: 'WatchLivePage', param: param }, true);
                        } else {
                          //设置预约成功状态。
                          if(this.webinar_info?.webinar?.type == 5){
                            this.pageInfos.pop();
                            //回到进入直播页面进行观看
                          }else{
                            this.reservationState = '预约成功';
                            if (this.webinar_info?.join_info) {
                              this.webinar_info.join_info.is_subscribe = 1;
                            }
                            if (this.webinar_info?.subscribe) {
                              let count: number = this.webinar_info?.subscribe?.num + 1;
                              this.reservation_count = "已预约" + count.toString() + "人";
                            }
                          }

                        }
                      },
                      onFailure: (errorCode, errorMsg) => {
                        PromptActionClass.closeDialog();
                        ToastUtil.showToast(errorMsg);
                      }
                    });
                };
                this.contentNode = new ComponentContent(this.getUIContext(), wrapBuilder(inputPwdDialog), params);
                PromptActionClass.setContext(this.getUIContext());
                PromptActionClass.setContentNode(this.contentNode);
                PromptActionClass.setOptions({
                  alignment: DialogAlignment.Center,
                  offset: { dx: 0, dy: 50 },
                  isModal: true,
                  maskRect: {
                    x: 0,
                    y: 0,
                    width: '100%',
                    height: '100%'
                  }
                });
                PromptActionClass.openDialog();
              }
          }

VHWatchAuthInfo信息#

观看验证状态信息
VHWatchAuthInfo类型备注
visitor_idstring访客唯一标识
join_idstring参会id
statusstringlive-直播;subscribe-预约
typestring0:免费(默认),1:密码
修改于 2025-11-18 03:18:32
上一页
观看协议
下一页
开屏海报
Built with