You need to enable JavaScript to run this app.
导航

接入飞书应用

最近更新时间2023.10.16 14:15:40

首次发布时间2021.02.24 14:27:44

1. 概述

接入飞书应用,可以让用户在飞书的工作台直接访问智能数据洞察的移动端应用、连接飞书数据源,或者推送日/周/月报给飞书个人或群组等,实现飞书联动、协同办公的效果。相关操作需要通过飞书开放平台自建应用的方式完成,飞书开放平台的相关配置界面会不定期迭代,特此提醒您,请以最新的配置界面为准。

1.1 名词解释

名词说明使用场景
飞书开放平台用于增加新应用的后台,所有开发者都可以操作在和 ABI 联动场景中,用于增加应用的后台
飞书管理后台飞书组织管理后台,只有企业组织管理员可以操作审批应用上线,开放相关权限给到该应用
应用管理员对应到智能数据洞察的用户角色是系统管理员,为智能数据洞察平台完成对接集成飞书的工作
企业组织管理员管理飞书组织的人员/部门

1.2 操作流程概览

alt
如上图所示,整体操作逻辑是,由贵公司的智能数据洞察的系统管理员,通常也是飞书开放平台的应用创建者与管理员,在飞书开放平台中创建一个智能数据洞察的应用,开启应用相关的权限,并且经过飞书的组织管理员进行审核通过,最终才能完成整体的应用配置与上线。具体配置方式后文将会分模块展开介绍,如您有更多关于飞书应用相关的疑问,也可以前往飞书开发平台的帮助中心查看文档介绍。

1.3 常见场景配置路径

应用场景

配置步骤

飞书开放平台飞书管理后台权限开通信息汇总

在飞书应用中直接访问 ABI 移动端

完成如下2. 基础配置3. 账号绑定4. 接入移动端

将飞书在线表格等作为数据源接入ABI应用

完成如下2. 基础配置5. 接入飞书数据源

  • 飞书开放平台
    • 应用权限配置:操作步骤见2. 基础配置 中的「2.2.1基础权限配置」和「2.2.2使用表格与多维表格相关权限开通」,「5.1 开启飞书文档相关权限」;

    • 完成应用发布,操作步骤见2. 基础配置中的「2.3总览与应用发布」。

  • 数据集同步结果推送至飞书

  • 仪表盘内的评论在飞书收到通知

完成如下2. 基础配置3. 账号绑定6. 消息推送

飞书群授权数据集/仪表盘权限

完成如下2. 基础配置7. 飞书群授权

2. 基础配置(必选)

2.1 开始创建飞书应用

(1)打开企业飞书开放平台创建企业自建应用,,按提示填写必要的应用名称应用描述。创建成功之后,点击应用名称打开应用,点击凭证与基础信息切换页面,可以获取后续流程会用到的 App ID 和 App Secret 值。
alt
(2)确认自己想推送企业组织(点击右上角头像可以切换自己的所在组织账号)
alt
(3)点击创建企业自建应用,填写必填项
alt
(4)创建完成之后,进入到该应用的详情配置页,可以完善该应用相关信息,包括应用图标、管理后台主页、应用名称、应用描述、帮助文档等。

顶部可以查看应用凭证信息

说明

建议该处的应用凭证信息记录一下,后续步骤会用到

2.2 权限管理配置

在飞书开放平台的开发者后台中,点击权限管理,下拉到权限配置处开始对该应用配置权限
alt

2.2.1 基础权限配置

(必选)需要勾选通讯录中的 7 个权限内容:以应用身份读取通讯录、获取部门基础信息、获取部门组织架构信息、获取用户基本信息、获取用户 user ID、获取用户手机号、获取企业信息

备注:因飞书开放平台版本更新,“以应用身份读取通讯录”自2023年6月不再可选,请您在勾选了上述权限之外,再勾选“获取通讯录基本信息、获取通讯录部门组织架构信息、获取用户组织架构信息、获取成员所在部门路径”。

多选之后,选择批量开通这些权限。

alt

2.2.2 使用表格与多维表格相关权限开通

(1)(建议开启)如需使用知识库里的表格/多维表格,需要开启知识库相关权限

在权限管理界面,点击“云文档”栏,选择“查看、编辑和管理知识库”、“查看知识库”,勾选之后选择批量开通****。
alt

(2)(建议开启)如需下载数据以飞书表格的格式,需要开启知识库相关权限

在权限管理界面,点击“云文档”栏,选择下列权限并批量开通:

  • 查看、评论、编辑和管理云空间中所有文件”;
  • 查看、评论、编辑和管理多维表格”;
  • 查看、评论和导出多维表格”;
  • 查看、评论、编辑和管理电子表格”;
  • 查看、评论和导出电子表格”;
    部分勾选如图所示:
    alt
    (备注:飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,也建议您给云文档相关的权限全部都勾选上。)

2.2.3 飞书部门相关权限开通

(建议开启)如需将飞书的部门,添加到 DataWind 中直接使用,需要在 DataWind 额外增加如下权限开通

搜索「通讯录」,选择以应用身份读取通讯录。
备注:因飞书开放平台版本更新,“以应用身份读取通讯录”自2023年6月不再可选,请您勾选:获取部门基础信息、获取通讯录部门组织架构信息、更新用户组信息、获取角色权限、查询用户席位信息、获取用户基本信息、获取用户组组织架构信息、获取成员所在部门路径。
多选后,点击批量开通。

alt
搜索「获取企业」,选择获取企业信息,然后选择批量开通。飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,您可以给通讯录相关的权限全部都勾选上。
alt
(建议开启)如需仪表盘支持一键联系所有者,还需要获取与更新群组信息的权限

搜索获取与更新群组信息,选择该权限,然后选择批量开通。飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,您可以给此处相关的权限全部都勾选上。

2.2.4 权限审批与飞书审批流联动相关权限开通

(建议开启)如需开通权限审批与飞书审批流联动的功能,还需开通如下权限
添加【查看、创建、更新、删除审批应用相关信息】【查询审批列表】【访问审批应用】【获取用户 user ID】这四个权限,然后选择批量开通。飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,您可以给此处相关的权限全部都勾选上。

2.2.5 飞书消息发送相关权限开通

(建议开启)如需向用户获取与发送单聊、群组消息,需要开通获取与发送单聊、群组消息权限
搜索获取与发送单聊、群组消息,选择该权限并开通。该权限能够向应用可用性范围内的用户发送单聊消息;向机器人所在的群聊发送群消息;接收用户发送给机器人的所有单聊消息。飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,您可以给此处相关的权限全部都勾选上。
alt

联系飞书组织管理员,登录到飞书管理后台 进行如下操作

  • 点击企业管理->应用管理->找到该应用
  • 选择可用成员,配置选择为全部成员

飞书企业组织管理员完成配置之后,应用管理员返回至飞书开放平台
点击「安全设置」,在「重定向 URL」输入框中添加如下 URL 信息

  • SaaS 增加

https://console.volcengine.com/bi/datawind/#
https://console.volcengine.com/bi/datawind#/
https://console.volcengine.com/bi/datawind#/dataManage
https://console.volcengine.com/bi/datawind/#/dataManage
https://console.volcengine.com/bi/datawind/auth#/dataManage
https://console.volcengine.com/bi/datawind/auth/#/dataManage
https://console.volcengine.com/bi/datawind#/dataPrep
https://console.volcengine.com/bi/datawind/#/dataPrep
https://console.volcengine.com/bi/datawind/auth#/dataPrep
https://console.volcengine.com/bi/datawind/auth/#/dataPrep
https://console.volcengine.com/bi/datawind/#/prep/dataLink/authCallback/lark_sheet
https://console.volcengine.com/bi/datawind/#/prep/dataLink/authCallback/lark_bitable

  • 独立部署增加

如下,把 $HOST 替换为产品的部署域名,不包含任何路径:
$HOST/bi#
$HOST/bi/#
$HOST/bi#/dataManage
$HOST/bi/#/dataManage
$HOST/bi/auth#/dataManage
$HOST/bi/auth/#/dataManage
$HOST/bi#/dataPrep
$HOST/bi/#/dataPrep
$HOST/bi/auth#/dataPrep
$HOST/bi/auth/#/dataPrep
$HOST/bi/#/prep/dataLink/authCallback/lark_sheet
$HOST/bi/#/prep/dataLink/authCallback/lark_bitable

选择添加保存。

2.3 总览与应用发布

(1)在「总览」模块,来到「应用发布」-「版本管理与发布」,点击创建版本,填写版本号、可用性状态等内容,点击保存,完成版本创建。
创建版本
如下所示,有提醒发布的时候,点击申请线上发布,完成应用发布。
申请线上发布
注意:仅可用性范围内的用户能够成功搜索、打开并正常使用网页应用。
应用管理员申请发布之后,企业组织管理员会收到开放平台应用审核的消息通知,需要审核之后才可继续后续配置动作。

(2)完成上述配置之后,在「凭证与基础信息」模块内复制 APP ID 和 APP Secret。

(3)返回到 ABI 平台,以系统管理员身份登陆,填写至企业域管理->办公平台集成中,点击提交开启飞书集成。

3. 账号绑定(建议开启)

为了将智能数据洞察中的用户和飞书账号绑定,可以同上述步骤2.2.5,进入到至企业域管理->用户管理中, 以单点或批量方式实现用户绑定。

3.1 单个用户绑定步骤


功能操作步骤说明

自动匹配

  • 左边是飞书账号信息,右侧是ABI的账号信息
  • 根据实际情况选择匹配字段即可
  • 下方自动通过该用户在ABI的信息与飞书的信息进行匹配,并可进行选择

手动绑定

  • 手动搜索用户在飞书的名字进行手动匹配即可
  • 如搜索有问题可以点击右侧刷新功能进行刷新

3.2 批量绑定配置步骤

点击「账号绑定配置」,选择飞书。

功能名功能介绍
匹配方式自动匹配的匹配说明同上

更新设置

  • 自动更新:可以选择在每天/每小时的指定时间进行匹配的更新,比如有用户入职/离职等操作,可以在指定自动更新时间点进行刷新
  • 手动更新:不会随着用户在飞书的信息更新而更新,只有系统管理员点击下方立即更新才会做用户匹配的信息更新
立即更新点击立即更新,ABI平台账号和飞书账号即可按照规则进行匹配
4. 接入移动端

完成上述【2. 基础配置】和【三.账号绑定】,接着下面的操作步骤完成飞书应用的移动端部署操作。

4.1 移动端部署

联系火山引擎的产品部署工程师,提供给对方该应用的 APP ID 信息和应用的首页地址,由火山引擎同学协助上传小程序代码包,完成移动端部署。

如果申请应用的用户不是上传上传代码包的用户,可以先通过飞书进行权限转移,部署完成之后再将应用权限回交。

4.2 移动端置顶

可以飞书工作台推荐应用,将应用移动端置顶

  • 飞书点击工作台->点击右上角设置->点击推荐应用管理->点击去设置->跳到应用管理页面


  • 点击左侧工作台-工作台设置-管理员推荐,点击添加推荐规则并填写表单,添加后应用可以置顶。



保存之后,即可看到该应用已经置顶

注意

如果同时开启机器人应用和移动端应用,则可能移动端点击之后,直接打开的是机器人对话框的情况,此时只需要点击机器人,然后选择打开应用即可。

5. 接入飞书数据源

完成上述【2. 基础配置】,继续下述动作。

5.1 开启飞书文档相关权限

在权限管理页面确保开启如下权限,其中【查看、评论、编辑和管理多维表格】和【查看、评论和导出多维表格】是多维表格的权限设置,【查看、评论、编辑和管理电子表格】和【查看、评论和导出电子表格】是电子表格的权限设置,建议您给云文档相关的权限全部都勾选上。飞书开放平台的权限配置界面可能会不定期迭代,此处提醒您,请以最新的权限配置界面为准,也建议您给云文档相关的权限全部都勾选上。

5.2 连接飞书数据源测试

为了确认配置是否成功,可以来到智能数据洞察产品,点击数据管理-->数据集,即可看到飞书表格和飞书多维表格(飞书多维表格在V2.42及以上版本支持)的选项,按照说明可以完成后续步骤即说明配置成功。否则请按照上述步骤检查配置

6. 消息推送(建议开启)

6.1 应用权限配置

完成【2. 基础配置】和【3. 账号绑定】的所有操作后,按照以下步骤完成推送配置

  • 联系飞书企业组织管理员飞书管理后台确认应用的通讯录可见范围是全部成员。入口:工作台->应用列表->找到应用->应用可用范围

  • 应用管理员来到飞书开放平台添加配置授权开启发送消息的权限,并请企业组织管理员审核通过改权限。

(1)获取与发送单聊、群组消息:开通该权限后,机器人可以向用户发送单聊消息,或向机器人所在的群聊发送群消息;添加“接收消息”事件(前往“事件订阅”面板 > 添加事件 > 消息与群组)后,机器人便可接收用户发送的单聊消息。
(2)获取用户在群组中@机器人的消息:开通该权限,并添加“接收消息”事件(前往“事件订阅”面板 > 添加事件 > 消息与群组)后,可接收用户在群聊中@机器人的消息。

  • 应用管理员来到飞书开放平台在“添加应用能力”中,点击添加“机器人”,然后左侧栏就会出现“机器人”。下一步进入“机器人”的配置界面,可以设置自定义菜单等。

alt

6.2 发送到个人

  • 完成绑定配置之后,来到仪表盘,点击新建订阅。

  • 按照下图选择测试账号,点击发送测试。

  • 即可在个人飞书账号上收到该推送测试消息,如未成功,则请检查上述配置是否正确。

6.3 发送到飞书群

  • 在目标飞书群按如下步骤,选择群机器人-->添加机器人。

  • 找到目标机器人,点击添加即可。

  • 完成添加之后,按照上述五.3.发送到个人的验证测试步骤,将消息发送改为飞书群,选择创建的测试群。

温馨提示:这里要设置一个最近的时间进行消息推送测试,如果选择发送测试的话,则只给推送者发送推送消息,效果与推送给个人一致。

  • 在指定时间指定群消息推送之后,则会收到创建订阅通知,且在指定时间会收到一则订阅消息,则证明配置成功;如未成功,请按照上述说明检查配置是否正确。


7. 飞书群授权(建议开启)

仪表盘和数据集的授权可以通过飞书群进行授权,如需要仪表盘/数据集给一个飞书群完成配置,则需完成上述【2. 基础配置】,然后在仪表盘/数据集针对自己有权限的资源进行授权,如下所示完成操作即可完成该账号的飞书群授权操作。

说明

该授权是哪个用户配置,则只针对该用户生效。即 A 用户配置了飞书群授权,B 用户如有需要,则需在 B 账号下重新配置。