主页 技术文档 更新历史 下载 购买 客户中心 联系我们

在EasySQLMAIL中推送消息给飞书用户

飞书消息通道配置

 

在推送消息到飞书前,需要在系统中配置飞书消息通道。EasySQLMAIL支持配置多个飞书消息通道,并可以为每个消息通道配置多个应用,用于推送不同类型的信息。

1 在飞书管理平台创建应用

Step1: 登录飞书管理后台,在"工作台"->"应用管理"中创建应用

Step2: 跳转到"开发者后台"页面后,点击"创建企业自建应用"按钮

Step3: 输入"应用名称"和"应用描述",点击"创建"按钮。

Step4: 应用创建成功后,在"添加应用能力"页面中为应用添加"机器人"能力。

Step5: 在"权限管理"中为应用添加权限。

请为应用申请以下权限:

权限名称

用途

是否必需

是否需要管理员审批

获取企业信息

用于在配置应用时确定企业的租户ID。

必需

免审权限

获取通讯录基本信息

用于读取企业通信录的基本信息,例如部门列表和员工列表,以便在设计任务时选择任务的收件人。

必需

免审权限

获取部门基础信息

用于读取部门的基础信息,例如部门名称、成员列表等,以便管理员在设计任务时选择任务的收件人。

必需

免审权限

获取用户基本信息

用于读取用户(员工)的基本信息,例如用户名称、用户的UserID等,以便管理员在设计任务时选择任务的收件人。

必需

免审权限

以应用的身份发消息

应用需要有此权限才能发送消息。

必需

免审权限

管理应用自身资源

用于在EasySQLMAIL中配置应用时读取应用的名称等信息。

必需

免审权限

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

应用需要有此权限才能发送文件。

必需

免审权限

获取用户 user ID

应用需要有此权限才能用"UserID"向用户发送消息。

必需

免审权限

获取与更新群组信息

获取群组信息

查看群信息

应用需要有此权限才能读取群的信息,以便管理员在设计任务时选择任务的收件人。

必需。只需要申请其中的一个即可。

免审权限

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

调用批量发送消息接口时需要此权限。

必需

免审权限

给多个用户批量发消息

调用批量发送消息接口时需要此权限。

必需

免审权限

给一个或多个部门的成员批量发消息

调用批量发送消息接口时需要此权限。

必需

免审权限

获取用户邮箱信息

如果要把用户的邮箱同步到EasySQLMAIL的地址薄中,则需要为应用申请此权限。

可选

免审权限

查看成员工号

需要有此权限才能把用户的"工号"字段同步到EasySQLMAIL的地址簿中。

必需

免审权限

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

读取通信录时,需要有此权限才能读取部门的上级部门信息"parent_department_id"字段。

必需

需要管理员审批

获取用户受雇信息

需要有此权限才能读取用户的激活状态。

必需

需要管理员审批

获取用户手机号

需要有此权限才能读取用户的手机号。如果需要把用户的手机号同步到地址簿,则需要申请此权限

可选

需要管理员审批

Step6: 逐一选择好权限后,点击"确认开通权限"按钮。

提示:可以在"开通权限"通话框中逐个查找要开通的权限,在所有权限都选择好后再点击"确认开通权限"按钮。

Step7(可选): 根据您的情况选择是否启用"IP白名单"。如果有固定的互联网IP地址,建议选择此选项以加强应用的安全性。

Step8: 在"版本管理与发布"中点击"创建版本"。

Step9: 输入"版本号"及"更新说明",然后选择应用的可用范围。

输入"版本号"及"更新说明"

点击"可用范围"旁边的"编辑"按钮选择应用的可用范围

选择应用的可用范围

提示:应用只能向这里选择的可用范围内的成员发送消息。

Step10: 点击"保存",然后点击"申请上线发布"。在企业管理员对新版本进行审批后,应用即可正常使用。

2 在EasySQLMAIL中添加飞书消息通道

飞书应用创建好后,需要把应用的信息添加到EasySQLMAIL中,才能推送消息。

Step1: 登录EasySQLMAIL控制台,点击"消息通道管理"->"飞书消息通道管理"->"添加飞书消息通道"。

Step2: 为消息通道输入一个名称,以便于以后管理。

Step3: 点击"确定"按钮保存消息通道信息,然后继续为消息通道添加应用。

Step4: 在"添加飞书消息通道应用"对话框中输入应用"App ID"和"App Secret"。

首先在飞书开放平台的应用管理的"凭证与基础信息"中查询应用的"App ID"和"App Secret"。

查询应用的"App ID"和"App Secret"

注意:App ID和App Secret是应用的关键信息,请妥善保管以防止泄密。

然后在EasySQLMAIL中输入应用的"App ID"和"App Secret",并点击"获取应用名称"

提示:您可以在这里输入"接收测试消息的用户账号"(即用户的"用户 ID",可以在飞书后台管理的"组织架构"->"成员与部门"中查询到),然后点击"测试"按钮,EasySQLMAIL会通过这个应用向指定的用户发送一条测试消息。

查询用户的"用户 ID"

发送测试消息

Step5: 配置完成后,点击"确定"保存应用配置。应用配置保存成功后,EasySQLMAIL会调用飞书API读取企业的通信录保存到EasySQLMAIL的数据库中。以后您配置任务时可以在收件人列表中选择飞书用户作为收件人。

配置任务时选择飞书用户作为收件人

3 通过自建应用发送消息到群

您可以通过"自建应用"发送消息到群。与"自定义群机器人"不同,通过"自建应用"发送消息到群时,可以发送文件、图片消息。

Step1: 把自建应用添加到飞书群中。

打开飞书的PC客户端,进入要发送消息的群,点击"设置"菜单。

点击"设置"菜单。

点击"群机器人"菜单。

点击"添加机器人"按钮。

在"搜索"框中输入要添加的自建应用的名称,然后点击找到的自简应用的按钮。

点击"添加"按钮。

Step2: 添加成功后,在EasySQLMAIL的"飞书消息通道管理"中重新读取飞书通信录。

通信录读取完成后,就可以在任务中选择对应的群作为任务的收件人了。系统会把任务生成的正文和附件推送到所选的群里。

提示:任务生成的HTML正文会被转换为文字消息进行推送。如果要保持正文的格式,您也可以通过设置把正文转换为PDF或图片进行推送。

4 通过自定义群机器人发送消息到群

您可以在飞书群中创建一个自定义机器人,然后在EasySQLMAIL中使用这个群机器人推送消息到群。

提示:由于飞书API的限制,系统仅能通过自定义群机器人推送文字消息和markdown消息。如果要推送文件和图片消息到群,请使用"自建应用"进行推送。

Step1: 在飞书群中创建"自定义机器人"。

打开飞书的PC客户端,进入要发送消息的群,点击"设置"菜单。

点击"群机器人"菜单。

点击"添加机器人"按钮。

点击"自定义机器人"按钮。

输入机器人信息,点击"添加"按钮

机器人添加成功后,记录下Webhook地址。并为机器人设置安全选项。

注意:机器人的"Webhook地址"和"签名"是系统的关键信息,请妥善保管以防止泄密。

Step2: 在EasySQLMAIL中配置群机器人。

群机器人添加完毕后,在配置任务时选择对应的群机器人作为收件人,系统会把消息通过所选的群机器人发送到指定的群。

5 常见问题

Q: 通过飞书推送消息时有哪些限制?

A: 根据飞书API的规则,在推送消息时有以下限制:

(1) 不支持对部门发送文件。例如,如果任务选择了以下类型的收件人,任务的附件文件无法发送给此部门:

您会在任务日志中看到以下记录:

(2) 不支持通过自定义群机器人发送文件和图片。如果要发送文件和图片到群,请使用自建应用进行发送。点击查看详细方法

(3) 每个任务选择的飞书收件人数量不能超过300个。如果超过300个会导致发送失败。

(4) 推送的文件大小不能超过30M,也不能是空文件。

(5) 推送的图片大小不能超过10M,图片分辨率不能超过 12000 x 12000。

Q: EasySQLMAIL会调用哪些飞书API接口发送消息?

A: 系统在推送消息到飞书时,会对消息进行拆分,并调用以下飞书API:

(1) 对于文字消息、markdown消息及图片消息,如果消息有多个收件人,系统会调用"批量发送消息API"进行发送。飞书API文档:https://open.feishu.cn/document/server-docs/im-v1/batch_message/send-messages-in-batches.

(2) 对于发送给部门的文字消息、markdown消息及图片消息,系统会调用"批量发送消息API"进行发送。飞书API文档:https://open.feishu.cn/document/server-docs/im-v1/batch_message/send-messages-in-batches.

(2) 对于文字消息、markdown消息及图片消息,如果消息只有一个用户收件人,系统会调用"单个消息API"进行发送。飞书API文档:https://open.feishu.cn/document/server-docs/im-v1/message/create.

(3) 对于文件消息,系统会为每个收件人调用"单个消息API"进行发送。飞书API文档:https://open.feishu.cn/document/server-docs/im-v1/message/create.

(4) 对于通过自建应用发送给群的消息,系统会调用"单个消息API"进行发送。飞书API文档:https://open.feishu.cn/document/server-docs/im-v1/message/create.

Q: 我想发送自定义的卡片消息,应该如何配置?

A: 您可以把任务类型设置为"文字消息",然后在任务的正文模中输入您自己的JSON代码。系统会把您的JSON代码转换为飞书消息的代码进行发送。

注意:

(1) 文字内容必须以 "[json_message]{" 开头,后面是JSON数据,并以 "}" 结束。需要符合JSON语法。

(2) JSON数据需要有一个 "msg_type" 字段,指出消息的类型。

(3) JSON数据需要有一个 "content" 字段,存放要发送的消息的内容。"content" 元素的格式请参考飞书API手册。

(4) 系统会尝试以JSON格式解析文字消息的内容,如果解析失败,则按普通文字消息进行发送。

以下是一个自定义卡片消息的例子:

提示:如果要发送卡片消息,您可以预先使用"飞书卡片搭建工具"来生成卡片的JSON代码。

Q: 通过变量动态指定收件人时,如何指出用户ID或部门ID的类型?

A: 调用飞书API发送消息时,可以指定收件人的ID类型,例如可以通过用户的"open_id"或"union_id"指定把消息发送给哪些用户。

通过变量设置收件的ID时,您可以在ID前明确指定ID的类型。例如:

[user_id]xxxxxxxx 表示这是一个用户的User ID。

[open_id]ou_xxxxxxxx 表示这是一个用户的Open ID。

[union_id]on_xxxxxxxx 表示这是一个用户的Union ID。

[department_id]xxxxxxxx 表示这是一个部门的Department ID。

[department_open_id]od_xxxxxxxx 表示这是一个部门的Department Open ID。

系统在处理消息时,会根据ID的类型把ID填写到调用API的JSON参数相应字段中。

最后更新时间: 2025-06-01