七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
飞书

接入说明-IM消息

七鱼提供了飞书客服授权接入方式。

接入方式

七鱼提供飞书企业自建应用接入方案,只需管理员在七鱼后台按照提示绑定应用相关信息即可。

接入前准备​

  1. 请准备飞书管理员权限账号
  2. 确保飞书企业状态正常

IM消息

自建应用接入飞书

步骤一:创建企业自建应用

登录 飞书开发者后台,选择【创建企业自建应用】,根据企业自身需求填写应用名称等信息,填写完成后创建应用,如图1。

图1:创建应用

步骤二:七鱼侧补充应用信息

七鱼在线接入-飞书接入-IM消息中选择【绑定飞书应用】,并补充应用信息;对应信息从飞书应用的凭证与基础信息-应用凭证和事件与回调-加密策略中获取,如图2、图3;信息填写完成后点击【保存】按钮后,系统会自动生成回调请求地址。

图2:补充应用信息

图3:获取飞书应用信息

步骤三:应用配置事件与回调请求地址

复制七鱼侧系统自动生成的请求地址,填写到飞书应用的事件配置和回调配置页面的请求地址中,订阅方式选择【将回调发送至开发者服务器】,填写完成后点击【保存】,如图4、图5。

图4:获取应用事件和回调请求地址

图5:填写应用事件与回调请求地址

步骤四:应用添加机器人并授权

飞书应用中添加应用能力页面中,添加机器人,如图6。

权限管理页面中,点击【开通权限】,勾选应用权限,开通以下权限方便进行后续身份认证和业务进行,参考图7(七鱼不会泄漏和主动存储您的员工信息):

  • ​获取通讯录基本信息 contact:contact.base:readonly
  • 获取用户基本信息 contact:user.base:readonly
  • 获取用户 user ID contact:user.employee_id:readonly
  • 获取与更新群组信息 im:chat
  • 获取与发送单聊、群组消息 im:message
  • 接收群聊中@机器人消息事件 im:message.group_at_msg:readonly
  • 读取用户发给机器人的单聊消息 im:message.p2p_msg:readonly
  • 获取与上传图片或文件资源 im:resource

事件配置中添加事件【接收消息】,需开通权限:接收群聊中@机器人消息事件、读取用户发给机器人的单聊消息、获取群组中所有消息(敏感权限),如图8。

图6:添加机器人

图7:权限管理中开通权限

图8:事件配置中添加事件及开通权限

步骤五:应用发布

版本管理与发布页面中,点击【创建版本】,进入版本详情,版本号建议1.0.0,根据需求选择应用可用范围(无特殊情况建议所有员工),填写完成后点击【保存】,随后点击【申请线上发布】可进行应用发布申请,如图9;

后续飞书管理员可在飞书管理后台-工作台-应用审核页面,进行应用上线申请审核,如图10。

图9:应用发布

图10:应用审核

步骤六:配置会话接入条件

在七鱼侧配置会话接入条件,是全部消息接入,还是机器人被@后接入,若被@后接入,会话中无需再次被@,如图11;配置好后飞书IM消息渠道接入完成。


图11:配置会话接入条件

这篇文档有帮助吗?

目录