tencent cloud

腾讯云超级应用服务

文档腾讯云超级应用服务小程序开发指南API跳转

跳转

下载
聚焦模式
字号
最后更新时间： 2026-08-25 18:17:29

exitMiniProgram

该 API 使用方法为 wx.exitMiniProgram(Object object)
功能说明：退出当前小程序。必须有单击行为才能调用成功。
参数及说明：Object object。
属性
类型
默认值
必填
说明
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）

navigateToMiniProgram

该 API 使用方法为 wx.navigateToMiniProgram(Object object)
功能说明：打开另一个小程序。
参数及说明：Object object。
属性
类型
默认值
必填
说明
appId
string
-
是
要打开的小程序 appId
path
string
-
否
打开的页面路径，如果为空则打开首页。 path 中 ? 后面的部分会成为 query，在小程序的 App.onLaunch，App.onShow 和 Page.onLoad 的回调函数或 wx.getLaunchOptionsSync 中可以获取到 query 数据。
extraData
object
-
否
需要传递给目标小程序的数据，目标小程序可在 App.onLaunch，App.onShow 中获取到这份数据
envVersion
string
release
否
要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版，其合法值如下：
develop：开发版
trial：体验版
release：正式版
urlContent
string
-
否
要打开的小程序的链接内容，可接受 wx.scanCode 的扫码结果链接。当同时传入 appId 和 urlContent，优先使用 urlContent 跳转。
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）

使用限制

需要用户触发跳转

若用户未单击小程序页面任意位置，则开发者将无法调用此接口自动跳转至其他小程序。

需要用户确认跳转

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

所跳转的 appId 必须在navigateToMiniProgramAppIdList配置列表中（仅小游戏限制）

开发者提交小游戏代码时，如使用了跳转其他小程序/小游戏功能，则需要在代码配置中声明将要跳转的小程序/小游戏名单，该名单可在发布新版时更新，不支持动态修改。配置方法详见 配置。调用此接口时，所跳转的 appId 必须在配置列表中，否则回调 fail appId "${appId}" is not in navigateToMiniProgramAppIdList。
示例代码：
wx.navigateToMiniProgram({
  appId: '',
  path: 'page/index/index?id=123',
  extraData: {
    foo: 'bar'
  },
  envVersion: 'develop',
  urlContent: '',
  success(res) {
    // 打开成功
  }
})

navigateBackMiniProgram

该 API 使用方法为 wx.navigateBackMiniProgram(Object object)
说明：
该 API 小程序支持，小游戏暂不支持。
功能说明：返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功。
参数及说明：Object object。
属性
类型
默认值
必填
说明
extraData
Object
{}
否
需要返回给上一个小程序的数据，上一个小程序可在 App.onShow 中获取到这份数据
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
示例代码：
wx.navigateBackMiniProgram({
  extraData: {
    foo: 'bar'
  },
  success(res) {
    // 返回成功
  }
})

openEmbeddedMiniProgram

该 API 使用方法为 wx.openEmbeddedMiniProgram(Object object)
功能说明：打开半屏小程序。
参数及说明：Object object。
属性
类型
默认值
必填
说明
appId
string
-
是
要打开的小程序 appId
path
string
-
否
打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 App.onLaunch、App.onShow 和 Page.onLoad 的回调函数中可以获取到 query 数据。
extraData
object
-
否
需要传递给目标小程序的数据，目标小程序可在 App.onLaunch，App.onShow 中获取到这份数据。
envVersion
string
release
否
要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版，其合法值如下：
develop：开发版
trial：体验版
release：正式版
urlContent
string
-
否
要打开的小程序的链接内容，可接受 wx.scanCode 的扫码结果链接。当同时传入 appId 和 urlContent，优先使用 urlContent 跳转。
noRelaunchIfPathUnchanged
boolean
false
否
不重启目标小程序，直接打开目标跳转的小程序退到后台时的页面，需满足以下条件：1. 目标跳转的小程序生命周期未被销毁；2. 且目标小程序当次启动的 path、query 与上次启动相同。
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
示例代码：
wx.openEmbeddedMiniProgram({
  appId: '',
  path: 'page/index/index?id=123',
  extraData: {
    foo: 'bar'
  },
  envVersion: 'release',
  success(res) {
    // 打开成功
  }
})

onEmbeddedMiniProgramHeightChange

该 API 使用方法为 wx.onEmbeddedMiniProgramHeightChange(function listener)
功能说明：监听半屏小程序可视高度变化事件。
参数及说明：function listener，半屏小程序可视高度变化事件的监听函数。
listener 回调函数的参数为 Object res：
属性
类型
说明
height
number
可视高度
initialHeight
number
半屏小程序初始高度
示例代码：
const listener = function (res) {
  console.log(res.height)
  console.log(res.initialHeight)
}
wx.onEmbeddedMiniProgramHeightChange(listener)

offEmbeddedMiniProgramHeightChange

该 API 使用方法为 wx.offEmbeddedMiniProgramHeightChange(function listener)
功能说明：移除半屏小程序可视高度变化事件的监听函数。
参数及说明：function listener，onEmbeddedMiniProgramHeightChange 传入的监听函数。不传此参数则移除所有监听函数。
示例代码：
const listener = function (res) {
  console.log(res)
}
wx.onEmbeddedMiniProgramHeightChange(listener)
wx.offEmbeddedMiniProgramHeightChange(listener) // 需传入与监听时同一个的函数对象

restartMiniProgram

该 API 使用方法为 wx.restartMiniProgram(Object object)
功能说明：重启当前小程序。
参数及说明：Object object。
属性
类型
默认值
必填
说明
path
string
-
否
打开的页面路径，path 中 ? 后面的部分会成为 query。
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
示例代码：
wx.restartMiniProgram({
  path: 'pages/index/index',
  success(res) {
    // 重启成功
  }
})

上一篇: 路由下一篇: 转发

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档