Skip to main content

飞书对接教程

第一步 进入飞书开放平台​

https://open.feishu.cn/app?lang=zh-CN

第二步 创建企业自建应用​

应用名写ChatBI

图标可自选或者从此处下载：

https://cdn.askdataservice.com/alisa.png

第三步 将应用凭证的 App ID 和 App Secret 给到我方。​

注：以下由实施工程师完成

在项目实施文件夹的 config.json 内，加入如下配置信息：

{
  "thirdParty": {
    "lark": {
      "appId": "xxxxx",
      "appSecret": "xxxxxxx"
    }
  }
}

第四步 添加应用能力 -> 网页应用​

桌面端主页和移动端主页均为私有化部署后的访问页面。

第五步 安全设置​

重定向 URL 填：

https://访问页面地址/user/login

注：部分功能需要一个 https 的域名来访问部署后的系统，而不是 ip 地址。如语音问答功能。

H5 可信域名填：

https://访问页面地址 http://IP 地址:端口号

添加机器人（可选）​

应用能力 -> 添加应用能力 -> 机器人

机器人具备群发消息以及回复消息能力。群发消息以及回复消息牵涉到权限和群发内容，需要定制化开发，请联系技术支持。

开通@机器人回复消息功能​

开发配置 -> 事件订阅

请求地址配置一栏，填写https://{host}/api/v1/util/lark/challenge。成功保存后，点击下方卡片右上角的【添加事件】按钮。

选择【消息与群组】 -> 勾选【接收消息 v2.0】

开通@机器人回复消息功能还需要增加开通一些权限：

  • 以应用身份读取通讯录（contact:contact:readonly_as_app）
  • 获取用户在群组中@机器人的消息（im:message.group_at_msg）
  • 接收群聊中@机器人消息事件（im:message.group_at_msg:readonly）
  • 获取用户发给机器人的单聊消息（im:message.p2p_msg）
  • 读取用户发给机器人的单聊消息（im:message.p2p_msg:readonly）

第六步 开通权限​

开发配置 -> 权限管理：

  • 获取用户邮箱信息（contact:user.email:readonly）
  • 获取用户 employee ID（contact:user.employee_id:readonly）
  • 获取用户 雇员信息（contact:user.employee:readonly）
  • 获取用户 user ID（contact:user.id:readonly）
  • 获取用户 user 基本信息（contact:user.base:readonly）
  • 获取用户手机号（contact:user.phone:readonly）
  • 通过手机号或邮箱获取用户 ID(contact:user.id:readonly)
  • 获取与更新群组信息（im:chat）
  • 读取群信息（im:chat.group_info:readonly）
  • 获取群组信息（im:chat:readonly）
  • 获取与发送单聊、群组消息（im:message）
  • 以应用的身份发消息（im:message:send_as_bot）

如需开通@机器人回复消息功能，需要开通以下额外的权限：

  • 以应用身份读取通讯录（contact:contact:readonly_as_app）
  • 获取用户在群组中@机器人的消息（im:message.group_at_msg）
  • 接收群聊中@机器人消息事件（im:message.group_at_msg:readonly）
  • 获取用户发给机器人的单聊消息（im:message.p2p_msg）
  • 读取用户发给机器人的单聊消息（im:message.p2p_msg:readonly）

第七步 发布应用​

自此全流程完成

注意事项

目前飞书的 iOS 端存在录音 bug，每两次录音只能获取一次。此 Bug 已被飞书官方确认，将在飞书 5.31 版本修复。