OncallBox说明文档
  1. IM集成
OncallBox说明文档
  • 用户邀请
  • 快速开始
    • 如何进行On-Call
    • 常见问题
  • 故障处理
    • 工单处理
  • 配置接入
    • 业务管理
    • 响应策略
      • 未命名文档
    • 值班表
  • 告警集成
    • 百度云接入说明
    • 微软云接入说明
    • 亚马逊云接入说明
    • 腾讯云 CM接入说明
    • 腾讯云 CLS接入说明
    • 腾讯云 Event Bridge接入说明
    • 阿里云 ARMS接入说明
    • 阿里云 CM 指标接入说明
    • 阿里云 CM 事件接入说明
    • 阿里云 SLS接入说明
    • Prometheus接入说明
    • Grafana接入说明
    • Event API接入说明
  • IM集成
    • 飞书
    • 企业微信
    • 钉钉
  • 团队与权限
    • 用户邀请
  • 用户协议
    • 服务协议
    • 隐私政策
  • 单点登录
    • Keycloack集成指引
  1. IM集成

飞书

飞书应用集成

通过集成飞书自建应用,实现在飞书端内接收和响应告警的能力。

创建飞书应用

  1. 创建自建应用
    访问飞书开发者后台,创建企业内自建应用。 (详见飞书开发文档-创建企业自建应用)

    image.png
    应用图标可使用Oncallbox图标。

  2. 复制凭证信息
    前往 凭证与基础信息 页面,复制App ID和App Secret备用。

    image.png

  3. 复制事件回调的 Token 信息
    前往开发配置-事件与回调-加密策略页面,复制Encrypt Key(推荐启用,更安全) 和Verification Token备用。

    image.png

添加飞书集成

  1. 回到OncallBox 集成中心 页面,选择即时消息>飞书,在表单中填入名称以及上一步复制的App ID、App Secret、Verification Token和Encrypt Key后,点击保存创建。

    image.png

  2. 创建后在列表中会看到刚才添加的飞书集成,点击名称进入详情后,会看到 网页配置地址、重定向 URL地址以及消息卡片请求网址等信息,后边流程会用到。

配置飞书应用

  1. 开通并配置应用能力

    1. 回到飞书开发者后台,进入刚才创建的飞书应用,进入 添加应用能力-按能力添加 页面,同时开通 网页应用 和 机器人 能力。

      image.png

    2. 前往网页应用页面,配置桌面端主页和移动端主页,内容均为集成详情中的网页配置地址。

      image.png
      (详见飞书开发文档-配置应用主页地址)

    3. 前往事件回调-回调配置页面,配置消息卡片请求网址(内容为集成详情中的 消息卡片请求网址)并添加回调。

      image.png

  2. 添加重定向 URL 到飞书应用中
    进入安全设置页面,配置重定向URL,内容为集成详情中的 重定向 URL。

    image.png
    (详见飞书开发文档-配置重定向 URL)

  3. 申请应用权限
    进入权限管理页面,申请im:chat和im:message、contact:user.id:readonly、im:message.group_at_msg:readonly、contact:contact.base:readonly、contact:user.base:readonly、contact:user.email:readonly、contact:user.phone:readonly权限。此三项权限将允许当前应用获取自身所在群聊信息以及向群聊或个人发送消息、获取用户ID的能力、获取用户基本信息、接收群@机器人的消息事件。

    image.png

  4. 配置回调地址
    进入事件与回调-回调配置页面,订阅方式选择将回调发送至开发者服务器,请求地址填写:https://event.oncallbox.com/api/message/push/feishu?app_id=cli_xxx&app_secret=lsdfjsxaxdf&encrypt_key=zzzz;同时订阅回调card.action.trigger和card.action.trigger_v1,如下图所示:

    image.png

应用发布与使用

完成上述步骤后,进行应用的发布与使用,管理员审核后即可使用。 注意:可用范围 需要特别配置,推荐 所有员工。

  1. 详见飞书开发文档-应用发布与使用。
  2. 应用发布后,就可以使用 手机端/PC 端 访问应用。首次访问需要登录并关联(飞书<->OncallBox)账号,后续可以免登录使用。
    1. 手机端:手机端通过 飞书 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。
    2. PC 端:桌面(PC)端通过 飞书 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。

飞书自定义机器人集成

自定义机器人是一种只能在当前群聊中使用的机器人。该类机器人无需经过租户管理员审核,即可在当前群聊中通过调用 webhook 地址的方式完成消息推送。

添加自定义机器人

  1. 邀请自定义机器人进群。
    1. 进入目标群组,在群组右上角点击更多按钮,并点击设置。

      image.png

    2. 在右侧设置界面,点击群机器人。

      image.png

    3. 在 群机器人 界面点击 添加机器人。

    4. 在 添加机器人 对话框,找到并点击 自定义机器人。

    5. 设置自定义机器人的头像、名称与描述,并点击 添加。

      image.png

  2. 获取自定义机器人的 webhook 地址,并点击完成。
  3. 机器人对应的webhook 地址格式如下:
    https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx

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

不支持markdown

curl --location 'https://open.feishu.cn/open-apis/bot/v2/hook/34d98274-68c8-46bd-8c37-b741c3dc3fc4' \
--header 'Content-Type: application/json' \
--data '{
        "msg_type": "post",
        "content": {
                "post": {
                        "zh_cn": {
                                "title": "我是一个标题",
                                "content": [
                                        [{
                                                        "tag": "text",
                                                        "text": "你的数据库服务发生告警,请及时关注"
                                                },
                                                {
                                                        "tag": "at",
                                                        "user_id": "all", 
                                                        "user_name": "所有人"
                                                }
                                        ]
                                ]
                        }
                }
        }
}'

参考文档

  • 自定义机器人使用指南
修改于 2025-12-04 09:19:06
上一页
Event API接入说明
下一页
企业微信
Built with