wx.miniapp.shareMiniProgramMessage
WARNING
请注意,当前域名 https://dev.weixin.qq.com/docs/framework
文档已不维护,请前往微信文档中心 找到对应的新文档继续使用
分享小程序卡片到微信
注:
1、该接口需要申请和初始化微信 open 能力,需要客户端进行相关配置
2、该接口不支持在「移动应用助手」中调试,开发者需构建 apk 或者 ipa 安装到手机后才能调试
接入前注意事项
- 该能力依赖微信 Open SDK ,需按照指引在微信开放平台创建移动应用账号,以完成相关初始化配置,详情可查看微信移动应用能力初始化指引
参数
方便开发者理解,wx.miniapp.shareMiniProgramMessage 参数与微信开放平台 opensdk 分享接口参数一致
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
userName | string | - | 是 | 小程序原始ID,如 gh_d43f693ca31f,点击查看获取方式 |
path | string | - | 是 | 小程序页面路径;对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 "?foo=bar" |
title | string | - | 是 | 视频标题 |
description | string | - | 是 | 视频描述 |
imagePath | string | - | 是 | 分享小程序相关缩略图,支持代码包图片资源路径或者本地临时、缓存、用户文件;不支持网络图片路径 |
webpageUrl | string | - | 是 | 兼容低版本的网页链接 url |
withShareTicket | string | - | 是 | 通常开发者希望分享出去的小程序被二次打开时可以获取到更多信息,例如群的标识。可以设置 withShareTicket 为 true,当分享卡片在群聊中被其他用户打开时,可以获取到 shareTicket,用于获取更多分享信息。详见小程序获取更多分享信息 ,最低客户端版本要求:6.5.13 |
miniprogramType | number | - | 是 | 0-正式版,1-开发版,2-体验版 |
scene | number | - | 是 | 发送的目标场景,只支持会话,0=分享到会话 |
注意: 发起分享的 App 与小程序属于同一微信开放平台账号(即,需要将小程序 Appid 绑定到「微信开放平台 - 管理中心 - 小程序」),更多注意事项可查看微信开放平台移动应用文档说明。
JSAPI 代码例子
wx.miniapp.shareMiniProgramMessage({
// 注: 小程序原始id 不是小程序 appid,通常是 gh_xxx 开头的内容, 如 gh_d43f693ca31f
userName: '小程序原始id',
path: 'pages/index/index',
imagePath: '/pages/thumb.png',
webpageUrl: 'www.qq.com',
withShareTicket: true,
miniprogramType: 0,
scene: 0,
success(res) {
wx.showToast({
title: '成功:分享小程序',
})
console.log(res)
},
fail() {
wx.showToast({
title: '失败:分享小程序',
})
}
})