嵌入微信小程序
准备工作
A1 业务域名增加
1.
2.
3.
4.
注意
https://live6.vhall.com非最终域名;B1 小程序开发
增加 小程序web-view 组件的引入。
注意
嵌入指南
| 示例 | 链接 |
|---|---|
| 活动ID,唯一标识 | 370512514 |
| 完全嵌入,观看页嵌入 | https://live.vhall.com/v3/lives/embedclientfull/watch/370512514?email=test@example.com&nickname=test |
| 单视频嵌入,播放器嵌入 | https://live.vhall.com/v3/lives/embedclientfull/watch/370512514?embed=video&email=test@example.com&nickname=test |
注意
URL参数
| 参数 | 是否必须 | 含义 |
|---|---|---|
| 是 | 我们推荐使用email来作为唯一标识有效用户的字段。 email格式要求：总长度必须小于50个字符 , 且通过该正则表达式 : /^[A-Za-z0-9]+[A-Za-z0-9-.]*@([A-Za-z0-9-]+)(\.[A-Za-z0-9-_]+){1,4}$/ 请将活动观看页，通过 web-view 嵌入微信小程序中。由于子页面无需登录，您需要通过拼接参数的方式传递身份信息。贵司的用户ID为1730635043，您可以在此ID后添加“@example.com”，以生成完整的邮箱地址：1730635043@example.com。 请务必保证email填写的唯一性！建议email与nickname同时使用以便更好的区分用户信息 | |
| nickname | 否 | 如果未填写，且拼接了third_user_id , 会使用third_user_id的昵称，否则会随机生成。 此字段表示用户昵称、姓名 , 总长度必须小于50个字符。可以为中文，但必须为UTF-8，且经过URL编码(urlencode)。 |
| avatar | 否 | 头像字段，URL长度须小于255个字符。请确保所提供的头像URL有效，以避免头像显示错误。 |
| member_level | 否 | 观众等级标识, 参数范围: 1~11对应关系: 1 - 等级0 2 - 等级1 3 - 等级2 4 - 等级3 5 - 等级4 6 - 等级5 7 - 等级6 8 - 等级7 9 - 等级8 10 - 等级9 11 - 等级10 > 效果请查看 |
| third_user_id | 否 | 此字段指的是第三方账号ID，当观看端为SDK/嵌入页等多端混用场景下，且多端需要统一用户时，可传递此参数。 注1：三方用户ID，可通过 创建三方用户 。对接贵司自有用户体系 注2：email和third_user_id一起使用时，需要您维护两者的唯一对应关系 |
| lang | 否 | 当在已设置多语言直播场景下，可以通过设置该参数来设置进入直播观看页面的页面展示语言，支持中英文，中文传值1，英文传值2；也可以在控制台的多语言链接入口直接获取对应语言的嵌入页链接。 |
| embed | 否 | embed=video表示只显示播放器模块。 注：手机端嵌入页面时，目前只支持两种方式： 1.没有embed参数（显示视频、文档、聊天） 2.embed=video（只显示视频） |
| k | 否 | 此字段为了提供给第三方可以根据自己的权限系统，验证客户是否可访问直播地址，具体说明参考“第三方K值验证”。 |
| k_id | 否 | 此字段是配合K值验证一起使用，当直播活动开启了多K值验证后 设置/修改单个活动K值会返回对应的k_id，调用此链接时将k_id传递进来就可以匹配对应的回调地址进行K值验证了。 |
| state | 否 | 此字段必须要配合K值验证一起使用，且已配置K值验证失败跳转url。当验证失败时在跳转的url后面增加该参数。 |
| k_only_watch | 否 | 此字段是配合K值验证一起使用，当直播活动开启了K值验证后，当传递k_only_watch=1时预约页将不再验证K值，直播和回放观看页值验证一次k值，不会重复验证。 |
FAQ
1.
详见：网页嵌入→产品介绍
2.
如果直播发起端在演示的文档启用了动画演示, 则会导致异常;
修改于 2025-06-09 11:56:56