文档中心>腾讯会议>开放平台文档>腾讯会议小程序对接指引

腾讯会议小程序对接指引

最近更新时间:2024-07-19 10:41:01

我的收藏

适用场景

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

代码示例

1分钟快速完成对接,您可直接 copy 以下代码,试试效果吧。
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}`);
},
})


参数说明

名称
描述
格式
pages/index/index[?chn=fromWhere[&code=meetingCode[&pwd=password][&nm=nickname]][&customerData=yourCustomerData]]
字段说明
chn - 可选。表示来源渠道标识,建议格式为首字母大写的字母、数字组合,具体名称可自行定义。例如第三方为小白兔公司,可赋值"WhiteRabbit"。
code - 可选。表示会议码,格式为9~12位数字,例如123456789。
pwd - 可选。表示会议密码,格式为4~6位数字、字母的组合,例如abc123。
nm - 可选。表示入会昵称,需使用 encodeURIComponent 编码。
customerData - 可选。表示第三方数据(base64格式),例如 eyJ2ZXIiOiIxLjAiLCJ1c2VyRGF0YSI6ImhlbGxvIHdvcmxkISJ9,它被解码并反序列化为 JSON 后是:{"ver":"1.0","userData":"hello world!"}



在线编解码工具: Base64编码、解码
注意:
小程序调用方传递 customerData 时需使用 Base64 编码,且编码后的长度不要超过256字节。
后续通过腾讯会议 RestAPI 或者 WebHook 回调获取到的 customerData 字段是明文,无需再次进行 base64 解码。
参数有什么用?用于给用户生成特定的入会链接,方便第三方应用识别当前用户的身份。如果第三方对接了腾讯会议 webhook,则带这个参数的成员入会时,第三方服务端将会收到腾讯会议 webhook 推送的消息,表示成员加入了会议,并携带包括 customerData 在内的参数。
其他场景备注
如果未传入 code,则跳转到腾讯会议小程序后会停留在首页。
如果会议未设置密码,则传入的 pwd 会被忽略。
如果会议设置了密码:
当传入正确的 pwd 时,跳转到腾讯会议小程序后会自动入会。
当传入错误的 pwd 时,跳转到腾讯会议小程序后将不会自动入会,会提示密码错误,可在腾讯会议小程序加入会议界面修改密码后加入。

不同跳转场景开发说明

1. 跳转到首页(不带会议号)

pages/index/index?chn=ExampleChannel




2. 无密码的会议(带会议号)

pages/index/index?chn=ExampleChannel&code=561767737




3. 有密码的会议(带会议号和密码)

说明:
给错了就停留在这里,给对了就会直接入会。
pages/index/index?chn=ExampleChannel&code=396839244&pwd=123457




4. 有密码的会议(带会议号和不带密码)

pages/index/index?chn=ExampleChannel&code=396839244



注意:
跳转到该页面时,需要用户按照微信小程序指引去授权或者验证手机号,政策要求入会需要实名。




5. 前往具体的会议录制页面

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




参考文档