文档中心>腾讯会议>开放平台文档>最佳实践>实现拉起腾讯会议微信小程序入会

实现拉起腾讯会议微信小程序入会

最近更新时间:2024-11-29 15:43:32

我的收藏

使用场景

第三方应用服务商或企业通过微信小程序提供培训教学、问诊、视频咨询等服务,可通过 API 预定视频会议,在引导用户参会的环节,开发者可参照本文档,通过唤起腾讯会议微信小程序的方式来快速入会,降低用户使用视频会议的门槛。

实现方案

完整代码示例

您可通过以下示例代码,实现从业务微信小程序拉起腾讯会议微信小程序的交互体验。
const meetingCode = '948050239'; // 会议码
const password = '6666'; // 会议密码
const channel = 'ExampleChannel'; // 从哪里跳转到腾讯会议小程序的
const nickname = encodeURIComponent('小程序用户'); // 入会昵称

wx.navigateToMiniProgram({
appId: 'wx33fd6cdc62520063', // 跳转的目标小程序(腾讯会议小程序AppId)
path: `pages/index/index?chn=${channel}&code=${meetingCode}&pwd=${password}&nm=${nickname}`, // 跳转到的页面路径
extraData: {

},
envVersion: 'release', // 是指要打开的小程序的版本,默认为'release'
success(res) {
// 打开成功
},
fail(err) {
// 打开失败
console.error(`launch Tencent Meeting Miniprogram failed: ${err.errMsg}`);
},
})

控制跳转腾讯会议微信小程序后的页面路径

您可以基于“path”字段控制跳转到腾讯会议微信小程序后的具体页面,格式示例及参数说明如下:

路径格式示例

pages/index/index[?chn=fromWhere[&code=meetingCode[&pwd=password][&nm=nickname]][&customerData=yourCustomerData]]

参数说明

参数名称
必选
参数描述
chn
来源渠道标识,建议格式为首字母大写的字母、数字组合,具体名称可自行定义。例如第三方为小白兔公司,可赋值"WhiteRabbit"。
code
需要进入的会议号,格式为9~12位数字,例如123456789;如果未传该字段,则跳转到腾讯会议小程序后会停留在首页。
pwd
会议密码,格式为4~6位数字、字母的组合,例如abc123;
如果目标会议未设置密码,则传入的 pwd 会被忽略。
如果传入错误的入会密码时,跳转到腾讯会议微信小程序后将不会自动入会并提示密码错误,需要用户手动修改密码后加入。
nm
入会昵称,需使用 encodeURIComponent 编码。
customerData
用户专属字段,用于给用户生成特定的入会链接,方便第三方应用识别当前用户的身份。具体方法是:通过此链接并携带 customerData 跳转入会的用户,开发者可以从“用户入会”的服务端 Webhook 中拿到 customer_data 字段,实现用户身份的识别。
注意:
传递时需使用 Base64 编码,且编码后的长度不要超过256字节。
后续通过腾讯会议 RestAPI 或者 WebHook 回调获取到的 customerData 字段是明文,无需再次进行 base64 解码。

跳转页面示例

场景
示例代码
页面示意

跳转到首页

path: `pages/index/index?chn=ExampleChannel`




无密码的会议入会

path: `pages/index/index?chn=ExampleChannel&code=561767737`




有密码的会议入会

(传入密码)

path: `pages/index/index?chn=ExampleChannel&code=396839244&pwd=123457`
说明:
密码错误或未输入密码就会停留在当前页面。
密码正确则直接入会。
如果用户未完成实名认证,此页面会引导用户去授权或者验证手机号,政策要求入会需要实名。




有密码的会议入会

(未传密码)
path: `pages/index/index?chn=ExampleChannel&code=396839244`




前往某个录制文件的详情页

path: `pages/sub-web/web/web?url=${encodeURIComponent(xxxx)}`
说明:
xxxx 替换为具体的录制文件链接 url,不要进行 url 的编码,url 是什么就传递什么。




参考文档

更多相关信息,可参见 微信小程序官方文档