网易会议 Web/H5 端参数配置说明
本文提供网易云信私有化部署过程中网易会议产品 Web/H5 端的关键参数配置说明,帮助技术工程师正确配置客户端与服务端连接参数,确保系统正常运行。
配置参数概述
网易会议系统是一个综合性的视频会议产品,包含 IM、RTC、白板等多个子系统,需要配置的参数较为复杂。本文详细列出了 Web/H5 端所需的全部配置参数,包括参数名称、配置说明及示例。
配置流程说明
配置过程中请确保参数名称、格式完全匹配,任何错误都可能导致连接失败。
- 服务器部署:技术人员首先需要完成服务器端部署。
- 获取服务器配置参数:从部署完成的服务器获取配置 JSON 数据。
- 客户端配置:根据本文将服务器参数正确映射到客户端 SDK 中。
- 验证连接:测试客户端是否能正确连接到私有化环境。
关键参数解释
会议系统包含多个子系统,每个子系统都需要特定的配置:
- 白板系统:提供实时协作白板功能,包括绘图、文档共享等
- roomkit:会议房间管理模块,处理房间创建、加入等基础操作
- meeting 服务:提供会议预约、管理、控制等业务逻辑功能
参数配置建议
IM 模块
参数名 | 配置说明 | Web/H5 配置建议 | Electron |
---|---|---|---|
weblbsUrl | Web 端获取客户端连接 link 的地址(客户端会请求 LBS 地址,LBS 会返回一连串能连接的 link 数组给客户端登录) | NEIMServerConfig 下的 lbs | - |
link_web | Web 默认 link 地址(在 LBS 获取不到 link 的情况下,请求默认 link 连接) | NEIMServerConfig 下的 link | - |
link_ssl_web | Web 端使用使用 HTTPS 连接 | NEIMServerConfig 下的 linkSslWeb | - |
nos_Support_Https | nos 是否开启 HTTPS | NEIMServerConfig 下的 httpsEnabled | - |
nos_uploader_web | 分片/非分片共用文件上传地址,浏览器默认分片,小程序默认不分片(不分片是用表单来做的上传) | NEIMServerConfig 下的 nosUploader | - |
lbs | IM LBS 服务器地址,通过它获取 IM link 地址信息 | 无 | - |
link | IM 默认的 link 服务器地址,当 IM LBS 不可用时先连接该地址 | 无 | - |
nos_lbs | NOS 上传 LBS 服务器地址 | NEIMServerConfig 下的 nosLbs | - |
nos_uploader | NOS 上传默认的 link 服务器地址,当 NOS LBS 不可用时先连接该地址 | 无 | - |
nos_uploader_host | NOS 上传服务器主机地址(仅 nos_Support_Https=true 时有效,用作 HTTPS 上传时的域名校验及 http header host 参数填充) | 无 | - |
module | 连接网易云信服务器加密数据通道的公钥参数 | 无 | - |
nos_downloader | NOS 下载地址拼接模板,用于拼接最终得到的下载地址 | NEIMServerConfig 下的 nosDownloader | - |
nos_accelerate | NOS 下载加速域名/地址,用于替换 NOS 下载 url 中的 nosDownload。[4.6.0 版本新增] | 无 | - |
nos_accelerate_host | NOS 下载地址的 host,用于拼接最终获得的文件 URL 地址,也支持该 host 替换成下载加速域名/地址。[4.4.0+开始支持] | 无 | - |
version | 连接网易云信服务器加密数据通道的公钥的版本号(默认 0) | 无 | 无 |
bd_server | 网易云信 Wi-Fi 统计地址。如果有私有化配置,而这一项没设置,则不做统计 | 无 | 无 |
nt_server | 网易云信运行时异常统计服务器地址。如果有私有化配置,而这一项没设置,则不做统计 | 无 | 无 |
kibana_server | 音视频通话上报/statistic/realtime/sdkinfo | 无 | 无 |
statistic_server | 音视频通话上报/statistic/realtime/sdkFunctioninfo | 无 | 无 |
report_global_server | 音视频通话上报/statics/report/realtime/global | 无 | 无 |
RTC 模块
参数名 | 配置说明 | Web/H5 配置建议 | Electron |
---|---|---|---|
lbsServer | 参数下发和第一跳访问地址。从 5.5.x 开始私有化需要配置 | lbsServer | - |
channelServer | 加房间用的信令服务器地址 | channelServer | - |
statisticsServer | 统计上报服务相关地址 | statisticsServer | - |
statisticsDispatchServer | 统计上报服务相关地址 | statisticsDispatchServer | - |
statisticsWebSocketServer | 统计上报服务相关地址(Web 端需要) | statisticsWebSocketServer | - |
statisticsBackupServer | 统计上报服务相关地址 | statisticsBackupServer | - |
roomServer | 互动直播服务地址 | roomServer | - |
compatServer | 老版本的参数下发服务地址 | compatServer | - |
nosLbsServer | 内置对象存储服务地址 | - | - |
nosUploadSever | 内置对象存储服务地址 | - | - |
nosTokenServer | 内置对象存储服务地址 | - | - |
cloudProxyServer | 云代理功能配置的服务器地址 | - | - |
webSocketProxyServer | WebSocket 信令代理 | - | - |
statisticsProxyServer | 打点上报代理 | - | - |
mediaProxyServer | 媒体流转发代理 | - | - |
useIPv6 | 是否使用 IPv6 | - | - |
互动白板模块
参数名 | 配置说明 | Web/H5 配置建议 | Electron |
---|---|---|---|
webServer | 白板 SDK 的地址 | NEWhiteboardServerConfig 下的 WhiteboardUrl | - |
recordPlayUrl | 白板回放 url | - | |
roomServer | getChannelInfo 接口的地址。用于创建加入白板房间 | NEWhiteboardServerConfig 下的 roomServer | - |
sdkLogNosServer | 白板日志上传接口地址。默认为 https://statistic.live.126.net/sdklog/getToken | NEWhiteboardServerConfig 下的 sdkLogNosServer | - |
dataReportServer | 白板日志上报地址。默认为 https://statistic.live.126.net/statics/report/common/form | NEWhiteboardServerConfig 下的 dataReportServer | - |
directNosServer | nos 直传地址。默认为 https://wanproxy-web.127.net | NEWhiteboardServerConfig 下的 directNosServer | - |
mediaUploadServer | 音视频,图片上传地址。默认为 https://vcloud.163.com | NEWhiteboardServerConfig 下的 mediaUploadServer | - |
docTransServer | 文档转码地址 | NEWhiteboardServerConfig 下的 docTransServer | - |
fontDownloadServer | fontDownloadServer | - | |
WhiteboardUrl | 白板 SDK JavaScript 文件地址 | NEWhiteboardServerConfig 下的 WhiteboardUrl | - |
ToolCollectionUrl | 白板工具集合 JavaScript 文件地址 | NEWhiteboardServerConfig 下的 ToolCollectionUrl | - |
PPTRendererUrl | PPT 渲染器 JavaScript 文件地址 | NEWhiteboardServerConfig 下的 PPTRendererUrl | - |
房间组件模块
参数名 | 配置说明 | Web/H5 配置建议 | Electron |
---|---|---|---|
roomServer | 房间组件服务器地址配置 | roomServer | - |
lbsServer | 会议域名高可用的服务地址 | lbsServer | - |
meeting | 会议服务器地址配置 | serverUrl | - |
feedbackUploadUrl | 问题反馈上报的地址。组件层配置 | feedbackUploadUrl | - |
cloudRecordUrl | 录制详情页地址。网易会议应用层配置 | cloudRecordUrl | - |
recordPageUrl | 录制列表页地址。网易会议应用层配置 | recordPageUrl | - |
配置示例
{
"corpCode": "yunxin",
"module": {
"nps": {
"enable": true
},
"feedback": {
"enable": true
},
"appUpgrade": {
"enable": true,
"iosCheckUrl": "https://apps.apple.com/cn/app/%E7%BD%91%E6%98%93%E4%BC%9A%E8%AE%AE/id1525524757"
},
"about": {
"privacyUrl": "https://meeting.163.com/privacy/agreement_mobile_ysbh_wap.shtml",
"userProtocolUrl": "https://netease.im/meeting/clauses?serviceType=0"
}
},
"meeting": {
"serverUrl": "https://yunxin-solution.netease.im/neroom/",
"feedbackUploadUrl": "https://yunxin-solution.netease.im/report/statics/report/common/form",
"cloudRecordUrl": "https://yunxin-solution.netease.im/meeting/site/#/recordInfo"
},
"roomkit": {
"roomServer": "https://yunxin-solution.netease.im/neroom/",
"lbsServer": "https://yunxin-solution.netease.im/api/v1/domains"
},
"im": {
"appkey": "722221acd1b8aa96d8ee************",
"lbsUrl": "https://yunxin-solution.netease.im/lbs/conf.jsp",
"weblbsUrl": "https://yunxin-solution.netease.im/lbs/webconf.jsp",
"nosReplacement": "http://nos.netease.im",
"nosAccess": "http://115.238.125.243:8000",
"pubkeyVersion": "0",
"chatroomDemoListUrl": "https://yunxin-solution.netease.im/lbs/chatroomList.jsp",
"websdkSsl": true,
"nosSsl": true,
"webchatroomAddr": [
"yunxin-solution.netease.im"
],
"module": "00e3afe7487e6ac9ba69************dc05d5b6d45850859f11004d30c63e3691afd55722bdd2c75232b2a3561776201f84def8e38c508870ca7692b4228b0478e104460d7800dee3b6c3d8f89746ed48ee94f268f42b9c911437083d3815624e50de3fec3c0ec8ab3e71d5bdce3f4291d20538893cacdc00da9d1390ee39440d",
"version": 0,
"lbs": "https://yunxin-solution.netease.im/lbs/conf.jsp",
"link": "111.124.203.122:10180",
"link_web": "https://yunxin-solution.netease.im/",
"nos_lbs": "https://yunxin-solution.netease.im/lbs/noslbs.jsp",
"nos_uploader": "https://yunxin-solution.netease.im/",
"nos_uploader_host": "yunxin-solution.netease.im",
"chunkUploadHost": "https://yunxin-solution.netease.im/",
"uploadReplaceFormat": "yunxin-solution.netease.im/yunxin/{object}",
"https_enabled": true,
"nos_downloader": "yunxin-solution.netease.im/{bucket}/{object}",
"nos_downloader_v2": "yunxin-solution.netease.im/yunxin/{object}",
"nos_accelerate": "",
"nos_accelerate_host": "",
"nt_server": "",
"kibana_server": "",
"statistic_server": "",
"report_global_server": "",
"multi_video": 1,
"hand_shake_type": 0,
"nego_key_neca": 1,
"nego_key_enca_key_version": 0,
"nego_key_enca_key_parta": "e3afe7487e6ac9ba69654672672ceddc05d5b6d45850859f11004d30c63e3691afd55722bdd2c75232b2a3561776201f84def8e38c508870ca7692b4228b0478e104460d7800dee3b6c3d8f89746ed48ee94f268f42b9c911437083d3815624e50de3fec3c0ec8ab3e71d5bdce3f4291d20538893cacdc00da9d1390ee39440d",
"nego_key_enca_key_partb": "10001",
"comm_enca": 1
},
"rtc": {
"lbsServer": "https://yunxin-solution.netease.im/api/v1/domains",
"channelServer": "https://yunxin-solution.netease.im/nrtc/getChannelInfos.action",
"statisticsServer": "https://yunxin-solution.netease.im/report/statics/report/common/form",
"statisticsDispatchServer": "https://yunxin-solution.netease.im/lps-websocket/websocket/dispatch",
"statisticsWebSocketServer": "wss://yunxin-solution.netease.im/lps-websocket/websocket/collect",
"statisticsBackupServer": "https://yunxin-solution.netease.im/report/statics/report/nrtc2/sdkstats",
"roomServer": "https://yunxin-solution.netease.im/v2/sdk/rooms",
"compatServer": "https://yunxin-solution.netease.im/api/v1/client_config",
"nosLbsServer": "https://yunxin-solution.netease.im/lbs/noslbs.jsp",
"nosUploadSever": "https://yunxin-solution.netease.im/",
"nosTokenServer": "https://yunxin-solution.netease.im/report/sdklog/getToken",
"useIPv6": false
},
"whiteboard": {
"lbsUrl": "https://yunxin-solution.netease.im/api/v1/domains",
"webServer": "https://yunxin-solution.netease.im/whiteboard/webview/g2/webview.html",
"roomServer": "https://yunxin-solution.netease.im/v1/g2/whiteboard/getChannelInfo",
"sdkLogNosServer": "https://yunxin-solution.netease.im/report/sdklog/getToken",
"dataReportServer": "https://yunxin-solution.netease.im/report/statics/report/common/form",
"directNosServer": "https://yunxin-solution.netease.im/",
"mediaUploadServer": "https://yunxin-solution.netease.im/",
"docTransServer": "https://yunxin-solution.netease.im/",
"fontDownloadServer": "https://wb.vod.126.net/courseware/pptview/fonts/",
"WhiteboardUrl": "https://yunxin-solution.netease.im/whiteboard/webview/g2/sdk/WhiteBoardSDK_v3.9.15.js",
"ToolCollectionUrl": "https://yunxin-solution.netease.im/whiteboard/webview/g2/sdk/ToolCollection_v3.9.15.js",
"PPTRendererUrl": "https://yunxin-solution.netease.im/whiteboard/webview/g2/sdk/pptRenderer_v3.9.15.js"
},
"mixPushConfig": {
"android": {
"xmAppId": "",
"xmAppKey": "",
"xmCertificateName": "",
"hwAppId": "",
"hwCertificateName": "",
"mzAppId": "",
"mzAppKey": "",
"mzCertificateName": "",
"fcmCertificateName": "",
"vivoApiKey": "",
"vivoAppId": "",
"vivoCertificateName": "",
"oppoAppId": "",
"oppoAppKey": "",
"oppoAppSecret": "",
"oppoCertificateName": "",
"honorCertificateName": "",
"autoSelectPushType": false
},
"ios": {
"apnsCerName": "meetingPush"
}
}
}
最后更新于