wx.getShareInfo(Object object)

从基础库 2.17.3 开始,本接口停止维护,请使用 wx.getGroupEnterInfo 代替

基础库 1.1.0 开始支持,低版本需做兼容处理。

以 Promise 风格 调用:不支持

需要页面权限:当前是插件页面时,宿主微信小程序不能调用该接口,反之亦然

微信小程序插件:支持,需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时,只能在当前插件的页面中调用

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

功能描述

获取转发详细信息(主要是获取群ID)。 从群聊内的微信小程序消息卡片打开微信小程序时,调用此接口才有效。从基础库 v2.17.3 开始,推荐用 wx.getGroupEnterInfo 替代此接口。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
shareTicket string shareTicket,详见获取更多转发信息
timeout number 超时时间,单位 ms 1.9.90
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
errMsg string 错误信息
encryptedData string 包括敏感数据在内的完整转发信息的加密数据,详细见加密数据解密算法
iv string 加密算法的初始向量,详细见加密数据解密算法
cloudID string 敏感数据对应的云 ID,开通云开发的微信小程序才会返回,可通过云调用直接获取开放数据,详细见云调用直接获取开放数据 2.7.0

示例代码

敏感数据获取方式 加密数据解密算法 。 获取得到的开放数据为以下 json 结构(其中 openGId 为当前群的唯一标识):

{
 "openGId": "OPENGID"
}

Tips

  • 如需要展示群名称,微信小程序可以使用 开放数据组件
  • 小游戏可以通过 wx.getGroupInfo 接口获取群名称