快速入门 服务端 客户端 通用能力 开发指南 服务商指南
本文内容

WPS协作 Deeplink 协议

协议结构

WPS协作协议是一个 URL 协议，可以用于打开WPS协作或者其中一个页面，例如：ksoxz://xz.wps.cn/nativeapp?app_id=xxxxxx 就是一个协议。

字段 值 说明
scheme ksoxz: 固定值
host xz.wps.cn 固定值
path 对应不同的协议 /chat（聊天页面）
/webview（浏览器）
/webapp（网页应用）
/home（客户端 tab 跳转）
params 不同的协议会有不同的定义 例如：app_id：表示应用的唯一标识

当WPS协作协议在其不支持的WPS协作版本上打开时，将会显示为：当前版本不支持该协议，请升级客户端版本


协议应用

WPS协作外部打开

在一些条件下，点击WPS协作协议可以直接打开WPS协作，这些条件与系统、应用、网络等因素有关系。

在WPS协作外部点击WPS协作协议，可能会伴随弹窗提示，不同的浏览器上表现会略有差异。

image-20211207144457754

（图1：外部浏览器通过DEEPLINK拉起会话）

WPS协作内部打开

客户端内支持以下渠道打开WPS协作协议

  • 移动端扫码
  • 聊天消息中的WPS协作协议链接跳转
  • 消息卡片中的WPS协作协议链接跳转
  • 应用内网页中的WPS协作协议链接跳转

已支持的协议

打开WPS协作

唤起WPS协作客户端（示例：ksoxz://xz.wps.cn/open）


聊天页面

支持拉起聊天对话页面（示例：ksoxz://xz.wps.cn/chat?chat_id=xxxxxx）

params 数据类型 数据描述
chat_id number 聊天 ID
group_id number 团队 ID

发送消息

支持拉起聊天对话页面并发送一条消息，可选择是否展示待发送提示条（示例：ksoxz://xz.wps.cn/sendMsg?chat_id=xxxxxx&msgType=xxxxxx&content=json）

params 数据类型 数据描述
chat_id number 聊天 ID
msg_type number 发送消息类型
content string JSON 字符串数据，根据 msg_type 变化

参数结构说明（content）：msg_type=23 卡片消息

params 数据类型 数据描述
url string 卡片链接
title string 卡片标题
text string 卡片描述文本
image string 卡片配图 url
appid string 应用 id
auto_send number 是否直接发送，默认 0：不直接发送，展示待发送提示条，1：直接发送

浏览器

（示例：ksoxz://xz.wps.cn/webview?url=https://xxxxxxxxx）该协议仅移动端支持，PC 不支持该协议。

params 数据类型 数据描述
url string 跳转的 url 链接（UrlEncode）

网页应用

（示例：ksoxz://xz.wps.cn/webapp?app_id=xxxxxx&url=xxxxxx&mode=xxxxxx）

params 数据类型 数据描述
app_id string 应用 ID
url string 应用链接（UrlEncode）
mode string main_webview：主窗口模式（4.10.0 及以上版本支持）
sidebar：聊天界面右侧
window：独立窗口模式（3.13.0 及以上版本支持）
toolbar string 当 mode=window，可以自定义工具栏按钮。多个配置项用英文逗号连接
不传此参数，窗口将使用应用的默认工具栏
none: 不显示工具栏
doc_create: 创建文档
history: 浏览记录
robot: 机器人会话
browser: 浏览器打开
share: 分享
more: 更多

（图2：独立窗口的工具栏示意）

客户端 tab 跳转

（示例：ksoxz://xz.wps.cn/home?tab=xxx）

params 数据类型 数据描述
tab string message：消息
document：文档
worktable：工作台
personal：我的
meeting_tab：会议
calendar_tab：日历
email_tab：邮箱

用户名片

（示例：ksoxz://xz.wps.cn/userDetail?company_uid=xxxxxx&app_id=xxxx）

params 数据类型 数据描述
company_uid string 用户 ID
app_id string 应用 ID

通讯录

（示例：ksoxz://xz.wps.cn/addressbook?app_id=ak123&deco_company_id=xxxx&deco_dept_id=xxxx）

params 数据类型 数据描述
app_id string 应用 ID
deco_company_id string 混淆后企业 ID
deco_dept_id string 混淆后部门 ID

toast 提示

（示例：ksoxz://xz.wps.cn/toast?body=xxxxxx）

params 数据类型 数据描述
body string 弹框提示内容(需要进行 UrlEncode)

跳转到下载列表页

（示例：ksoxz://xz.wps.cn/downloadList）


跳转到下载详情页

（示例：ksoxz://xz.wps.cn/downloadDetail?fileId=156856）

params 数据类型 数据描述
fildId string 文件ID

deeplink 进入指定会议

支持唤起WPS协作客户端并进入指定的会议（该协议仅PC端支持，移动端暂不支持。）

（示例：ksoxz://xz.wps.cn/meeting?code=XXXXXXXXXXXX）

params 数据类型 数据描述
code string 会议码
本文内容