Skip to content

统一协议跳转 ​

定义

scheme以URI为核心,将URI与应用中的资源(页面、服务等)建立映射关系。

协议格式定义如下:

${scheme协议头}😕/host/资源类型/资源名?键值对参数

例:taurushzd://taurusclient/page/link?url=https%3A%2F%2Fwww.baidu.com&pc_slide=true

1.1 协议头 ​

x86:taurushzd

信创:taurushainanxc

1.2 协议列表 ​

业务页面scheme参数备注
通用卡片、应用等taurushzd://taurusclient/action/open_app查看协议详解跨3端使用
通用卡片、应用等taurushzd://taurusclient/page/link查看协议详解PC端专有
DING打开DING列表taurushzd://taurusclient/action/ding/list无参
个人详情页profile页面taurushzd://taurusclient/action/user/profilestaff_id(非明文用户id)
通讯录联系人申请列表taurushzd://taurusclient/action/contact/friend_apply_list无参
邮箱打开邮件详情taurushzd://taurusclient/action/mail/detail?id=xxx
文档打开文档https://pre-docs-dingtalk.gov.alibaba-inc.com客户端不解析
新建文档taurushzd://taurusclient/action/doc/newdoctype,<br/>cid
主页面切换taurushzd://taurusclient/action/switchtabindex
音视频创建会议taurushzd://taurusclient/action/avmeeting/createConferencetitle,isVideoConference
会前预览taurushzd://taurusclient/action/avmeeting/prepare_joinmeetingCode加入会议
观看直播页面taurushzd://taurusclient/action/avmeeting/livemeetingUuid

1.3 协议详解 ​

1.3.1 action/open_app ​

格式:taurushzd://taurusclient/action/open_app?url=URLEncode(页面url)

此协议非常强大,可以打开工作台应用,也可以打开普通页面,且客户端移动端都支持,使用非常频繁。

参数列表 ​
字段名是否必填含义备注
url是
corpid否
appId/app_id否小程序appId,当type为2是必填
url/redirect_url是地址,需要URLEncode
title否标题,需要URLEncode
type是1: H5微应用,2: 小程序移动端专有
offline是是否离线包(true/false)移动端专有
page否小程序的页面路由,/x/y/z,需要进行 urlencode移动端专有
query否小程序页面需要的参数,k1=v1&k2=v2,需要进行 urlencode移动端专有
container_type是work_platform:在工作台打开目标应用页面,此时corpid和app_id为必填参数,缺失则无法打开。如果app_id对应的标签页不存,则会新开标签页加载目标应用页面;如果已存在,则不会新开标签页,但目标应用页面会重新加载,同时title标题不会重复设置。<br/>ddtab:在工作台打开目标页面,会新打开一个标签页加载目标页面<br/>pc_slide:在侧边栏打开目标页面<br/>browser:在外部浏览器打开目标页面(默认配置)PC专有
ddtab否ddtab=true 在工作台打开页面。效果等同于container_type=ddtabPC专有
pc_slide否pc_slide=true,在侧边栏打开页面,效果等同于container_type=pc_slidePC专有
slide_panel_option否侧边栏显示参数,需要URLEncode。在侧边栏显示时生效。<br/>{“hidesTitle”:false}显示标题,默认配置<br/>{“hidesTitle”:true}隐藏标题PC专有

注:移动端专有参数,PC端不进行解析。

3、打开页面至外部浏览器

taurushzd://taurusclient/action/open_app?container_type=browser&url=https%3A%2F%2Fwww.baidu.com

4、打开工作台应用

taurushzd://taurusclient/action/open_app?corpid=502&container_type=work_platform&app_id=2423&title=%E6%B5%81%E7%A8%8B%E5%AE%A1%E6%89%B9&redirect_type=jump&redirect_url=https%3A%2F%2Faflow.gov.alibaba-inc.com%2Fdingtalk%2Fpc%2Fquery%2Fpchomepage.htm%3Fcorpid%3Dbuc%25249af42e17-3984-40bc-b60d-84a09728c1b9

格式:taurushzd://taurusclient/page/link?url=URLEncode(页面url)。

此协议为PC端专有,显示某个页面,打开位置可以配置为侧边栏、工作台、弹出框等位置。

参数列表 ​
字段名是否必填含义
url/redirect_url是跳转url
title否标题,默认值"详情"
bShowHeader否默认展示,false时不展示
container_type是web_wnd:弹出页,多次触发仅打开一个窗口<br/>popup_wnd:弹出页,多次触发打开多个窗口<br/>ddtab:工作台<br/>pc_slide:侧边栏<br/>browser:外部浏览器打开页面(默认配置)
web_wnd否web_wnd=true时,打开弹出页,多次触发仅打开一个窗口
popup_wnd否popup_wnd=true时,打开弹出页,多次触发打开多个窗口
pc_slide否pc_slide=true时,打开侧边栏
ddtab否ddtab=true时,打开工作台
width否web_wnd/popup_wnd非空时生效<br/>有效范围[320,1024],超过按边界值显示
height否web_wnd/popup_wnd非空时生效,<br/>有效范围[120,768],超过按边界值显示

注:container_type参数将打开方式手链到一个参数,container_type=web_wnd,控制效果同web_wnd=true,更推荐使用。

应用举例 ​

1、打开独立窗口

taurushzd://taurusclient/page/link?url=https%3A%2F%2Fwww.baidu.com&container_type=web_wnd&width=600&height=600

2、打开弹出页

taurushzd://taurusclient/page/link?url=https%3A%2F%2Fwww.baidu.com&container_type=popup_wnd&width=600&height=600

3、打开侧边栏

taurushzd://taurusclient/page/link?

url=https%3A%2F%2Fwww.baidu.com&container_type=pc_slide

4、打开工作台

taurushzd://taurusclient/page/link?

url=https%3A%2F%2Fwww.baidu.com&container_type=ddtab

5、打开外部浏览器

taurushzd://taurusclient/page/link?url=https%3A%2F%2Fwww.baidu.com&container_type=browser

1.3.3 DING ​

格式:taurushzd://taurusclient/action/ding/list

跳转到ding列表。

1.3.4 个人详情页 ​

taurushzd://taurusclient/action/user/profile?staff_id=GE_7adf4e1001c24be4831ffeb12a5cbae9

效果如图:

1.3.5 通讯录 ​

格式:taurushzd://taurusclient/action/contact/friend_apply_list

跳转到联系人申请列表

1.3.6 主页面切换 ​

格式:taurushzd://taurusclient/action/switchtab?index=X

字段名是否必填含义
index是IM:聊天页<br/>DING:钉列表<br/>CLOUDDISK:云盘<br/>MEETING::会议<br/>TODO:待办<br/>SCHEDULE:日程
url否index=TODO时,url生效,指定跳转到某个待办

1、跳转到云盘页面

taurushzd://taurusclient/action/switchtab?index=CLOUDDISK

2、跳转到某个待办

taurushzd://taurusclient/action/switchtab?index=TODO&url=app%3A%2F%2Fdesktop.dingtalk.com%2Fweb_content%2Fgdt-dingtalk-pc-schedule%2Findex.html%3F%23%2Ftask-modify%2F4ee8a955-9a39-45a8-809c-c08abe5e7914

1.3.7 邮箱 ​

格式:taurushzd://taurusclient/action/mail/detail?id=xxx

很少渠道支持,暂无截图。

1.3.8 文档 ​

文档新建 ​

taurushzd://taurusclient/action/doc/newdoc?file_type=XX&cid=XX

字段名是否必填含义
file_type是word:新建word文档<br/>excel:新建excel文档
cid是会话id

例:新建文档

taurushzd://taurusclient/action/doc/newdoc?file_type=word&cid=797187540342801385@pre.saas.zwdingding

文档预览 ​

专有钉文档分享出来的文档卡片/文本链接:https://pre-docs-dingtalk.gov.alibaba-inc.com/document/XXX

客户端不对链接进行解析,识别为文档链接后,弹框显示文档。

1.3.9 音视频 ​

会议创建(通过外部链接创建) ​

格式:taurushzd://taurusclient/action/avmeeting/createConference?XXX

字段名是否必填含义
title否此参数无效
isVideoConference否true表示视频会议<br/>false表示语音会议

例:弹出视频会议创建页

taurushzd://taurusclient/action/avmeeting/createConference?title=123&isVideoConference=true

会前预览 ​

格式:taurushzd://taurusclient/action/avmeeting/prepare_join?meetingCode=88764678

观看直播 ​

格式:taurushzd://taurusclient/action/avmeeting/live?meetingUuid=xxx

例:业务卡片显示直播卡片

taurushzd://taurusclient/action/avmeeting/live?meetingUuid=hz-3800b586-e236-469b-80e4-8895edc668c8

点击到直播画面