核心功能
- 支持直接发送文本、使用 ArcScript 模板生成文本、发送文件或图片,以及发送原始 JSON 请求。
- 多个端口可以共用同一个连接,并分别配置接收人和发送模式。
- 自动获取和缓存租户访问令牌;令牌失效时刷新并重试一次。
创建自建应用并获取凭据
开始前,需要有飞书企业账号,并具备创建企业自建应用的权限。已有可用应用时,可直接使用其凭据。- 登录飞书开发者后台,单击创建企业自建应用,填写应用名称、说明和图标。
- 打开应用的凭证与基础信息页面,复制 App ID 和 App Secret,分别填入端口连接的同名字段。凭据获取位置可参考飞书官方配置说明。
- 在添加应用能力中添加并启用机器人。
- 在权限管理中开通以应用的身份发消息(
im:message:send_as_bot)权限。如需发送文件或图片,也按上传文件和上传图片接口文档开通所需权限。 - 在版本管理与发布中创建版本,设置应用可用范围并提交发布,按企业要求完成管理员审核。机器人能力、发送权限和发布操作可参考飞书官网的机器人配置步骤。
Lark。完整流程可参阅开放平台的自建应用开发流程。
端口配置
连接
在设置选项卡中选择或创建连接。以下设置保存在连接中。
单击测试连接可检查凭据是否能够获取租户访问令牌。测试不会发送消息,也不验证消息发送权限和接收人是否可用。
设置选项卡
高级选项卡
使用方式
发送文本
- 选择连接并测试连接。
- 设置接收人类型和接收人,例如选择邮箱并填写成员的飞书邮箱。
- 将发送模式设为文本,传入 UTF-8 文本消息。
- 启用自动化中的发送,自动处理到达端口的消息。
150 KiB,完整请求还需符合飞书接口的大小要求。
使用 ArcScript 模板
将发送模式设为模板,在消息模板中填写文字、ArcScript 表达式或脚本。模板可以访问当前消息内容和消息头,也支持宏。例如:发送文件或图片
将发送模式设为文件,输入消息必须带有文件名且内容不能为空。端口根据文件扩展名识别图片,例如.jpg、.png、.gif,上传后发送图片消息;其他文件上传后发送文件消息。端口检查的上传大小上限为:文件 30 MiB,图片 10 MiB;格式等要求以对应上传接口为准。
如需附带说明,启用发送附带消息并填写模板。文件或图片与说明分别发送;如果前者已发送而说明失败,重试输入消息会再次发送文件或图片。
发送原始 JSON
将发送模式设为原始 JSON,输入必须是完整的消息请求 JSON 对象。以下示例发送群消息,需将接收人类型设为群 ID,并替换为实际群 ID:receive_id、msg_type 和 content。其中 content 为序列化后的消息内容 JSON 字符串,具体结构可参阅飞书官方发送消息接口。
此模式直接发送输入 JSON,不渲染模板,也不使用端口的接收人或 FeiShu-Recipient 消息头。接收人类型仍然生效;启用消息头覆盖后,也可通过 FeiShu-RecipientType 指定类型。端口将其作为查询参数 receive_id_type 发送。
输入不得包含 receive_id_type、tenant_access_token、app_id 或 app_secret 字段,身份验证由端口使用所选连接提供。