网页 SDK
基于 JavaScript SDK 实现网页端音视频通话、Room 连接、推拉流与信令通信。
微议Pro开发者文档
快速集成音视频会议、即时通讯与直播能力
Skip to content
快速入门
SDK 概览
微议Pro 提供网页、Android、iOS 三套 SDK，覆盖 Web 与移动端音视频会议场景：
| SDK | 说明 |
|---|---|
| 网页 SDK | JavaScript SDK，Room 连接、推拉流、信令、设备与媒体流管理 |
| 安卓 SDK | Android 原生集成，WySdk 入会流程与 API |
| iOS SDK | iOS 原生 UI SDK，WeiYiProSDK 接入与 API |
系统要求
| 平台 | 最低版本 |
|---|---|
| Windows | Windows 10 及以上 |
| Android | Android 8.0 (API 26) 及以上 |
| iOS | iOS 14 及以上 |
| Web | Chrome 90+、Edge 90+、Firefox 95+、Safari 15+ |
集成方式
微议Pro 提供两种集成方式，从零代码到 H5 页面接入，满足不同场景需求。
方式一：协议拉起（零代码，5 分钟接入）
通过自定义协议拉起微议Pro 客户端，或通过 H5 链接在浏览器中入会，无需编写 SDK 代码。
客户端启动（自定义协议）：
weiyi://https://域名/h5/index.html?serial=xxxx&userid=xxx&username=xxxx示例：
weiyi://https://your-domain.com/h5/index.html?serial=754884357&userid=123456&username=张三网页入会（H5 多参数）：
https://域名/h5/#/login?serial=xxxx&userid=xxx&username=xxxx&invisible=1&joinRole=presenter示例：
https://your-domain.com/h5/#/login?serial=754884357&userid=123456&username=张三&invisible=0&joinRole=presenter| 参数 | 说明 |
|---|---|
| serial | 会议号 |
| userid | 用户 ID，需保持唯一 |
| username | 昵称 |
| invisible | 0 可见，1 隐身 |
| joinRole | presenter 普通用户，speaker 主讲，chairman 主席 |
适用于已安装微议Pro 客户端的场景，或需要在浏览器中直接打开 H5 会面的场景。
方式二：UI SDK（带界面，1 天接入）
通过 H5 页面 URL 加入会议，使用微议Pro 预置的会议界面，无需自行开发 UI。
多参数方式：
https://域名/h5/#/login?serial=123456789&userid=1234&username=name&invisible=1&joinRole=presenter单参数 Token 方式：
https://域名/h5/index.html?token=加密后的token字符串Token 由服务端使用 AES 加密生成，参数 JSON 示例：
json
{"serial":"111111","userid":"123456","username":"weiyi我","joinRole":"presenter"}完整 Token 生成示例（Java / PHP）见 Web 服务器 API — URL 加入会议（单参数）。
UI SDK 提供开箱即用的会议界面，包括视频窗口布局、工具栏、参会者列表等。iframe 嵌入时需添加 allow="geolocation; microphone; camera;display-capture"。
下一步
- 网页 SDK 接入指南 — JavaScript SDK 连接 Room、推拉流与信令
- 安卓 SDK 接入指南 — WySdk 初始化、入会、推拉流
- iOS SDK 接入指南 — WeiYiProSDK 配置、入会、URL Scheme
- 接口 API — Web 服务器 API、媒服服务器 API、文档服务器 API