Appearance
统一协议跳转
定义
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/profile | staff_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/newdoc | type,<br/>cid | ||
主页面 | 切换 | taurushzd://taurusclient/action/switchtab | index | |
音视频 | 创建会议 | taurushzd://taurusclient/action/avmeeting/createConference | title,isVideoConference | |
会前预览 | taurushzd://taurusclient/action/avmeeting/prepare_join | meetingCode | 加入会议 | |
观看直播页面 | taurushzd://taurusclient/action/avmeeting/live | meetingUuid |
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=ddtab | PC专有 |
pc_slide | 否 | pc_slide=true,在侧边栏打开页面,效果等同于container_type=pc_slide | PC专有 |
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
1.3.2 page/link
格式: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
点击到直播画面