# scheme 协议
# 应用外打开私聊会话
通过 scheme 在应用外打开私聊会话
# 使用说明
# 187 版本以下
// pc 端示例代码
// 线上环境，sessionid 为用户企业唯一标识id
window.location.href = 'yach://yach.zhiyinlou.com/session/sessionp2p?sessionid=Yach228346'
// 测试环境，sessionid 为用户企业唯一标识id
window.location.href = 'yachtest://yach.zhiyinlou.com/session/sessionp2p?sessionid=Yach228346'
// 移动端示例代码
// sessionid 为对应环境下知音楼用户id（不同于用户企业唯一标识id）
window.location.href = 'yach://yach.zhiyinlou.com/session/sessionp2p?sessionid=228346'
# 187 版本及以上版本优化，保持拼接字段sessionid数据统一（向下兼容，依然支持187 版本以下方式）
// pc 端示例代码
// 线上环境，sessionid 为用户企业唯一标识id
window.location.href = 'yach://yach.zhiyinlou.com/session/p2p?sessionid=Yach228346'
// 测试环境，sessionid 为用户企业唯一标识id
window.location.href = 'yachtest://yach.zhiyinlou.com/session/p2p?sessionid=Yach228346'
// 移动端示例代码
// sessionid 为对应环境下用户企业唯一标识id
window.location.href = 'yach://yach.zhiyinlou.com/session/p2p?sessionid=Yach228346'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /session/sessionp2p | 是 | 对应打开私聊的路径 |
| params | sessionid | 是 | 用户企业唯一标识id |
# 应用外打开群聊会话
通过 scheme 在应用外打开群聊会话，知音楼版本 >= 1.4.2.11，仅支持 pc
# 使用说明
// 线上环境，sessionid 为线上环境群聊会话 id
window.location.href = 'yach://yach.zhiyinlou.com/session/sessiongroup?sessionid=2819739271'
// 测试环境，sessionid 为测试环境群聊会话 id
window.location.href = 'yachtest://yach.zhiyinlou.com/session/sessiongroup?sessionid=2819739271'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /session/sessiongroup | 是 | 对应打开群聊的路径 |
| params | sessionid | 是 | 会话 ID，群聊对应为群 ID |
# 应用内打开工作台侧边栏（移动端应用外可以该scheme拉起知音楼并打开webview页面）
使用侧边栏打开链接
测试方法：1、在将链接作为消息发送出去，点击即可在侧边栏打开。2、消息体内含有按照规则构造链接，发送消息卡片，点击此消息卡片。
应用场景：markdown、action_card 消息卡片点击打开等。
# 使用说明
// 线上环境
'yach://yach.zhiyinlou.com/session/webview?url=https%3A%2F%2Fyach-open-doc-dev.zhiyinlou.com&pc_slide=true&hide_title_bar=true'
// 测试环境
'yachtest://yach.zhiyinlou.com/session/webview?url=https%3A%2F%2Fyach-open-doc-dev.zhiyinlou.com&pc_slide=true&hide_title_bar=true'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /session/webview | 是 | 对应打开侧边栏 webview 的路径 |
| params | pc_slide | 是 | 值为 true，指定链接在 im 侧边栏打开(注意：不要转码这个！)，与 workbench_slide 不共存 |
| workbench_slide | 是 | 值为 true，指定链接在工作台侧边栏打开(注意：不要转码这个！)，与 pc_slide 不共存 | |
| hide_title_bar | 否 | 侧边栏是否隐藏 title，默认为 false，不隐藏，知音楼版本 >= 1.4.9.x | |
| url | 是 | 要在侧边栏打开的链接 |
# 应用内打开独立窗口
使用独立窗口打开页面链接，知音楼版本 >= 1.5.0.x，仅支持 pc。
测试方法：1、在将链接作为消息发送出去，点击即可使用独立窗口打开；2、消息体内含有按照规则构造链接，发送消息卡片，点击消息卡片。
应用场景：action_card 消息卡片点击打开等。
# 使用说明
// 线上环境
'yach://yach.zhiyinlou.com/session/webview?url=https%3A%2F%2Fyach-open-doc-dev.zhiyinlou.com&single_webview=true&title=true'
// 测试环境
'yachtest://yach.zhiyinlou.com/session/webview?url=https%3A%2F%2Fyach-open-doc-dev.zhiyinlou.com&single_webview=true&title=true'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /session/webview | 是 | 对应打开独立窗口 webview 的路径 |
| params | single_webview | 是 | 值为 true，使用独立窗口打开页面(注意：不要转码这个！) |
| title | 否 | 独立窗口 title | |
| url | 是 | 要在独立窗口打开的链接 |
# 应用内、外打开工作台 tab 页
应用场景：应用内 markdown 链接、应用外浏览器唤起，知音楼版本 >= 1.4.4.x，仅支持 pc。
# 使用说明
// 线上环境
'yach://yach.zhiyinlou.com/workbench/tabopen?id=test&url=https%3A%2F%2Fyach.zhiyinlou.com%2F&title=title'
// 测试环境
'yachtest://yach.zhiyinlou.com/workbench/tabopen?id=test&url=https%3A%2F%2Fyach.zhiyinlou.com%2F&title=title'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /workbench/tabopen | 是 | 对应打开工作台的路径 |
| params | id | 是 | 工作台 tab 的唯一标识 |
| url | 是 | 要在工作台打开的 tab 链接 | |
| title | 是 | tab 栏标题(注意：不要转码这个！) |
# 应用外打开文档
通过 scheme 在应用外打开知音楼某个文档，知音楼版本 >= 1.5.2.x，仅支持 pc
# 使用说明
// 线上环境
window.location.href = 'yach://yach.zhiyinlou.com/doc/open?url=https%3A%2F%2Fyach-doc-shimo.zhiyinlou.com%2Fdocs%2FrgQX3gHhvJPQvwRY%2F'
// 测试环境
window.location.href = 'yachtest://yach.zhiyinlou.com/doc/open?url=https%3A%2F%2Fyach-doc-shimo-test.zhiyinlou.com%2Fdocs%2FrgQX3gHhvJPQvwRY%2F'
# 参数说明
| 参数 | 参数值 | 必传 | 说明 |
|---|---|---|---|
| scheme | 线上：yach://；测试：yachtest:// | 是 | 协议 |
| host | yach.zhiyinlou.com | 是 | 与移动端保持一致 |
| path | /doc/open | 是 | 对应打开文档的路径 |
| params | url | 是 | 文档地址，地址需要做编码处理 |
# 补充说明
- 测试包对应的文档域名：yach-doc-shimo-test.zhiyinlou.com
- 线上包对应的文档域名：yach-doc-shimo.zhiyinlou.com
- 包和文档域名不对应不能正常打开文档
