飞书机器人-应用对接

1.1 功能简介

本文将展开讲解如何创建飞书机器人应用并对接至 Dora 平台进行用户匹配映射。

1.2 版本

内网环境下，请提前在部署 FineBI 服务以及 Data Agent 服务的服务器上，将以下域名加入白名单，确保服务正常访问：

• open.feishu.cn

• open.larksuite.com

3.1 创建飞书自建应用

点击进去「飞书开发者后台」页面，创建企业自建应用。

3.2 为应用添加能力

创建完成后，进入应用能力配置页面，在「添加应用能力>按能力添加」机器人与网页应用能力。

3.3 配置机器人权限管理

为了使机器人具有收发消息的基础功能，需要前往「开发配置>权限管理」中配置相关，可选择批量添加或手动添加，添加方式如下：

1）批量添加

通过如下代码批量导入权限：

{
  "scopes": {
    "tenant": [
      "cardkit:card:write",
      "contact:contact.base:readonly",
      "contact:user.base:readonly",
      "contact:user.department:readonly",
      "contact:user.employee_id:readonly",
      "im:app_feed_card:write",
      "im:message",
      "im:message.group_at_msg:readonly",
      "im:message.p2p_msg:readonly",
      "im:message:readonly",
      "im:message:send_as_bot",
      "im:message:send_sys_msg",
      "im:message:update",
      "im:resource",
      "cardkit:card:write"
    ],
    "user": []
  }
}

2）手动添加

为机器人配置以下权限：

• 获取通讯录基本信息

• 获取通讯录部门组织架构信息

• 获取用户基本信息

• 获取用户 user ID

• 创建、更新、删除应用消息流卡片

• 读取用户发给机器人的单聊消息

• 获取单聊、群组消息

• 以应用的身份发消息

• 发送特定模板系统消息

• 更新消息
  

• 获取与发送单聊、群组消息

• 获取群组中用户@机器人消息

• 创建与更新卡片

• 获取与上传图片或文件资源
  

3.4 配置机器人事件与回调

3.4.1 事件配置

进入「事件与回调>事件配置」页面中为机器人添加「接收消息」事件。

3.4.2 回调配置

进入「事件与回调>回调配置」页面中为机器人添加「卡片回传交互」回调。

注：机器人应用绑定至 Agent 前，验证连接会提示失败，此为正常现象。当前阶段无需验证，请完成回调配置并保存，待绑定 Agent 后再进行验证。

3.5 配置网页应用能力

将企业已部署的 Dora PC 端与移动端访问地址分别添加至「桌面端主页」与「移动端主页」中。

3.6 配置H5可信域名

前往「安全设置>H5可信域名」，添加 Dora 服务的出口 IP 地址。

注：填写的必须是用户在移动端实际打开 Dora 时地址栏里的域名；若经过网关或反向代理访问，则填写网关对外的域名。

3.7 发布应用

完成以上配置后，点击「创建版本」，进入「版本管理与发布」中，保存并发布当前机器人应用的版本。

注：若非飞书管理员创建，需向飞书管理员申请线上发布。

3.8 获取 App ID 与 App Secret

发布成功后，进入「基础信息>凭证与基础信息」中，复制 App ID 与 App Secret。

Dora 平台的超级管理员将上述操作中获取到的 App ID 与 App Secret 回填至「用户管理>IM用户映射」飞书机器人的应用对接中，完成飞书与 Dora 平台的连接与用户映射。

以上步骤全部完成后，建议测试并确认网络连通情况： 

1）Dora 服务器能正常访问 open.feishu.cn；若后台配置了代理或私有化地址，则需要能访问对应的代理或私有化地址。

2）移动端需要能访问飞书 JSSDK 的公网 CDN lf1-cdn-tos.bytegoofy.com，Dora 会在用户点击分享时加载此能力。网络严格受限或飞书私有化部署的环境下，飞书分享暂不可用。

3）卡片的摘要和图片由飞书服务端抓取分享链接生成；若分享链接是内网地址时，分享卡片将只显示标题。