Skip to main content
Version: Next

Taro.getGroupEnterInfo(option)

获取微信群聊场景下的小程序启动信息。群聊场景包括群聊小程序消息卡片、群待办、群工具。可用于获取当前群的 opengid。

Tips

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

支持情况：

参考文档

类型​

(option?: Option) => Promise<TaroGeneral.CallbackResult>

参数​

参数类型
optionOption

Option​

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void否接口调用结束的回调函数（调用成功、失败都会执行）
fail(res: TaroGeneral.CallbackResult) => void否接口调用失败的回调函数
success(result: SuccessCallbackResult) => void否接口调用成功的回调函数

SuccessCallbackResult​

参数类型必填说明
errMsgstring是错误信息
encryptedDatastring是包括敏感数据在内的完整转发信息的加密数据，详细见加密数据解密算法
ivstring是加密算法的初始向量，详细见加密数据解密算法
cloudIDstring否敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细见云调用直接获取开放数据

示例代码​

Taro.getGroupEnterInfo({
  success(res) {
    // res
    {
      errMsg: 'getGroupEnterInfo:ok',
      encryptedData: '',
      iv: ''
    }
  },
  fail() { }
})

敏感数据有两种获取方式，一是使用 加密数据解密算法 。 获取得到的开放数据为以下 json 结构（其中 opengid 为当前群的唯一标识）：

{
  "opengid": "OPENGID"
}