分类： 跳转

wx.copyRealname(Object object)

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

以 Promise 风格 调用：不支持

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

微信小程序插件：不支持

功能描述

实名信息查询与复制。

参数

Object object

属性 类型 默认值 必填 说明
extraData Object 是 透传给目标微信小程序的商户数据（必填）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
extraData Object 商户回传数据

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息

示例代码

wx.copyRealname({
  extraData: { mch_id: '1230000109' },
  success (res) {
    console.log(res.extraData)
  },
  fail (err) {
    console.error(err)
  },
})

wx.openPhotoTopicView(Object object)

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

以 Promise 风格 调用：不支持

微信小程序插件：不支持

功能描述

打开微信官方图片话题发布页。

参数

Object object

属性 类型 默认值 必填 说明
queryString string 否 附加的查询字符串，必须是 key1=val1&key2=val2 的格式。
extraData Object 否 传递给目标业务微信小程序的业务参数。
envVersion string release 否 要打开的微信小程序版本。
合法值 说明
develop 开发版
trial 体验版
release 正式版
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
extraData Object 图片话题发布页返回的业务数据（结构由微信官方业务约定）

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息

示例代码

wx.openPhotoTopicView({
  extraData: {
    // 由目标业务约定的字段
    foo: 'bar',
  },
  success(res) {
    console.log(res)
  },
  fail(err) {
    console.error(err)
  },
})

wx.requestAutomaticRepayment(Object object)

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

以 Promise 风格 调用：不支持

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

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

在微信客户端通过微信小程序拉起页面请求用户确认签约自动还款。调用前需在微信支付合作伙伴平台申请开通「服务商自动还款」。

参数

Object object

属性 类型 默认值 必填 说明
presignToken string 是 预签约生成的预签约码，用于跳转签约页面；有效期10分钟
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息

示例代码

wx.requestAutomaticRepayment({
  presignToken: 'xxxxx',
  success: res => {

  },
  fail: res => {

  }
})

wx.exitMiniProgram(Object object)

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

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.30.1

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

限制：仅在点击行为时调用

功能描述

退出当前微信小程序

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.navigateBackMiniProgram(Object object)

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

以 Promise 风格 调用：支持

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

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

返回到上一个微信小程序。只有在当前微信小程序是被其他微信小程序打开时可以调用成功。

注意：微信客户端 iOS 6.5.9，Android 6.5.10 及以上版本支持

参数

Object object

属性 类型 默认值 必填 说明
extraData Object {} 否 需要返回给上一个微信小程序的数据，上一个微信小程序可在 App.onShow 中获取到这份数据。 详情。
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.navigateBackMiniProgram({
  extraData: {
    foo: 'bar'
  },
  success(res) {
    // 返回成功
  }
})

wx.navigateToMiniProgram(Object object)

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

以 Promise 风格 调用：支持

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.18.1

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

限制：仅在点击行为时调用

功能描述

打开另一个微信小程序

参数

Object object

属性 类型 默认值 必填 说明 最低版本
appId string 否 要打开的微信小程序 appId
path string 否 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在微信小程序的 App.onLaunch、App.onShow 和 Page.onLoad 的回调函数或小游戏的 wx.onShow 回调函数、wx.getLaunchOptionsSync 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 “?foo=bar”。
extraData object 否 需要传递给目标微信小程序的数据，目标微信小程序可在 App.onLaunch，App.onShow 中获取到这份数据。如果跳转的是小游戏，可以在 wx.onShow、wx.getLaunchOptionsSync 中可以获取到这份数据。
envVersion string release 否 要打开的微信小程序版本。仅在当前微信小程序为开发版或体验版时此参数有效。如果当前微信小程序是正式版，则打开的微信小程序必定是正式版。
合法值 说明
develop 开发版
trial 体验版
release 正式版
shortLink string 否 微信小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【微信小程序菜单】->【复制链接】获取。 2.18.1
noRelaunchIfPathUnchanged boolean false 否 不reLaunch目标微信小程序，直接打开目标跳转的微信小程序退后台时的页面，需满足以下条件：1. 目标跳转的微信小程序生命周期未被销毁；2. 且目标当次启动的path、query与上次启动相同，apiCategory以wx.getApiCategory接口的返回结果为准。 2.24.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

使用限制

需要用户触发跳转

从 2.3.0 版本开始，若用户未点击微信小程序页面任意位置，则开发者将无法调用此接口自动跳转至其他微信小程序。

需要用户确认跳转

从 2.3.0 版本开始，在跳转至其他微信小程序前，将统一增加弹窗，询问是否跳转，用户确认后才可以跳转其他微信小程序。如果用户点击取消，则回调 fail cancel。

运营规范

平台将坚决打击微信小程序盒子等互推行为，使用此功能时请严格遵守《微信小程序平台运营规范》，若发现微信小程序违反运营规范将被下架处理。

关于调试

  • 在开发者工具上调用此 API 并不会真实的跳转到另外的微信小程序，但是开发者工具会校验本次调用跳转是否成功。详情
  • 开发者工具上支持被跳转的微信小程序处理接收参数的调试。详情

示例代码

wx.navigateToMiniProgram({
  appId: '',
  path: 'page/index/index?id=123',
  extraData: {
    foo: 'bar'
  },
  envVersion: 'develop',
  success(res) {
    // 打开成功
  }
})

wx.offEmbeddedMiniProgramHeightChange(function listener)

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

微信小程序插件：不支持

功能描述

移除半屏微信小程序可视高度变化事件的监听函数

参数

function listener

onEmbeddedMiniProgramHeightChange 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onEmbeddedMiniProgramHeightChange(listener)
wx.offEmbeddedMiniProgramHeightChange(listener) // 需传入与监听时同一个的函数对象

wx.onEmbeddedMiniProgramHeightChange(function listener)

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

微信小程序插件：不支持

功能描述

监听半屏微信小程序可视高度变化事件

参数

function listener

半屏微信小程序可视高度变化事件的监听函数

参数

Object res
属性 类型 说明
height number 可视高度
initialHeight number 半屏微信小程序初始高度

示例代码

const func = function (res) {
  console.log(res.height)
  console.log(res.initialHeight)
}
wx.onEmbeddedMiniProgramHeightChange(func)
// 取消监听
wx.offEmbeddedMiniProgramHeightChange(func)

wx.openEmbeddedMiniProgram(Object object)

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

以 Promise 风格 调用：支持

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.26.2

微信 鸿蒙 OS 版：支持

功能描述

打开半屏微信小程序。接入指引请参考 半屏微信小程序能力。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
appId string 是 要打开的微信小程序 appId
path string 否 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在微信小程序的 App.onLaunch、App.onShow 和 Page.onLoad 的回调函数或小游戏的 wx.onShow 回调函数、wx.getLaunchOptionsSync 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 “?foo=bar”。
extraData object 否 需要传递给目标微信小程序的数据，目标微信小程序可在 App.onLaunch，App.onShow 中获取到这份数据。如果跳转的是小游戏，可以在 wx.onShow、wx.getLaunchOptionsSync 中可以获取到这份数据数据。
envVersion string release 否 要打开的微信小程序版本。仅在当前微信小程序为开发版或体验版时此参数有效。如果当前微信小程序是正式版，则打开的微信小程序必定是正式版。
合法值 说明
develop 开发版
trial 体验版
release 正式版
shortLink string 否 微信小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【微信小程序菜单】->【复制链接】获取。仅 verify=binding 支持。
verify string binding 否 校验方式。 2.24.3
合法值 说明
binding 校验微信小程序管理后台的绑定关系。
unionProduct 校验目标打开链接是否为微信小程序联盟商品。
noRelaunchIfPathUnchanged boolean false 否 不reLaunch目标微信小程序，直接打开目标跳转的微信小程序退后台时的页面，需满足以下条件：1. 目标跳转的微信小程序生命周期未被销毁；2. 且目标当次启动的path、query与上次启动相同，apiCategory以wx.getApiCategory接口的返回结果为准。 2.24.0
allowFullScreen boolean false 否 打开的微信小程序是否支持全屏。基础库 3.10.0 版本起，强制为 true 2.33.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.openInquiriesTopic(Object object)

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

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

通过微信小程序打开问一问话题

参数

Object object

属性 类型 默认值 必填 说明
pageId string 是 落地页 id，需在指定页面点击右上角三个点的「复制 ID」按钮获取
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数
Object err
属性 类型 说明
errMsg string 错误信息

示例代码

wx.openInquiriesTopic({
  pageId:'', // 填写落地页 id
  success: res => {

  },
  fail: res => {

  }
})