打开H5微应用

本文档介绍使用AppLink协议打开钉钉H5微应用的相关说明。

使用场景

打开H5微应用或H5微应用中目标页面。

说明

需要确保访问人在该微应用的可见范围内。

版本支持

钉钉客户端	Android	iOS	macOS	Windows
版本	≥7.0.5	≥7.0.5	≥7.0.40	≥7.0.40

协议

https://applink.dingtalk.com/page/h5_app_open

字段说明

资源名+path定义	字段	必填	说明
page/h5_app_open	appId	是	H5应用标识。如果是企业内部H5微应用，该参数传agentId，参考基础概念-AgentId。如果是第三方企业H5微应用，该参数传appId，参考基础概念-AppId。
appType	是	应用类型：1：第三方企业应用2：企业内部应用
corpId	是	应用所在组织的corpId。
path	否	访问H5微应用的具体某个页面时，该字段的参数将替换H5应用URL的path部分，需要encode处理。
pathAndroid	否	同path参数，Android端会优先使用该参数替换H5微应用URL的path部分，需要encode处理。如果该参数不存在，则会使用path参数。
pathIos	否	同path参数，iOS端会优先使用该参数替换H5微应用URL的path部分，需要encode处理。如果该参数不存在，则会使用path参数。
pathPc	否	同path参数，桌面端会优先使用该参数替换H5微应用URL的path部分，需要encode处理。如果该参数不存在，则会使用path参数。
target	否	打开的容器类型：移动端：fullScreen（默认）：全屏容器打开panel：沉浸式容器打开说明桌面端打开H5微应用，该字段必填panel。桌面端：workbench（默认）：桌面端工作台打开popupWindow：独立窗口打开panel：第四栏打开slide：侧边栏打开
fallbackLink	否	端上能识别appLink协议的情况下，如果触发异常（包括：appId为空、获取页面url失败、appType类型错误的情况），需要跳转的路径。

使用示例

使用全屏容器打开H5微应用

https://applink.dingtalk.com/page/h5_app_open?appId=1234&corpId=ding16b241fd****4f7c288&appType=2

使用沉浸式容器打开H5微应用

https://applink.dingtalk.com/page/h5_app_open?appId=1234&corpId=ding16b241fd****4f7c288&appType=2&target=panel

打开H5微应用，替换path部分为/a/index

https://applink.dingtalk.com/page/h5_app_open?appId=1234&corpId=ding16b241fd****4f7c288&appType=2&path=%2Fa%2Findex

使用场景#

版本支持#

协议#

字段说明#

使用示例#

使用场景

版本支持

协议

字段说明

使用示例