嵌入说明

公共参数

参数名称	参数说明	传参方式	备注
token	用户登录标识	querystring	存入 localStorage 之后会一直存在，在下次写入时覆盖

如何获取使用公共参数？

调用开放接口获取授权 token，将获取的授权 token 存入到 localStorage 中使用，每次调用嵌入页面将 token 作为公共参数传入。

嵌入 URL

示例：
https://e.vhall.com/v3/embed/live/detail/555820923?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODM1MzIyMTEsImV4cCI6MTY4NjEyNDIxMSwidXNlcl9pZCI6IjE2NDIzMTUyIiwicGxhdGZvcm0iOjE3LCJjaCI6ImIiLCJidXNpbmVzc19hY2NvdW50X2lkIjoiMjkwMDE0OTYifQ.BNVTv58HPxWlRDvqwQlsCNz6jDFPJU2JEYaNNms-pB0

序号	链接/参数	说明
1	https://e.vhall.com	直播管理端嵌入链接公共路由
2	/v3/embed/live/detail/	嵌入页面功能路由，例如/live/detail 是直播详情页
3	555820923	直播活动 id，活动级别的功能页面需要增加活动 id
4	token=eyJ0eXAiOiJKV...	公共参数，每次请求都提交 token

直播详情页面提供进入各个功能模块的页面跳转，嵌入一个页面即可完成微吼直播所有配置能力；也可以根据需求，从下面的列表中挑选功能页进行嵌入

详细页面链接与传参

所有链接需要添加公共路由
https://e.vhall.com

直播管理

功能页	链接	参数名称	参数说明	传参方式	示例
创建直播活动	/v3/embed/live/edit	无	无	无	https://e.vhall.com/v3/embed/live/edit?token=xxx
编辑直播活动	/v3/embed/live/edit/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/edit/1234564?token=xxx
创建点播活动	/v3/embed/live/vodEdit	无	无	无	https://e.vhall.com/v3/embed/live/vodEdit?token=xxx
编辑点播活动	/v3/embed/live/vodEdit/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/vodEdit/1234564?token=xxx
创建定时直播	/v3/embed/live/timeEdit	无	无	无	https://e.vhall.com/v3/embed/live/timeEdit?token=xxx
编辑定时直播	/v3/embed/live/timeEdit/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/timeEdit/1234564?token=xxx
直播详情页	/v3/embed/live/detail/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/detail/1234564?token=xxx

消息列表

打通嵌入页与外层承载页的通信机制，将直播创建、编辑等动作的消息传递出来，以便页面完成跳转。

例如直播创建成功后，根据读取消息中直播id，拼接到直接详情页的嵌入链接上跳转到直播详情页。

直播创建页面

类型	说明	内容
embed_live_create	直播创建	{ webinar_id: Number, 直播 id }
embed_live_create_cancel	直播创建-取消	{}

直播编辑页面

类型	说明	内容
embed_live_edit	直播编辑	{ webinar_id: Number, 直播 id }
embed_live_edit_cancel	直播编辑-取消	{}

点播创建页面

类型	说明	内容
embed_vod_create	点播创建	{ webinar_id: Number, 直播 id }
embed_vod_create_cancel	点播创建-取消	{}

点播编辑页面

类型	说明	内容
embed_vod_edit	点播编辑	{ webinar_id: Number, 直播 id }
embed_vod_edit_cancel	点播编辑-取消	{}

定时直播创建页面

类型	说明	内容
embed_time_edit	定时直播创建	{ webinar_id: Number, 直播 id }
embed_time_create_cancel	定时直播创建-取消	{}

定时直播编辑页面

类型	说明	内容
embed_time_edit	定时直播编辑	{ webinar_id: Number, 直播 id }
embed_time_edit_cancel	定时直播编辑-取消	{}

直播详情页面

类型	说明	内容
vhOpenHref	发起直播（嵌入页推送消息到外层页面，外层页面根据消息内容执行跳转。建议新标签页打开)	{ type: 'vhOpenHref', url: ''}

准备

功能页	链接	参数名称	参数说明	传参方式	示例
功能配置	/v3/embed/live/planFunction/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/planFunction/1234564?token=xxx
观看限制	/v3/embed/live/viewRules/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/viewRules/1234564?token=xxx
角色权限	/v3/embed/live/roleInvitation/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/roleInvitation/1234564?token=xxx
暖场视频	/v3/embed/live/warm/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/warm/1234564?token=xxx
嵌入方式	/v3/embed/live/embedCard/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/embedCard/1234564?token=xxx

品牌

功能页	链接	参数名称	参数说明	传参方式	示例
直播间设计器	/v3/embed/live/livingSet/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/livingSet/1234564?token=xxx
防录屏设置	/v3/embed/live/safeScreenSet/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/safeScreenSet/1234564?token=xxx
播放器设置	/v3/embed/live/playerSet/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/playerSet/1234564?token=xxx

互动

功能页	链接	参数名称	参数说明	传参方式	示例
文档	/v3/embed/live/word/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/word/1234564?token=xxx
插播文件	/v3/embed/live/videoSet/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/videoSet/1234564?token=xxx
抽奖	/v3/embed/live/prizeList/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/prizeList/1234564?token=xxx
问卷	/v3/embed/live/question/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/question/1234564?token=xxx
快问快答	/v3/embed/live/exam/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/exam/1234564?token=xxx
礼物	/v3/embed/live/gift/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/gift/1234564?token=xxx

AI 智能

功能页	链接	参数名称	参数说明	传参方式	示例
活动下 AI 聊天列表	/v3/embed/live/AI/chat/list/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/AI/chat/list/123456?token=xxx

回放

功能页	链接	参数名称	参数说明	传参方式	示例
点播管理	/v3/embed/live/recordplayback/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/recordplayback/1234564?token=xxx
回放管理	/v3/embed/live/publishplayback/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/publishplayback/1234564?token=xxx

AI 创作

功能页	链接	参数名称	参数说明	传参方式	示例
智能解析	/v3/saas-web-ai/embed/video/parsing/:id	paas_record_id	回放 id	动态路由	https://e.vhall.com/v3/saas-web-ai/embed/video/parsing/234564?token=xxx
智能字幕	/v3/saas-web-ai/embed/video/subtitles/:id	paas_record_id	回放 id	动态路由	https://e.vhall.com/v3/saas-web-ai/embed/video/subtitles/1234564?token=xxx
精彩时刻	/v3/saas-web-ai/embed/video/moments/:id	paas_record_id	回放 id	动态路由	https://e.vhall.com/v3/saas-web-ai/embed/video/moments/1234564?token=xxx
精彩剪辑	/v3/saas-web-ai/embed/video/clip/:id	paas_record_id	回放 id	动态路由	https://e.vhall.com/v3/saas-web-ai/embed/video/clip/1234564?token=xxx
概要总结	/v3/saas-web-ai/embed/video/summary/:id	paas_record_id	回放 id	动态路由	https://e.vhall.com/v3/saas-web-ai/embed/video/summary/1234564?token=xxx

数据

功能页	链接	参数名称	参数说明	传参方式	示例
用户统计	/live/userData/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/userData/1234564?token=xxx
数据报告	/live/reportsData/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/reportsData/1234564?token=xxx
互动统计	/live/interactionData/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/live/interactionData/1234564?token=xxx

媒资管理

功能页	链接	参数名称	参数说明	传参方式	示例
下载中心	/v3/embed/other/downloadList/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/other/downloadList/1234564?token=xxx

下载中心

功能页	链接	参数名称	参数说明	传参方式	示例
下载中心	/other/downloadList/:id	id	直播 id	动态路由	https://e.vhall.com/v3/embed/other/downloadList/1234564?token=xxx

公共参数#

嵌入 URL#

详细页面链接与传参#

直播管理#

消息列表#

准备#

品牌#

互动#

AI 智能#

回放#

AI 创作#

数据#

媒资管理#

下载中心#