嵌入说明
嵌入说明
注意
URL参数
| 参数 | 是否必须 | 含义 |
|---|---|---|
| 是 | 我们推荐使用email来作为唯一标识有效用户的字段。 email格式要求：总长度必须小于60个字符 , 且通过该正则表达式 : /^[A-Za-z0-9]+[A-Za-z0-9-.]*@([A-Za-z0-9-]+)(\.[A-Za-z0-9-_]+){1,4}$/ 场景一 : 将微吼嵌入页通过 iframe 或 webview 集成到贵公司的网站、App 或 微信小程序中。由于外层已登录，为避免子页面二次登录降低用户体验，建议通过拼接参数传递身份信息。外部网站用户ID为 1730635043，可以生成邮箱地址为： 1730635043@example.com。 场景二 : 针对无用户体系且无需登录的外部网站，观众可通过嵌入方式直接进入微吼直播间进行观看。由于聊天功能通常需要实名认证或登录方可使用，因此观众仅可观看直播，不具备发送聊天信息的权限。 请务必保证email填写的唯一性！建议email与nickname同时使用以便更好的区分用户信息 | |
| nickname | 否 | 如果未填写，且拼接了third_user_id , 会使用third_user_id的昵称，否则会随机生成。 此字段表示用户昵称、姓名 , 总长度必须小于50个字符。可以为中文，但必须为UTF-8，且经过URL编码(urlencode)。 |
| avatar | 否 | 头像字段，URL长度须小于255个字符。请确保所提供的头像URL有效，以避免头像显示错误。 |
| third_user_id | 否 | 此字段指的是第三方账号ID，当观看端为SDK/嵌入页等多端混用场景下，且多端需要统一用户时，可传递此参数。 注1：三方用户ID，可通过 创建三方用户接口 。对接贵司自有用户体系 注2：email和third_user_id一起使用时，需要 您维护两者的唯一对应关系 |
| 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 效果请查看 |
| lang | 否 | 当在已设置多语言直播场景下，可以通过设置该参数来设置进入直播观看页面的页面展示语言，支持中英文，中文传值1，英文传值2；也可以在控制台的多语言链接入口直接获取对应语言的嵌入页链接。 |
| embed | 否 | 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值 |
| customer_goods_xxx | 否 | 外链商品自定义参数，xxx 为客户自 定义部分，此参数是配合外链商品一起使用，当直播活动配置了外链商品后，当传递了 customer_goods_xxx=xxxx后，外链商品跳出后会拼接 customer_goods_xxx=xxxx，方便观众身份及必要参数的透传 参数固定前缀为 customer_goods_，后面部分客户自定义设置，支持拼接多个类似参数 |
| open_id | 否 | 商品订单支付、公众号开播提醒功能必传参数，嵌入页无法完成微信授权，需要在前置页面完成授权将open_id传递到嵌入页，完成微信支付和微信开播提醒预约，商品支付功能开通及商户号配置请咨询商务或售后 |
修改于 2025-06-09 11:36:13