开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. 直播观看嵌入指南
  • 平台概述
  • 接入指南
    • 业务流程
    • 接入指南
    • 基础概念说明
    • 开通账号/权限
    • 平台兼容性说明
    • 快直播OBS推流配置建议
    • 视频直播OBS推流配置建议
  • 直播观看嵌入指南
    • 产品介绍
    • 嵌入说明
    • 嵌入示例
    • 嵌入页消息推送
    • 嵌入微信小程序
    • 嵌入模式支付对接
    • 嵌入页第三方K值验证
  • 直播管理嵌入指南
    • 产品介绍
    • 嵌入说明
    • 嵌入示例
  • 聚合站点嵌入指南
    • 聚合页嵌入指南
    • 小程序嵌入指南
    • 创建三方用户「站点专用」
    • 更新三方用户「站点专用」
  • 相关协议
    • 微吼直播 SDK 隐私政策
    • 微吼直播 SDK 开发者使用规范
  1. 直播观看嵌入指南

嵌入页消息推送

在将嵌入直播观看页嵌入到客户自有网页中,嵌入页内发生活动状态变更、链接跳转等动作,外层页面都没办法知晓并做逻辑处理,例如,嵌入页内点击外链跳转只能覆盖嵌入区域内的页面,造成跨域问题无法使用,特此提供外链跳转消息推送机制,将外链点击事件推送到主页面,供客户主页面跳转页面。

消息事件#

openHref [废弃]#

{
  "type": "openHref",
  "data": "https://www.vhall.com"
}

vhOpenHref#

用途 : 在上层应用跳转到其他 URL 地址
{
  "type": "vhOpenHref",
  "data": "https://www.vhall.com"
}
层级字段类型说明
根级typestring固定值 : vhOpenHref
根级datastring需要跳转的完整 URL 地址

webinarInfo#

用途 : 获取被嵌入页面的详情信息
{
  "type": "webinarInfo",
  "data": {
    "webinarStatus": "live",
    "webinarType": 1
  }
}
层级字段类型说明
根级typestring固定为 webinarInfo
根级dataobject状态数据
data →webinarStatusstring页面状态 : "subscribe"(预约页), "live"(直播页)
data →webinarTypenumber1-直播
2-预约
3-结束
4-点播
5-回放

vhPlayerSdkEvent#

用途 : 视频事件处理
{
  "type": "vhPlayerSdkEvent",
  "data": {
    "event_type": "PLAY",
    "video_content_type": 3,
    "business_id": "72035607"
  }
}
层级字段类型说明
根级typestring固定值:"vhPlayerSdkEvent"
根级dataobject事件数据
data →event_typestring事件类型:"PLAY"、"PAUSE"等
data →video_content_typenumber视频播放格式
data →business_idstring租户 id

vhCustomToolsEntryClick#

用途 : 底部自定义入口
{
  "type": "vhCustomToolsEntryClick",
  "data": {
    "webinar_id": 658171537,
    "extends": {
      "status": 1,
      "icon": "https://cnstatic01.e.vhall.com/upload/interacts/screen-imgs/202505/9e/d7/9ed7818c73d48f1432a75e1de262c7c63588.jpeg"
    },
    "email": "1747361983@example.com"
  }
}
层级字段类型说明
​根级​typestring固定值:"vhCustomToolsEntryClick"(自定义工具入口点击事件类型)
​根级​dataobject事件数据容器
​data​webinar_idnumber直播活动唯一 ID(示例值:658171537)
​data​emailstring用户参会邮箱(示例值:"1747361983@example.com")
​data.extends​-object扩展信息(可选字段)
data.extendsstatusnumber入口状态:1-开启,0-关闭
data.extendsiconstring图标 URL(示例:"https://.../9ed7818c.jpeg")

外链跳转示例代码#

修改于 2025-06-09 11:42:51
上一页
嵌入示例
下一页
嵌入微信小程序
Built with