跳到主要内容
版本:4.x

Lark-IM

适用版本Cloud 功能TapData Cloud 为您提供了云端服务,适合需要快速部署、低前期投资场景,帮助您更好地专注于业务发展而非基础设施管理,注册账号即可领取免费的 Agent 实例,欢迎试用。企业版功能TapData Enterprise 可部署在您的本地数据中心,适合对数据敏感性或网络隔离有严格要求的场景,可服务于构建实时数仓,实现实时数据交换,数据迁移等场景。

飞书是一款企业级协作与管理平台,集成即时通讯、音视频会议及开放式应用。将 Lark-IM(飞书聊天消息)配置为 Tapdata 的目标后,可将数据管道中的告警事件、运营指标或自定义通知实时推送至飞书,助力团队实现实时告警通知、自动化协作与决策支持。

注意事项

  • 为避免消息发送频繁对用户造成打扰,向同一用户发送消息的限频为 5 QPS,向同一群组发送消息的限频为群内机器人共享 5 QPS。

  • 发送的文本消息请求体最大不能超过 150 KB;而卡片/富文本消息请求体最大不能超过 30 KB。

  • 通常情况下,上游数据源(例如来自数据库或日志等)产生的原始数据并不符合飞书要求的消息体结构。因此,通常在构建数据管道时,需要添加 JavaScriptPython 处理节点,对原始数据进行必要的清洗和格式化,使其符合下述结构要求的 JSON 数据。

    [
    {
    "receiveType": "{{user | email | phone | chat}}",
    "receiveId": "{{user_open_id | user_email | user_phone | chat_id}}",
    "contentType": "text",
    "content": "{\"text\":\"Hello! This is lark message! \"}"
    }
    ]
字段说明
字段名含义
receiveType接收者类型,取值范围为: user(默认)、chatemailphone
receiveId对应的接收人标识,需在应用的可见范围内,否则消息将发送失败
contentType消息类型,如 textinteractive(卡片)等
content消息体内容,需为字符串化后的 JSON 格式

更多字段介绍,见官方文档

准备工作

  1. 以管理员的身份登录飞书开放平台

  2. 在开发平台首页,进入企业自建的应用。

    提示

    关于企业自建应用的创建方法,见开发流程

  3. 在左侧导航栏,单击凭证与基础信息,获取 App ID 和 App Secret 信息,后续将在连接数据源时使用。

  4. 设置应用可用范围,确保飞书消息的目标用户或群组已纳入飞书自建应用的可见范围,避免消息接受失败。

  5. 为应用开启机器人能力,注意需要应用发布后才能生效。

添加数据源

  1. 登录 Tapdata 平台

  2. 在左侧导航栏,单击连接管理

  3. 在页面右侧,单击创建连接

  4. 在弹出的对话框中,搜索并选择 Lark-IM

  5. 根据下述说明完成数据源配置。

    Lark IM 连接设置

    • 连接名称:填写具有业务意义的独有名称。
    • 连接类型:仅支持作为目标
    • 应用 ID应用 Secret:可通过飞书开放平台获取,具体操作,见准备工作
    • agent 设置:默认为平台自动分配,您也可以手动指定。
    • 模型加载频率:数据源中模型数量大于 1 万时,Tapdata 将按照本参数的设定定期刷新模型。
  6. 单击连接测试,测试通过后单击保存

    提示

    如提示连接测试失败,请根据页面提示进行修复。