@doubao-dev/plugin-app-dev 0.0.0-stage → 0.0.40-canary-dea0ddc73-20261026073950

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/06-/350/267/257/347/224/261.md

@@ -0,0 +1,839 @@
+# 豆包应用插件的端能力 API: 路由
+
+应用内页面跳转、返回、退出和关闭。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [navigateTo](#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](#exitapp) | 退出当前所有页面。 |
+| [navigateToDouyinMiniProgram](#navigatetodouyinminiprogram) | 在豆包内打开指定版本的抖音应用插件。 |
+| [openPage](#openpage) | 打开应用内页面。 在主对话流卡片中调用时会重新打开全页并忽略 mode；在全页或全页内 Chat UI 的卡片中调用时按照 mode 操作页面栈。 |
+| [openPageInChat](#openpageinchat) | 在当前关联的主对话流中以半屏形式打开应用内页面。 调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时，请使用 openPage。 |
+
+## API 详情
+
+<a id="navigateto"></a>
+### navigateTo()
+
+# navigateTo
+
+保留当前页面，跳转到应用内的某个页面。
+
+## 扫码预览
+![扫码预览 navigateTo](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fnavigate-to%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- url 为应用插件内的页面路径，可携带查询参数；跳转后当前页面会保留在页面栈中，可通过 navigateBack 返回。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+navigateTo(params: NavigateToParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>url</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>跳转的页面的路径，如 'path?key=value&amp;key2=value2'</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { navigateTo } from '@doubao-dev/framework/api';
+
+await navigateTo({ url: '/pages/detail/index?id=1' });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 104,
+  "errMsg": "invalid url"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>104</code></td><td><code>invalid url</code></td><td>Android、iOS</td><td>url 为空或无法解析为有效的应用插件页面路径</td><td>检查 url 是否为合法的应用内页面路径后重试。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="redirectto"></a>
+### redirectTo()
+
+# redirectTo
+
+关闭当前页面，跳转到应用内的某个页面。
+
+## 扫码预览
+![扫码预览 redirectTo](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fredirect-to%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- url 为应用插件内的页面路径，可携带查询参数；跳转会替换当前页面，不保留在页面栈中。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+redirectTo(params: NavigateToParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>url</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>跳转的页面的路径，如 'path?key=value&amp;key2=value2'</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { redirectTo } from '@doubao-dev/framework/api';
+
+await redirectTo({ url: '/pages/result/index' });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 104,
+  "errMsg": "invalid url"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>104</code></td><td><code>invalid url</code></td><td>Android、iOS</td><td>url 为空或无法解析为有效的应用插件页面路径</td><td>检查 url 是否为合法的应用内页面路径后重试。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="relaunch"></a>
+### reLaunch()
+
+# reLaunch
+
+关闭所有页面并跳转到应用内页面。
+
+## 扫码预览
+![扫码预览 reLaunch](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fre-launch%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- url 为应用插件内的页面路径，可携带查询参数；跳转会关闭现有全部页面并以目标页面作为唯一页面。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+reLaunch(params: NavigateToParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>url</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>跳转的页面的路径，如 'path?key=value&amp;key2=value2'</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { reLaunch } from '@doubao-dev/framework/api';
+
+await reLaunch({ url: '/pages/home/index' });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 104,
+  "errMsg": "invalid url"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>104</code></td><td><code>invalid url</code></td><td>Android、iOS</td><td>url 为空或无法解析为有效的应用插件页面路径</td><td>检查 url 是否为合法的应用内页面路径后重试。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="navigateback"></a>
+### navigateBack()
+
+# navigateBack
+
+关闭当前页面，返回上一页面或多级页面。
+
+## 扫码预览
+![扫码预览 navigateBack](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fnavigate-back%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- navigateBack 只能在页面栈内返回；当前页面已是页面栈中的最后一个页面时无法继续返回，需要退出应用插件请调用 exitApp。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+navigateBack(params?: NavigateBackParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>delta</code></td><td><code>number</code></td><td>否</td><td><code>1</code></td><td>正整数</td><td>返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { navigateBack } from '@doubao-dev/framework/api';
+
+await navigateBack({ delta: 1 });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="exitapp"></a>
+### exitApp()
+
+# exitApp
+
+退出当前所有页面。
+
+## 扫码预览
+![扫码预览 exitApp](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fexit-app%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.20`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 会退出当前所有页面；当 navigateBack 已无法继续返回时，使用 exitApp 退出应用插件。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+exitApp(): Promise<object>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { exitApp } from '@doubao-dev/framework/api';
+
+await exitApp();
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="navigatetodouyinminiprogram"></a>
+### navigateToDouyinMiniProgram()
+
+# navigateToDouyinMiniProgram
+
+在豆包内打开指定版本的抖音应用插件。
+
+## 扫码预览
+![扫码预览 navigateToDouyinMiniProgram](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fnavigate-to-douyin-mini-program%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.7.0`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 前置条件
+
+- 目标需向豆包开放；测试版还需具有目标的测试权限
+
+## 使用说明
+
+- path 传原始页面路径及 query，不要对完整路径调用 encodeURIComponent。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+navigateToDouyinMiniProgram(params: NavigateToDouyinMiniProgramParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>appId</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>目标抖音应用插件 ID。</td></tr>
+<tr><td><code>envVersion</code></td><td><code>&quot;current&quot; | &quot;latest&quot;</code></td><td>否</td><td><code>'current'</code></td><td>-</td><td>current 为线上版，latest 为测试版；正式版调用方始终打开 current。</td></tr>
+<tr><td><code>extraData</code></td><td><code>Record&lt;string, unknown&gt;</code></td><td>否</td><td><code>{}</code></td><td>-</td><td>传给目标应用插件的 JSON 对象。</td></tr>
+<tr><td><code>path</code></td><td><code>string</code></td><td>否</td><td><code>''</code></td><td>-</td><td>目标页面路径，可携带 query；省略时打开首页。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { navigateToDouyinMiniProgram } from '@doubao-dev/framework/api';
+
+await navigateToDouyinMiniProgram({
+  appId: '目标应用插件 ID',
+  path: 'pages/detail/index?id=1',
+  extraData: { foo: 'bar' }
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>当前环境不支持该能力</td><td>Android、iOS</td></tr>
+<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>参数不合法</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="openpage"></a>
+### openPage()
+
+# openPage
+
+打开应用内页面。
+
+在主对话流卡片中调用时会重新打开全页并忽略 `mode`；在全页或全页内 Chat UI 的卡片中调用时按照
+`mode` 操作页面栈。
+
+## 扫码预览
+![扫码预览 openPage](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fopen-page%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.2.0`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- mode 省略时按 push 处理；主对话流卡片中重新打开全页，全页及其 Chat UI 中应用页面栈操作。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+openPage(params: OpenPageParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>mode</code></td><td><code>OpenPageMode</code></td><td>否</td><td><code>'push'</code></td><td>-</td><td>页面栈操作。<br><br>- `push`：始终压入新的页面实例。<br>- `replace`：目标为栈顶页面时更新栈顶页面，否则替换栈顶页面。<br>- `navigate`：目标已在栈中时回退到最近的目标页面并更新，否则压入新页面。<br>- `pop_to`：目标已在栈中时回退到最近的目标页面并更新，否则替换栈顶页面。</td></tr>
+<tr><td><code>url</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>应用内页面路径，可携带查询参数。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { openPage } from '@doubao-dev/framework/api';
+
+await openPage({
+  url: '/pages/detail/index?id=1',
+  mode: 'navigate'
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+<a id="openpageinchat"></a>
+### openPageInChat()
+
+# openPageInChat
+
+在当前关联的主对话流中以半屏形式打开应用内页面。
+
+调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时，请使用 openPage。
+
+## 扫码预览
+![扫码预览 openPageInChat](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Frouter%252Fopen-page-in-chat%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.2.0`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 前置条件
+
+- 当前应用需要关联主对话流
+
+## 使用说明
+
+- 不接受页面栈 mode；需要进入应用插件全页或操作已有页面栈时使用 openPage。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+openPageInChat(params: OpenPageInChatParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>url</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>应用内页面路径，可携带查询参数。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { openPageInChat } from '@doubao-dev/framework/api';
+
+await openPageInChat({
+  url: '/pages/detail/index?id=1'
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+## 相关类型
+
+<a id="navigatetoparams"></a>
+### NavigateToParams
+
+#### Properties
+
+• **url**: `string` - 跳转的页面的路径，如 'path?key=value&key2=value2'
+
+<a id="navigatebackparams"></a>
+### NavigateBackParams
+
+#### Properties
+
+• **delta?**: `number` - 返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止
+
+<a id="navigatetodouyinminiprogramparams"></a>
+### NavigateToDouyinMiniProgramParams
+
+#### Properties
+
+• **appId**: `string` - 目标抖音应用插件 ID
+• **path?**: `string` - 目标页面路径，可携带 query；省略时打开首页
+• **extraData?**: `Record<string, unknown>` - 传给目标应用插件的 JSON 对象
+• **envVersion?**: `'current' | 'latest'` - current 为线上版，latest 为测试版；正式版调用方始终打开 current
+
+<a id="openpagemode"></a>
+### OpenPageMode
+
+打开页面时使用的页面栈操作。
+
+#### Type
+
+`'push' | 'replace' | 'navigate' | 'pop_to'`
+
+<a id="openpageparams"></a>
+### OpenPageParams
+
+#### Properties
+
+• **url**: `string` - 应用内页面路径，可携带查询参数
+• **mode?**: `OpenPageMode` - 页面栈操作。 - push：始终压入新的页面实例。 - replace：目标为栈顶页面时更新栈顶页面，否则替换栈顶页面。 - navigate：目标已在栈中时回退到最近的目标页面并更新，否则压入新页面。 - pop_to：目标已在栈中时回退到最近的目标页面并更新，否则替换栈顶页面
+
+<a id="openpageinchatparams"></a>
+### OpenPageInChatParams
+
+#### Properties
+
+• **url**: `string` - 应用内页面路径，可携带查询参数