From 8badd2aa4fe1286f399e0e3adb7c9eb3c5ec5c2d Mon Sep 17 00:00:00 2001 From: alick-liming Date: Fri, 5 Sep 2025 15:35:22 +0800 Subject: [PATCH 01/41] modify default template --- .../4. Configure On-call/4.7 Templates.md | 15 ++++++++++++--- ...37\245\346\234\272\345\231\250\344\272\272.md" | 2 +- ...00\232\347\237\245\346\250\241\346\235\277.md" | 15 ++++++++++++--- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/flashduty/en/1. On-call/4. Configure On-call/4.7 Templates.md b/flashduty/en/1. On-call/4. Configure On-call/4.7 Templates.md index 30a19499..8ceb58e4 100644 --- a/flashduty/en/1. On-call/4. Configure On-call/4.7 Templates.md +++ b/flashduty/en/1. On-call/4. Configure On-call/4.7 Templates.md @@ -293,10 +293,15 @@ Below are specific instructions for each notification channel. You need to configure `Integration Center-Instant Message-Feishu` integration first to send message cards. If custom content is not set, the system default template will be used, rendering all label information: ```go -{{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}} -{{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}} +{{if .Labels.body_text}}{{.Labels.body_text}}{{else if .Description}}{{.Description}}{{end}} +{{if .Labels.resource}}**resource** : {{(joinAlertLabels . "resource" ", ")}}{{end}} {{range $k, $v := .Labels}} -{{if not (in $k "resource" "body_text")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}} +{{if not (in $k "resource" "body_text" "body_text_with_table")}}**{{$k}}** : {{$v}}{{end}}{{end}} +{{ $root := . }} +{{ range $i, $v := .Images }} + {{ $transferURL := transferImage $root $v.Src }} + {{ if $transferURL }}![]({{$transferURL}}){{ end }} +{{ end }} ``` As shown below: @@ -343,6 +348,10 @@ You need to configure `Integration Center-Instant Message-Dingtalk` integration {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}} {{range $k, $v := .Labels}} {{if not (in $k "resource" "body_text")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}} +{{ $root := . }} +{{ range $i, $v := .Images }} +{{ $imageURL := imageSrcToURL $root $v.Src }} +{{ if $imageURL }}![]({{$imageURL}}){{ end }}{{ end }} ``` As shown below: diff --git "a/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.13 \351\200\232\347\237\245\346\234\272\345\231\250\344\272\272.md" "b/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.13 \351\200\232\347\237\245\346\234\272\345\231\250\344\272\272.md" index 61049642..eba5650d 100644 --- "a/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.13 \351\200\232\347\237\245\346\234\272\345\231\250\344\272\272.md" +++ "b/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.13 \351\200\232\347\237\245\346\234\272\345\231\250\344\272\272.md" @@ -192,7 +192,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/notification-bots" /inc connect flashduty 系统会返回应用连接信息。 - 复制返回信息中的 Endpoint 地址（如：https://integrations.zoom.us/chat/webhooks/incomingwebhook/V9S5as-zTXOSUdgMITNEwA），将其填写到通知渠道的 Zoom 机器人 Webhook 地址或 Token 字段中。 - 复制返回信息中的 Verification Token，填写到通知渠道的 Zoom 机器人 Verify Token 字段中。 -- 如需使用 @ 功能，需保证 Zoom 和 Flashduty 中的邮箱一致。管理员可在 Zoom 控制后台获取 zoom 的 user_id，并在 Flashduty 的集成中心-映射数据中创建映射表（源标签填写 email，结果标签填写 zoom_jid），最后在协作空间-分派策略中关联对应 Zoom 机器人和 映射表。 +- 如需使用 @ 功能，管理员可在 Zoom 控制后台获取 zoom 的 user_id，并在 Flashduty 的集成中心-映射数据中创建映射表（源标签填写 email，结果标签填写 zoom_jid），最后在协作空间-分派策略中关联对应 Zoom 机器人和 映射表。 描述 diff --git "a/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.7 \351\205\215\347\275\256\351\200\232\347\237\245\346\250\241\346\235\277.md" "b/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.7 \351\205\215\347\275\256\351\200\232\347\237\245\346\250\241\346\235\277.md" index 111a7a7d..c49c0990 100644 --- "a/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.7 \351\205\215\347\275\256\351\200\232\347\237\245\346\250\241\346\235\277.md" +++ "b/flashduty/zh/1. On-call/3. \351\205\215\347\275\256\347\256\241\347\220\206/4.7 \351\205\215\347\275\256\351\200\232\347\237\245\346\250\241\346\235\277.md" @@ -295,10 +295,15 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi 您需要预先配置 `集成中心-即时消息-飞书` 集成，才能发送消息卡片。如果不设置自定义内容，将采用系统默认模板，渲染全部标签信息： ```go -{{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}} -{{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}} +{{if .Labels.body_text}}{{.Labels.body_text}}{{else if .Description}}{{.Description}}{{end}} +{{if .Labels.resource}}**resource** : {{(joinAlertLabels . "resource" ", ")}}{{end}} {{range $k, $v := .Labels}} -{{if not (in $k "resource" "body_text")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}} +{{if not (in $k "resource" "body_text" "body_text_with_table")}}**{{$k}}** : {{$v}}{{end}}{{end}} +{{ $root := . }} +{{ range $i, $v := .Images }} + {{ $transferURL := transferImage $root $v.Src }} + {{ if $transferURL }}![]({{$transferURL}}){{ end }} +{{ end }} ``` 如下图所示： @@ -345,6 +350,10 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}} {{range $k, $v := .Labels}} {{if not (in $k "resource" "body_text")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}} +{{ $root := . }} +{{ range $i, $v := .Images }} +{{ $imageURL := imageSrcToURL $root $v.Src }} +{{ if $imageURL }}![]({{$imageURL}}){{ end }}{{ end }} ``` 如下图所示： From 9ce36025d7cb93516ea8976b5fcd2bec0cc58aad Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Tue, 9 Sep 2025 16:56:34 +0800 Subject: [PATCH 02/41] feat: wecom self deploy app --- ...06\346\210\220\346\214\207\345\274\225.md" | 76 ++++++++++++++----- 1 file changed, 58 insertions(+), 18 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index a717213e..31cb3528 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -5,7 +5,9 @@ date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" --- -通过集成企业微信第三方应用，实现在企业微信端内接收和响应告警的能力。 +通过集成企业微信应用，实现在企业微信端内接收和响应告警的能力。 + +支持集成**第三方应用**或**企业自建应用**。
@@ -14,45 +16,83 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide"
-## 一、安装应用 +> **集成第三方应用** 和 **集成自建应用** 只需按需配置其中之一。 + +## 一、企业微信应用授权：集成第三方应用 + --- -1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) - `应用管理` - `第三方`，选择添加第三方应用 +1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方，选择添加第三方应用 drawing -2. 搜索栏输入 `flashduty`，检索到应用，并点击 `添加` 按钮 +2. 搜索栏输入 **flashduty**，检索到应用，并点击 **添加** 按钮 drawing -3. 修改应用 `可见范围`，推荐全员或具体部门节点，防止新增成员时还要修改范围。点击 `同意以上授权并添加`，完成安装 +3. 修改应用 **可见范围**，推荐全员或具体部门节点，防止新增成员时还要修改范围。点击 **同意以上授权并添加**，完成安装 drawing -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) - `我的企业` 页面，复制 `企业ID` 作为当前页面的 `Corp ID` 填写到集成配置，点击保存，完成集成配置 +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 页面，复制 **企业ID** 作为当前页面的 `Corp ID` 填写到集成配置，点击保存，完成集成配置 drawing -5. **请注意：Flashduty作为企业微信服务商，为您提供 `FlashDuty` 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+发消息），该许可目前支持`最多60天`免费，超过后我们必须为您购买企微许可才能使用。** +:::tip +Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。该许可目前支持 **最多60天** 免费，超过后我们必须为您购买企微许可才能使用。 +::: + +## 二、企业微信应用授权：集成自建应用 + +1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方 → 创建应用 + +2. 配置 **应用logo**、**应用名称** 和 **应用可见范围**。 + +3. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，暂存生成的 `Token` 和 `EncodingAESKey` 备用。 + +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端域名 `{api_host}`（CNAME或代理转发）。 + +5. 若您的企业微信为非私有化部署版本，请在 Flashduty 中完成如下配置： + +- 企业ID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 → 企业ID。 +- AgentID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → AgentId。 +- App Secret：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → Secret。 +- 消息加密 Token：先前步骤暂存。 +- 消息加密 Aes Key：先前步骤暂存。 +- 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 + +5. 若您的企业微信为私有化部署版本，请在 Flashduty 中完成如下配置： + +- Endpoint：此地址需要能够被Flashduty服务所访问，您可以考虑做白名单授权。 +- 企业ID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 → 企业ID。 +- AgentID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → AgentId。 +- App Secret：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → Secret。 +- 消息加密 Token：先前步骤暂存。 +- 消息加密 Aes Key：先前步骤暂存。 +- 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 + +6. 在 Flashduty 中，点击 **保存** 完成集成配置。然后，将 Flashduty 生成的下列配置项填入企微的应用配置中： + +7. 访问企业微信管理后台 → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和先前步骤暂存的 `Token`、`EncodingAESKey`。 -## 二、常见问题 +## 三、常见问题 --- 1. **点击集成保存按钮，报错 `authorize app first`？** - - 请检查您是否完成应用的安装步骤，比如您是否可以在工作台看到 `FlashDuty` 这个应用 + - 请检查您是否完成应用的安装步骤，比如您是否可以在工作台看到 FlashDuty 这个应用 - 请检查您是否正确配置了 `Corp ID` -2. **如何完成账户关联？或消息发送提示`未关联应用`？** +2. **如何完成账户关联？或消息发送提示 `未关联应用`？** - - 登入企业微信客户端（桌面端和移动端均可），进入 `工作台`，找到并进入应用 `FlashDuty` - - 首次进入应用需要登录，选择成员账号 - 密码或单点登录，登入成功后，即完成 `Flashduty` 到 `企业微信` 账户关联 + - 登入企业微信客户端（桌面端和移动端均可），进入 **工作台**，找到并进入应用 FlashDuty + - 首次进入应用需要登录，选择成员账号 → 密码或单点登录，登入成功后，即完成 Flashduty 到 **企业微信** 账户关联 - 后续进入应用将免密登录 3. **如何进行故障通知？** - 必须参照问题 1，先完成账户关联，才能发送通知 - - 进入某个协作空间详情页面-分派策略，在个人渠道部分，选择通知到企业微信集成，完成通知配置 + - 进入某个协作空间详情页面 → 分派策略，在个人渠道部分，选择通知到企业微信集成，完成通知配置 - 支持对企业微信通知内容进行自定义，您前往模板管理页面，设定自定义模板。注意：**自定义区域展示行数最多 8 行**，超过会被企业微信截断 drawing @@ -60,9 +100,9 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" 4. **如何在微信内处理告警？** - 点击卡片消息，直接进入告警详情页面 - - 点击 `开始处理`，直接将告警置为 `处理中` 状态 - - 点击 `直接关闭`，直接将告警置为 `已关闭` 状态 - - 点击 `屏蔽2小时`，直接将告警屏蔽 2 小时，如果想屏蔽更多时间，点击卡片右上角 `...`有更多屏蔽选项 + - 点击 开始处理，直接将告警置为 `处理中` 状态 + - 点击 直接关闭，直接将告警置为 `已关闭` 状态 + - 点击 屏蔽2小时，直接将告警屏蔽 2 小时，如果想屏蔽更多时间，点击卡片右上角 `...` 有更多屏蔽选项 5. **为什么卡片消息提供了 `状态刷新` 按钮？** @@ -73,8 +113,8 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" 6. **Mac 桌面端点击卡片消息如何使用 `系统默认浏览器` 打开？** - Mac 桌面端默认使用端内浏览器打开链接 - - 您可以尝试快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 `调试 - 浏览器、webView相关 - 系统浏览器打开网页`，来更改链接打开模式。使用同样的快捷键可以关闭调试模式，并保持设置。 + - 您可以尝试快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 调试 → 浏览器、webView相关 → 系统浏览器打开网页，来更改链接打开模式。使用同样的快捷键可以关闭调试模式，并保持设置。 -7. **故障通知失败，提示`未开通企微许可`？** +7. **故障通知失败，提示 `未开通企微许可` ？** - 联系 Flashduty 客服或专属支持，为您购买开通 From ffb74a3b80e970325a4eac91670139959e0a6e1c Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Tue, 9 Sep 2025 17:50:33 +0800 Subject: [PATCH 03/41] feat: wecom self deploy app, pt2 --- ...06\346\210\220\346\214\207\345\274\225.md" | 30 ++++++++++++++----- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index 31cb3528..642453a5 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -38,19 +38,27 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" drawing -:::tip -Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。该许可目前支持 **最多60天** 免费，超过后我们必须为您购买企微许可才能使用。 -::: +> Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。 +> +> 该许可目前支持 **最多60天** 免费，超过后我们必须为您购买企微许可才能使用。 ## 二、企业微信应用授权：集成自建应用 1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方 → 创建应用 +![2025-09-09-17-06-46](https://docs-cdn.flashcat.cloud/images/png/06dc41d1f832619fce3e7c87fba03ced.png) + 2. 配置 **应用logo**、**应用名称** 和 **应用可见范围**。 +![2025-09-09-17-07-51](https://docs-cdn.flashcat.cloud/images/png/18cc9e9e35da7a71da70ca656d5d9814.png) + 3. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，暂存生成的 `Token` 和 `EncodingAESKey` 备用。 -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端域名 `{api_host}`（CNAME或代理转发）。 +![2025-09-09-17-12-13](https://docs-cdn.flashcat.cloud/images/png/b689fe99780788309b327ffb5faee50b.png) + +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 + +![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) 5. 若您的企业微信为非私有化部署版本，请在 Flashduty 中完成如下配置： @@ -61,7 +69,7 @@ Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期 - 消息加密 Aes Key：先前步骤暂存。 - 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 -5. 若您的企业微信为私有化部署版本，请在 Flashduty 中完成如下配置： +6. 若您的企业微信为私有化部署版本，请在 Flashduty 中完成如下配置： - Endpoint：此地址需要能够被Flashduty服务所访问，您可以考虑做白名单授权。 - 企业ID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 → 企业ID。 @@ -71,11 +79,17 @@ Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期 - 消息加密 Aes Key：先前步骤暂存。 - 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 -6. 在 Flashduty 中，点击 **保存** 完成集成配置。然后，将 Flashduty 生成的下列配置项填入企微的应用配置中： +7. 在 Flashduty 中，点击 **保存** 完成集成配置。 + +8. 访问[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和**先前步骤暂存的** `Token`、`EncodingAESKey`。 + +![2025-09-09-17-13-14](https://docs-cdn.flashcat.cloud/images/png/c3534c0afd8c5b868c943162acd2b6a8.png) + +## 三、配置作战室 -7. 访问企业微信管理后台 → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和先前步骤暂存的 `Token`、`EncodingAESKey`。 +作战室功能仅支持**企业自建应用**开启。在 Flashduty 集成配置页面的 **增强功能** 中勾选开启作战室，即可启用功该功能，无需额外配置。 -## 三、常见问题 +## 四、常见问题 --- 1. **点击集成保存按钮，报错 `authorize app first`？** From 27eff3633b5ec7a65f34f05a7b6e9ba930c6761b Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Wed, 10 Sep 2025 17:20:10 +0800 Subject: [PATCH 04/41] feat: dingtalk self deploy app --- ...06\346\210\220\346\214\207\345\274\225.md" | 171 +++++++++++++----- ...06\346\210\220\346\214\207\345\274\225.md" | 7 +- 2 files changed, 126 insertions(+), 52 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" index 1c460e22..d6b6f84a 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -4,7 +4,6 @@ description: "通过集成钉钉自建应用，实现在钉钉端内接收和响 date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" --- - 通过集成钉钉自建应用，实现在钉钉端内接收和响应告警的能力。 **（本文档以钉钉开放平台新版为例）** @@ -12,8 +11,11 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
## 视频介绍 + --- + +
## 一、创建钉钉应用 @@ -21,38 +23,37 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ### 1. 创建自建应用 -访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) - 应用开发 - 企业内部开发，创建应用。 (详见钉钉开发文档-[创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty)) +访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) → 应用开发 → 企业内部开发，创建应用。 (详见钉钉开发文档[创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty)) -drawing +![2025-09-10-17-05-48](https://docs-cdn.flashcat.cloud/images/png/aa658afccbf0e92e25071143c792955f.png) 应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 ### 2. 复制企业 CorpId -点击页面右上角企业，在下拉菜单中复制 `CorpId` 备用。 +点击页面右上角企业头像，在下拉菜单中复制 `CorpId` 备用。 -drawing +![2025-09-10-17-07-19](https://docs-cdn.flashcat.cloud/images/png/b94a0f4ab5409f02f14063de03e4502a.png) ### 3. 复制应用凭证信息 -前往 **凭证与基础信息** 页面，复制 `AgentID`、 `ClientID` 和 `ClientSecret` 备用。 +进入创建的应用等详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentID`、 `ClientID` 和 `ClientSecret` 备用。 -drawing +![2025-09-10-17-10-00](https://docs-cdn.flashcat.cloud/images/png/ac8765ffb106678e1c1a1217e8148567.png) ### 4. 复制事件订阅信息 -前往 **开发配置 - 事件与回调** 页面。 - -生成 `加密 aes_key` 和 `签名 Token` 备用。 +前往 开发配置 → **事件与回调** 页面。设置推送方式为 `HTTP推送`，然后生成 `加密 aes_key` 和 `签名 Token` 备用。 **（注意：生成 aes_key 和 Token 后请将信息临时保存到其它地方，离开页面后信息会消失，后续会用到）** -drawing +![2025-09-10-17-11-19](https://docs-cdn.flashcat.cloud/images/png/9a6a52e5802cc75578335730481b2747.png) ## 二、添加钉钉集成 + --- -回到Flashduty **集成中心** 页面，选择即时消息 > 钉钉，在表单中填入 `集成名称` 以及上一步复制的 应用信息后，点击保存创建。 +回到 Flashduty **集成中心** 页面，选择 即时消息 → 钉钉，在表单中填入 **集成名称** 以及先前步骤复制的 **应用信息** 后，点击保存创建。 drawing @@ -61,101 +62,171 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" drawing ## 三、配置钉钉应用 + --- ### 1. 添加酷应用、网页应用和机器人 + drawing -1）创建酷应用 **酷应用-酷应用列表** 页面，点击 **创建酷应用** 按钮，选择 **扩展到群会话** +1. 创建酷应用。进入 酷应用 → **酷应用列表** 页面，点击 **创建酷应用** 按钮，选择 **扩展到群会话** drawing -2）进入到 **编辑酷应用** 页面，完成以下步骤： - -2.1) 第一步，填写基本信息，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +2. 进入到 **编辑酷应用** 页面，完成以下步骤： + 1. 填写基本信息，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 drawing -2.2) 第二步，配置功能设计，左侧选中 **群快捷入口** 和 **消息卡片**。群快捷入口图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，桌面和移动端访问地址请复制集成详情里的 **酷应用网页地址**。 + 2. 配置功能设计，左侧选中 **群快捷入口** 和 **消息卡片**。群快捷入口图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，桌面和移动端访问地址请复制集成详情里的 **酷应用网页地址**。 drawing -2.3) 跳过第三步功能开发，来到第四步 **预览发布**，点击 **发布** 按钮并确认。 +3. 跳过第三步功能开发，来到第四步 **预览发布**，点击 **发布** 按钮并确认。 ### 2. 配置机器人与消息推送 -进入 **应用能力-机器人** 页面，打开机器人配置，填写名称并上传图标，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，保存即可。 +进入 应用能力 → **机器人** 页面，打开机器人配置，填写名称并上传图标，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，保存即可。 drawing ### 3. 配置应用地址 -进入 **应用能力-网页应用** 页面 +进入 **应用能力 → 网页应用** 页面 -1）配置 **应用首页地址** 和 **PC 端首页地址**，内容为集成详情中的 **应用首页地址** 和 **PC 端首页地址**。 +1. 配置 **应用首页地址** 和 **PC 端首页地址**，内容为集成详情中的 **应用首页地址** 和 **PC 端首页地址**。 -2）点击右上角 **保存**。 +2. 点击右上角 **保存**。 drawing ### 4. 配置事件订阅 -1）**开发配置-事件订阅** 页面，配置 **请求网址**，内容为集成详情中的 **事件订阅请求网址**，配置完成后**保存**。 +1. 开发配置 → **事件订阅** 页面，配置 **加密 aes_key**、**签名 token**、**请求网址**，内容分别为先前步骤中生成的 aes_key 和 token、集成详情中的 **事件订阅请求网址**。配置完成后 **保存**。 -drawing +![2025-09-10-17-14-22](https://docs-cdn.flashcat.cloud/images/png/ad81265339dc1ce50f6a6cb2c4321ee0.png) -2）**保存**按钮下方，选中`群会话更换群名称`、`群内安装酷应用`和`群内卸载酷应用`三种群会话事件，配置完成后**保存**。 +2. **保存** 按钮下方，选中 `群会话更换群名称`、`群内安装酷应用` 和 `群内卸载酷应用` 三种群会话事件，配置完成后 **保存**。 drawing ### 5. 申请应用权限 -进入 权限管理 页面，申请 `qyapi_chat_manage` 和 `qyapi_robot_sendmsg` 两项权限。此两项权限将允许当前应用获取自身所在群聊信息以及向群聊或个人发送消息的能力。 +进入 开发配置 → 权限管理 页面，为先前步骤创建的群应用申请下面的权限： + +- `qyapi_chat_manage` ：获取群聊信息 +- `qyapi_robot_sendmsg`：向群聊或个人发送消息 + +![2025-09-10-16-47-06](https://docs-cdn.flashcat.cloud/images/png/3d16611b7a2131192808988c64d13585.png) + +## 四、配置作战室 + +### 1. 配置群模版 + +通过钉钉开放平台顶部菜单栏，前往 开放能力 → **场景群**。 + +1. 配置 **群机器人**。在左侧菜单栏中选择 **机器人**，然后点击 **创建群机器人**。 + +> 本步骤中配置的 **群机器人** 和 **应用机器人** 是两个不同的概念。群机器人被用于在生成群聊时自动创建群机器人。群机器人和应用机器人拥有不同的 **机器人 ID**。若要为钉钉开启作战室功能，必须额外配置 **群机器人**。 + +填写群机器人配置。**消息回调地址**、**消息回调token**、**信息来源网站 **三项配置在 Flashduty 的应用场景中并无实际作用，您可选择任意满足要求的值进行配置。 + +**示例配置**： + +| 配置项 | 值 | +| ------------- | ------------------------------------------------------------ | +| 机器人名称 | Flashduty | +| 机器人头像 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 简介 | Flashduty | +| 消息预览图 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 详细描述 | Flashduty 消息推送机器人。 | +| 消息回调地址 | https://flashcat.cloud/ | +| 消息回调token | token | +| 信息来源网站 | https://flashcat.cloud/ | + +完成配置后，点击 **创建**，然后点击 **审批**。右上角弹出 “提交成功” 后，钉钉已自动完成群机器人的审批。 + +![2025-09-10-15-36-24](https://docs-cdn.flashcat.cloud/images/png/ada57d1f58c50250ee2136a08bf3093c.png) + +2. 配置 **群模版**。在左侧菜单栏中选择 **群模版**，点击 **创建群模版**。 + +将 **企业类型** 设置为 `企业内部`，将 **可选应用** 设置为先前步骤创建的自建应用。然后，在下一步骤中填写模版信息。 + +**模版名称**、**图标**、**描述**、**文案介绍**、**模版描述**、**图片介绍** 等介绍性信息不会影响群模版功能的使用，您可选择任意满足要求的值进行配置。 + +**示例配置**： + +| 配置项 | 值 | +| -------- | ------------------------------------------------------------ | +| 模版名称 | Flashduty 作战室 | +| 图标 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 描述 | 为活跃故障一键创建作战室。 | +| 文案介绍 | 为活跃故障一键创建作战室。 | +| 模版描述 | 为活跃故障一键创建作战室。 | +| 图片介绍 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | + +在 **选择机器人** 配置项中，点击 **选择已创建的机器人**，选择上一步骤中创建的群机器人。其他配置项保持默认。最后点击 **保存编辑**。 + +![2025-09-10-15-42-04](https://docs-cdn.flashcat.cloud/images/png/04f734bb11ed708208c05af5540082fe.png) +![2025-09-10-15-42-45](https://docs-cdn.flashcat.cloud/images/png/1a29b155159c0386d51e65f50faa7827.png) + +在 **填写灰度群** 步骤中，点击 **创建灰度群**，然后点击 **发布灰度**。 + +最后，再次点击左侧菜单栏的 **群模版**，然后点击进入刚才创建的群模版。点击 **提交审核**，待钉钉自动通过审核后，最后点击 **发布**。 + +3. 在已经发布的群模版详细信息页，复制 **模版 ID** 和 **机器人 ID** 备用。 + +![2025-09-10-15-45-42](https://docs-cdn.flashcat.cloud/images/png/3a7750ec7d7cfa05abfe4b8f3f8443fa.png) + +### 5. 申请应用权限 + +进入 权限管理 页面，为先前步骤创建的群应用申请下面的权限： -drawing +- `qyapi_chat_read`：获取群聊信息 +- `qyapi_chat_base_read`：获取群聊信息 +- `qyapi_get_member_by_mobile`：允许当前应用根据手机号获取钉钉用户以便邀请用户加入群聊 + +![2025-09-10-16-46-05](https://docs-cdn.flashcat.cloud/images/png/f85793aff8f1d97fe0c6e0259b14e2d7.png) ## 四、应用发布与使用 --- -完成上述步骤后，进行**应用发布-版本管理与发布**，进行创建新版本，然后进行发布（注意把可见范围调整为全部员工，否则其他人无法使用） +完成上述步骤后，进行 应用发布 → **版本管理与发布**，进行创建新版本，然后进行发布。 + +> 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 drawing drawing -应用发布后，就可以使用 手机端/PC 端 访问应用。首次访问需要登录并关联（钉钉< - >Flashduty）账号，后续可以免登录使用。 - -1. 手机端：手机端通过 钉钉 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。 -2. PC 端：桌面（PC）端通过 钉钉 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。 +应用发布后，就可以使用 **手机端 / PC 端** 访问应用。首次访问需要登录并关联（钉钉 ↔ Flashduty）账号，后续可以免登录使用。 +1. 手机端：手机端通过 钉钉 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 +2. PC 端：桌面（PC）端通过 钉钉 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 ## 五、常见问题 --- -1. **消息无法投递到个人**，操作记录提示`未关联应用`？ - - - 前往 钉钉 > 工作台 > 搜索应用名称 > 打开应用，完成一次登录并关联（钉钉< - >Flashduty）账号，系统才能拿到用户身份进行消息推送 +1. **消息无法投递到个人，操作记录提示 `未关联应用`？** + - 前往 钉钉 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（钉钉 ↔ Flashduty）账号，系统才能拿到用户身份进行消息推送 2. **消息卡片按钮点击无效或报错？** - - - 前往 钉钉 > 工作台 > 搜索应用名称 > 打开应用，完成一次登录并关联（钉钉< - >Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 - - 确保已购买足够的 license，已使用 license 情况，可以在控制台 > 费用中心查看 - + - 前往 钉钉 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（钉钉 ↔ Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 + - 确保已购买足够的 license，已使用 license 情况，可以在控制台 → 费用中心查看 3. **分派策略钉钉群聊列表为空？** - - - 前往 钉钉，选择群聊会话安装酷应用，否则无法拿到群聊列表 - - 回到分派策略配置页面，刷新后重新选择群聊列表 - - 如果仍然拿不到群聊列表，请尝试群内卸载酷应用后，重试以上步骤。如果还不可以，请联系客户或专属技术支持 + - 前往 钉钉，选择群聊会话安装酷应用，否则无法拿到群聊列表 + - 回到分派策略配置页面，刷新后重新选择群聊列表 + - 如果仍然拿不到群聊列表，请尝试群内卸载酷应用后，重试以上步骤。如果还不可以，请联系客户或专属技术支持 drawing drawing drawing -4. **钉钉自建应用 API 调用量：** [钉钉文档说明](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI) +4. **钉钉自建应用 API 调用量？** -| 钉钉版本 | 调用总量/月 | QPS| 刷新时间 | -| :----------: | :--: | :----: | :----:| -|标准版|10,000 次|20|每月1日| -|专业版|50万次|40| 每月1日 | -|专属版|550万次|60| 每月1日 | +| 钉钉版本 | 调用总量/月 | QPS | 刷新时间 | +| :--------: | :-----------: | :---: | :--------: | +| 标准版 | 10,000 次 | 20 | 每月1日 | +| 专业版 | 50万次 | 40 | 每月1日 | +| 专属版 | 550万次 | 60 | 每月1日 | -**注意：** 超出限制后将无法正常推送消息，建议合理使用通知渠道 +> 超出 API 调用量限制后，钉钉应用将无法正常推送消息，建议合理使用通知渠道。[钉钉文档说明](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index 642453a5..d486d155 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -7,7 +7,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" 通过集成企业微信应用，实现在企业微信端内接收和响应告警的能力。 -支持集成**第三方应用**或**企业自建应用**。 +支持[集成第三方应用](#third-party)或[集成企业自建应用](#self)。
@@ -18,8 +18,8 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" > **集成第三方应用** 和 **集成自建应用** 只需按需配置其中之一。 + ## 一、企业微信应用授权：集成第三方应用 - --- 1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方，选择添加第三方应用 @@ -42,7 +42,9 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" > > 该许可目前支持 **最多60天** 免费，超过后我们必须为您购买企微许可才能使用。 + ## 二、企业微信应用授权：集成自建应用 +--- 1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方 → 创建应用 @@ -86,6 +88,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" ![2025-09-09-17-13-14](https://docs-cdn.flashcat.cloud/images/png/c3534c0afd8c5b868c943162acd2b6a8.png) ## 三、配置作战室 +--- 作战室功能仅支持**企业自建应用**开启。在 Flashduty 集成配置页面的 **增强功能** 中勾选开启作战室，即可启用功该功能，无需额外配置。 From 0903b32dc30cf6006cfce64c195f1cb22ddb1f8c Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Wed, 10 Sep 2025 18:01:09 +0800 Subject: [PATCH 05/41] refactor: feishu --- ...06\346\210\220\346\214\207\345\274\225.md" | 86 ++++++++++--------- 1 file changed, 44 insertions(+), 42 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" index 84dc6a8d..61663735 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -18,28 +18,28 @@ sidebarDepth: 3 ### 1. 创建自建应用 -访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。 (详见飞书开发文档-[创建企业自建应用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac)) +访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。 应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 -drawing +详见飞书开发文档[创建企业自建应用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac)。 -应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +drawing ### 2. 复制凭证信息 -前往 **凭证与基础信息** 页面，复制 `App ID` 和 `App Secret`备用。 +前往 **凭证与基础信息** 页面，复制 `App ID` 和 `App Secret` 备用。 drawing ### 3. 复制事件回调的 Token 信息 -前往 **开发配置-事件与回调-加密策略** 页面，复制 `Encrypt Key`（推荐启用，更安全） 和 `Verification Token`备用。 +前往 开发配置 → 事件与回调 → **加密策略** 页面，复制 `Encrypt Key`（推荐启用，更安全） 和 `Verification Token ` 备用。 drawing ## 二、添加飞书集成 --- -回到 Flashduty **集成中心** 页面，选择 **即时消息=>飞书**，在表单中填入 `名称` 以及上一步复制的`App ID`、`App Secret`、`Verification Token` 和 `Encrypt Key`后，点击保存创建。 +回到 Flashduty **集成中心** 页面，选择 **即时消息** → **飞书**，在表单中填入 `名称` 以及上一步复制的 `App ID`、`App Secret`、`Verification Token` 和 `Encrypt Key` 后，点击保存创建。 drawing @@ -52,32 +52,35 @@ sidebarDepth: 3 ### 1. 开通并配置应用能力 -1). 回到飞书开发者后台，进入刚才创建的飞书应用，进入 **添加应用能力-按能力添加** 页面，同时开通 **网页应用** 和 **机器人** 能力。 +1. 回到飞书开发者后台，进入刚才创建的飞书应用，进入 **添加应用能力** → **按能力添加** 页面，同时开通 **网页应用** 和 **机器人** 能力。 drawing -2). 前往 **网页应用** 页面，配置 `桌面端主页` 和 `移动端主页`，内容均为集成详情中的 **网页配置** 地址。 +2. 前往 **网页应用** 页面，配置 `桌面端主页` 和 `移动端主页`，内容均为集成详情中的 **网页配置** 地址。 drawing -(详见飞书开发文档-[配置应用主页地址](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844)) +详见飞书开发文档[配置应用主页地址](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844)。 -3). 前往 **事件回调-回调配置** 页面，配置 `消息卡片请求网址`（内容为集成详情中的 **消息卡片请求网址**）并添加回调。 +3. 前往 **事件回调** → **回调配置** 页面，配置 `消息卡片请求网址`（内容为集成详情中的 **消息卡片请求网址**）并添加回调。 drawing drawing -### 2. 添加重定向 URL 到飞书应用中 +### 2. 添加重定向 URL 到飞书应用 进入 **安全设置** 页面，配置 `重定向URL`，内容为集成详情中的 **重定向 URL**。 drawing -(详见飞书开发文档-[配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)) +详见飞书开发文档[配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)。 ### 3. 申请应用权限 -进入 **权限管理** 页面，申请 `im:chat` 和 `im:message` 两项权限。此两项权限将允许当前应用获取自身所在群聊信息以及向群聊或个人发送消息的能力。 +进入 **权限管理** 页面，为先前步骤创建的群应用申请下面的权限： + +- `im:chat`：获取群聊信息 +- `im:message`：向群聊或个人发送消息 drawing @@ -85,53 +88,52 @@ sidebarDepth: 3 --- 完成上述步骤后，进行应用的发布与使用，管理员审核后即可使用。 -注意：**可用范围** 需要特别配置，推荐 **所有员工**。 + +详见飞书开发文档[应用发布与使用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4)。 + +> 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 drawing -详见飞书开发文档-[应用发布与使用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4)。 -应用发布后，就可以使用 手机端/PC 端 访问应用。首次访问需要登录并关联（飞书< - >Flashduty）账号，后续可以免登录使用。 +应用发布后，可以使用 手机端 / PC 端 访问应用。首次访问需要登录并关联（飞书 ↔ Flashduty）账号，后续可以免登录使用。 -1. 手机端：手机端通过 飞书 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。 -2. PC 端：桌面（PC）端通过 飞书 > 工作台 > 搜索应用名称 > 打开应用 使用网页应用。 +1. 手机端：手机端通过 飞书 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 +2. PC 端：桌面端通过 飞书 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 ## 五、常见问题 --- -1. **消息无法投递到个人**，操作记录提示`未关联应用`？ - - - 前往 飞书 > 工作台 > 搜索应用名称 > 打开应用，完成一次登录并关联（飞书< - >Flashduty）账号，系统才能拿到用户身份进行消息推送 - +1. **消息无法投递到个人，操作记录提示`未关联应用`？** + - 前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号，系统才能拿到用户身份进行消息推送 + 2. **消息卡片按钮点击无效或报错**？ - - - 确保账户已经完成关联，前往 飞书 > 工作台 > 搜索应用名称 > 打开应用，完成一次登录并关联（飞书< - >Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 - - 确保已购买足够的 license，已使用 license 情况，可以在控制台 > 费用中心查看 - + - 确保账户已经完成关联，前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 + - 确保已购买足够的 license，已使用 license 情况，可以在控制台 → 费用中心查看 + 3. **分派策略飞书群聊列表为空**？ - - - 前往 飞书，选择群聊会话，添加已创建的Flashduty机器人，如下图所示： + - 前往飞书，选择群聊会话，添加已创建的 Flashduty 机器人，如下图所示： - 回到分派策略配置页面，刷新后重新选择群聊列表 drawing drawing -4. **飞书自建应用 API 限制：** [飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit) +4. **飞书自建应用 API 限制？** - **调用量限制：** +**调用量限制：** - | 飞书版本 | 调用总量/月 | 刷新时间 | - | :----------: | :--: | :----: | - |基础免费版|10,000 次|每个自然月的 1 号| - |其他版本|不限制|-| +| 飞书版本 | 调用总量/月 | 刷新时间 | +| :----------: | :--: | :----: | +|基础免费版|10,000 次|每月1日| +|其他版本|不限制|-| - **频控限制：** +**频控限制：** - | 场景 | 限制 | - | :----------: | :--: | - |所有接口|每个应用最高频率 50 次/秒| - |发消息接口|每个应用最高频率 1000 次/分钟| - |群机器人 Webhook|最高频率 100 次/分钟| - |给同一个用户或同一个群发消息|最高频率 5 次/秒| +| 场景 | 限制 | +| :----------: | :--: | +|所有接口|每个应用最高频率 50 次/秒| +|发消息接口|每个应用最高频率 1000 次/分钟| +|群机器人 Webhook|最高频率 100 次/分钟| +|给同一个用户或同一个群发消息|最高频率 5 次/秒| - **注意：** 超出限制后将无法正常推送消息，建议合理使用通知渠道 +> 超出 API 调用量限制后，钉钉应用将无法正常推送消息，建议合理使用通知渠道。[飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit) \ No newline at end of file From 01c55b148aa40bb5be99ed5b61a509bebda15760 Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Wed, 10 Sep 2025 18:04:18 +0800 Subject: [PATCH 06/41] refactor: feishu, pt2 --- ...k \351\233\206\346\210\220\346\214\207\345\274\225.md" | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" index 61663735..da478ce9 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -58,10 +58,10 @@ sidebarDepth: 3 2. 前往 **网页应用** 页面，配置 `桌面端主页` 和 `移动端主页`，内容均为集成详情中的 **网页配置** 地址。 -drawing - 详见飞书开发文档[配置应用主页地址](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844)。 +drawing + 3. 前往 **事件回调** → **回调配置** 页面，配置 `消息卡片请求网址`（内容为集成详情中的 **消息卡片请求网址**）并添加回调。 drawing @@ -71,10 +71,10 @@ sidebarDepth: 3 进入 **安全设置** 页面，配置 `重定向URL`，内容为集成详情中的 **重定向 URL**。 -drawing - 详见飞书开发文档[配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)。 +drawing + ### 3. 申请应用权限 进入 **权限管理** 页面，为先前步骤创建的群应用申请下面的权限： From cd0efc5e0eeea89d2b15097a9b974deff2564cab Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Thu, 11 Sep 2025 14:18:55 +0800 Subject: [PATCH 07/41] refactor: feishu, pt3 --- ...06\346\210\220\346\214\207\345\274\225.md" | 44 +++++++++++-------- ...06\346\210\220\346\214\207\345\274\225.md" | 6 ++- 2 files changed, 30 insertions(+), 20 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" index da478ce9..ec88d4be 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -1,7 +1,8 @@ --- -title: Contributing to our documentation — Meilisearch documentation -description: The Meilisearch documentation is open-source. Learn how to help make it even better. -sidebarDepth: 3 +title: 飞书集成 +description: 通过集成飞书自建应用，实现在飞书端内接收和响应告警的能力 +date: "2025-05-19T10:00:00+08:00" +url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" --- 通过集成飞书自建应用，实现在飞书端内接收和响应告警的能力。 @@ -18,23 +19,24 @@ sidebarDepth: 3 ### 1. 创建自建应用 -访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。 应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 详见飞书开发文档[创建企业自建应用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac)。 -drawing +![2025-09-11-11-58-10](https://docs-cdn.flashcat.cloud/images/png/4d86df2305e788e1464b170835dec13d.png) ### 2. 复制凭证信息 前往 **凭证与基础信息** 页面，复制 `App ID` 和 `App Secret` 备用。 -drawing + +![2025-09-11-12-00-22](https://docs-cdn.flashcat.cloud/images/png/903780c245c7ff2119c9885bb4adf151.png ### 3. 复制事件回调的 Token 信息 -前往 开发配置 → 事件与回调 → **加密策略** 页面，复制 `Encrypt Key`（推荐启用，更安全） 和 `Verification Token ` 备用。 +前往 开发配置 → 事件与回调 → **加密策略** 页面，生成并复制 `Encrypt Key`（推荐启用，更安全） 和 `Verification Token ` 备用。 -drawing +![2025-09-11-12-02-33](https://docs-cdn.flashcat.cloud/images/png/10870591ec4c450c6014119a6f2b6b84.png) ## 二、添加飞书集成 --- @@ -54,7 +56,7 @@ sidebarDepth: 3 1. 回到飞书开发者后台，进入刚才创建的飞书应用，进入 **添加应用能力** → **按能力添加** 页面，同时开通 **网页应用** 和 **机器人** 能力。 -drawing +![2025-09-11-12-05-32](https://docs-cdn.flashcat.cloud/images/png/7f7a6417533dda0617e55a7729c3d18a.png) 2. 前往 **网页应用** 页面，配置 `桌面端主页` 和 `移动端主页`，内容均为集成详情中的 **网页配置** 地址。 @@ -62,10 +64,12 @@ sidebarDepth: 3 drawing -3. 前往 **事件回调** → **回调配置** 页面，配置 `消息卡片请求网址`（内容为集成详情中的 **消息卡片请求网址**）并添加回调。 +3. 前往 **事件回调** → **回调配置** 页面，配置 `订阅方式`（内容为集成详情中的 **消息卡片请求网址**）。然后，订阅下面两项回调： + +- `card.action.trigger` +- `card.action.trigger_v1` -drawing -drawing +![2025-09-11-11-25-32](https://docs-cdn.flashcat.cloud/images/png/948b242146b641671795600473401439.png) ### 2. 添加重定向 URL 到飞书应用 @@ -73,16 +77,17 @@ sidebarDepth: 3 详见飞书开发文档[配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)。 -drawing +![2025-09-11-11-29-49](https://docs-cdn.flashcat.cloud/images/png/263849573db72f0ca6253b5d8572da94.png) ### 3. 申请应用权限 进入 **权限管理** 页面，为先前步骤创建的群应用申请下面的权限： -- `im:chat`：获取群聊信息 -- `im:message`：向群聊或个人发送消息 +- `im:chat`：获取与更新群组信息 +- `im:message`：获取与发送单聊、群组消息 +- `contact:user.id:readonly`：通过手机号或邮箱获取用户 ID（用于配置作战室） -drawing +![2025-09-11-11-32-48](https://docs-cdn.flashcat.cloud/images/png/ad17a4dab9767327f86a33728ecf659f.png) ## 四、应用发布与使用 --- @@ -93,7 +98,7 @@ sidebarDepth: 3 > 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 -drawing +![2025-09-11-12-07-30](https://docs-cdn.flashcat.cloud/images/png/f8262ed8cf28064c20e27d1a0c2afad6.png) 应用发布后，可以使用 手机端 / PC 端 访问应用。首次访问需要登录并关联（飞书 ↔ Flashduty）账号，后续可以免登录使用。 @@ -104,14 +109,17 @@ sidebarDepth: 3 ## 五、常见问题 --- -1. **消息无法投递到个人，操作记录提示`未关联应用`？** +1. **消息无法投递到个人，操作记录提示 `未关联应用`？** + - 前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号，系统才能拿到用户身份进行消息推送 2. **消息卡片按钮点击无效或报错**？ + - 确保账户已经完成关联，前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 - 确保已购买足够的 license，已使用 license 情况，可以在控制台 → 费用中心查看 3. **分派策略飞书群聊列表为空**？ + - 前往飞书，选择群聊会话，添加已创建的 Flashduty 机器人，如下图所示： - 回到分派策略配置页面，刷新后重新选择群聊列表 diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" index d6b6f84a..42dc191a 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -23,7 +23,9 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ### 1. 创建自建应用 -访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) → 应用开发 → 企业内部开发，创建应用。 (详见钉钉开发文档[创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty)) +访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) → 应用开发 → **企业内部开发** 创建应用。 + +详见钉钉开发文档[创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty) ![2025-09-10-17-05-48](https://docs-cdn.flashcat.cloud/images/png/aa658afccbf0e92e25071143c792955f.png) @@ -37,7 +39,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ### 3. 复制应用凭证信息 -进入创建的应用等详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentID`、 `ClientID` 和 `ClientSecret` 备用。 +进入创建的应用详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentID`、 `ClientID` 和 `ClientSecret` 备用。 ![2025-09-10-17-10-00](https://docs-cdn.flashcat.cloud/images/png/ac8765ffb106678e1c1a1217e8148567.png) From 5455ffc735f6bb80c126a3bef683cfee93175d0d Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Thu, 11 Sep 2025 14:51:20 +0800 Subject: [PATCH 08/41] refator: update images for wecom --- ...06\346\210\220\346\214\207\345\274\225.md" | 2 +- ...06\346\210\220\346\214\207\345\274\225.md" | 35 ++++++++++--------- 2 files changed, 20 insertions(+), 17 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" index ec88d4be..06dc5f12 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -47,7 +47,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" 创建后在列表中会看到刚才添加的飞书集成，点击名称进入详情后，会看到 **网页配置** 地址、**重定向 URL** 地址以及 **消息卡片请求网址** 等信息，后边流程会用到。 -drawing +![2025-09-11-14-23-52](https://docs-cdn.flashcat.cloud/images/png/bf2ae6f78c0637e8dfc7d46394e64fa5.png) ## 三、配置飞书应用 --- diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index d486d155..05b316a0 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -7,7 +7,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" 通过集成企业微信应用，实现在企业微信端内接收和响应告警的能力。 -支持[集成第三方应用](#third-party)或[集成企业自建应用](#self)。 +支持 [集成第三方应用](#third-party) 或 [集成企业自建应用](#self)。
@@ -22,27 +22,30 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" ## 一、企业微信应用授权：集成第三方应用 --- -1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方，选择添加第三方应用 +> Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。 +> +> 该许可目前支持 **最多60天** 免费，超出该使用时长后我们必须为您购买企微许可，方可继续使用。 -drawing +1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 应用，选择 **添加第三方应用**。 -2. 搜索栏输入 **flashduty**，检索到应用，并点击 **添加** 按钮 +![2025-09-11-14-38-18](https://docs-cdn.flashcat.cloud/images/png/c02371e3e2e63ed54687127e9d1e5130.png) -drawing +2. 搜索栏输入 **FlashDuty**，检索到应用，并点击 **添加** 按钮。 -3. 修改应用 **可见范围**，推荐全员或具体部门节点，防止新增成员时还要修改范围。点击 **同意以上授权并添加**，完成安装 +![2025-09-11-14-39-06](https://docs-cdn.flashcat.cloud/images/png/6e476fa462d64e4b2fca9350aec3163f.png) -drawing +3. 修改应用 **可见范围**，推荐选择全员或具体部门节点，防止新增企业成员时仍需修改应用可见范围。点击 **同意以上授权并添加**，完成安装。 -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 页面，复制 **企业ID** 作为当前页面的 `Corp ID` 填写到集成配置，点击保存，完成集成配置 +![2025-09-11-14-41-43](https://docs-cdn.flashcat.cloud/images/png/4b4d8bfbf7d97e3bcbd4ace800ff4390.png) -drawing +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 页面，获取 **企业ID** 。 -> Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。 -> -> 该许可目前支持 **最多60天** 免费，超过后我们必须为您购买企微许可才能使用。 +![2025-09-11-14-45-59](https://docs-cdn.flashcat.cloud/images/png/cc887d8f20433c0427c15ef4f377578c.png) + +5. 前往 Flashduty 集成配置页面，填写先前步骤获取的 **企业ID**，点击保存后，完成集成配置。 + ## 二、企业微信应用授权：集成自建应用 --- @@ -110,7 +113,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" - 必须参照问题 1，先完成账户关联，才能发送通知 - 进入某个协作空间详情页面 → 分派策略，在个人渠道部分，选择通知到企业微信集成，完成通知配置 - - 支持对企业微信通知内容进行自定义，您前往模板管理页面，设定自定义模板。注意：**自定义区域展示行数最多 8 行**，超过会被企业微信截断 + - 支持对企业微信通知内容进行自定义，您前往模板管理页面，设定自定义模板。**自定义区域展示行数最多 8 行**，超出文本将会被企业微信截断 drawing @@ -119,18 +122,18 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" - 点击卡片消息，直接进入告警详情页面 - 点击 开始处理，直接将告警置为 `处理中` 状态 - 点击 直接关闭，直接将告警置为 `已关闭` 状态 - - 点击 屏蔽2小时，直接将告警屏蔽 2 小时，如果想屏蔽更多时间，点击卡片右上角 `...` 有更多屏蔽选项 + - 点击 屏蔽2小时，直接将告警屏蔽 2 小时；如果想屏蔽更多时间，点击卡片右上角 `...` 查看更多屏蔽选项 5. **为什么卡片消息提供了 `状态刷新` 按钮？** - 企业微信限制一次卡片交互后 72 小时只可更新一次。每一次按钮操作，都是一次交互 - - 当告警的状态发生变化时，Flashduty会请求卡片内容更新 + - 当告警的状态发生变化时，Flashduty 会请求卡片内容更新 - 当告警状态频繁变化时，可能因为超过更新次数限制，导致卡片无法实时更新，这时可以点击刷新按钮，来获得一次更新卡片状态机会 6. **Mac 桌面端点击卡片消息如何使用 `系统默认浏览器` 打开？** - Mac 桌面端默认使用端内浏览器打开链接 - - 您可以尝试快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 调试 → 浏览器、webView相关 → 系统浏览器打开网页，来更改链接打开模式。使用同样的快捷键可以关闭调试模式，并保持设置。 + - 您可以尝试快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 调试 → 浏览器、webView相关 → 系统浏览器打开网页，来更改链接打开模式。使用同样的快捷键可以关闭调试模式，并保持设置 7. **故障通知失败，提示 `未开通企微许可` ？** From c871512d2714101637b3e1c5382cef4d5575b62c Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Thu, 11 Sep 2025 15:07:11 +0800 Subject: [PATCH 09/41] refactor: dingtalk --- ...06\346\210\220\346\214\207\345\274\225.md" | 45 ++++++++----------- 1 file changed, 19 insertions(+), 26 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" index 42dc191a..15fe06d7 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -18,7 +18,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
-## 一、创建钉钉应用 +## 一、创建钉钉应用 & 添加钉钉集成 --- ### 1. 创建自建应用 @@ -31,40 +31,31 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" 应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 -### 2. 复制企业 CorpId +### 2. 复制企业 `CorpId` -点击页面右上角企业头像，在下拉菜单中复制 `CorpId` 备用。 +点击页面右上角企业头像，在下拉菜单中复制 `CorpId`。 ![2025-09-10-17-07-19](https://docs-cdn.flashcat.cloud/images/png/b94a0f4ab5409f02f14063de03e4502a.png) +回到 Flashduty 集成配置页面，在表单中填入对应的 `CorpId`。 + ### 3. 复制应用凭证信息 -进入创建的应用详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentID`、 `ClientID` 和 `ClientSecret` 备用。 +进入创建的应用详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentId`、 `Client ID` 和 `Client Secret`。 ![2025-09-10-17-10-00](https://docs-cdn.flashcat.cloud/images/png/ac8765ffb106678e1c1a1217e8148567.png) -### 4. 复制事件订阅信息 +回到 Flashduty 集成配置页面，在表单中填入对应的 `AgentId`、 `Client ID` 和 `Client Secret`。 -前往 开发配置 → **事件与回调** 页面。设置推送方式为 `HTTP推送`，然后生成 `加密 aes_key` 和 `签名 Token` 备用。 +### 4. 复制事件订阅信息 -**（注意：生成 aes_key 和 Token 后请将信息临时保存到其它地方，离开页面后信息会消失，后续会用到）** +前往 开发配置 → **事件与回调** 页面。设置推送方式为 `HTTP推送`，然后点击按钮生成 `加密 aes_key` 和 `签名 Token`，并复制保存。 ![2025-09-10-17-11-19](https://docs-cdn.flashcat.cloud/images/png/9a6a52e5802cc75578335730481b2747.png) -## 二、添加钉钉集成 - ---- - -回到 Flashduty **集成中心** 页面，选择 即时消息 → 钉钉，在表单中填入 **集成名称** 以及先前步骤复制的 **应用信息** 后，点击保存创建。 - -drawing - -保存后会看到 **网页配置** 地址、**服务器出口 IP** 地址以及 **事件订阅请求网址** 等信息，后边流程会用到。 - -drawing - -## 三、配置钉钉应用 +回到 Flashduty 集成配置页面，在表单中填入对应的 `加密 aes_key` 和 `签名 Token`，点击 **保存** 按钮。 +## 二、配置钉钉应用 --- ### 1. 添加酷应用、网页应用和机器人 @@ -94,17 +85,19 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ### 3. 配置应用地址 -进入 **应用能力 → 网页应用** 页面 +1. 进入 应用能力 → **网页应用** 页面。 -1. 配置 **应用首页地址** 和 **PC 端首页地址**，内容为集成详情中的 **应用首页地址** 和 **PC 端首页地址**。 +2. 根据 Flashduty 集成详情中的 `应用首页地址` 和 `PC 端首页地址`，配置 **应用首页地址** 和 **PC 端首页地址**。 -2. 点击右上角 **保存**。 +3. 点击右上角 **保存**。 drawing ### 4. 配置事件订阅 -1. 开发配置 → **事件订阅** 页面，配置 **加密 aes_key**、**签名 token**、**请求网址**，内容分别为先前步骤中生成的 aes_key 和 token、集成详情中的 **事件订阅请求网址**。配置完成后 **保存**。 +1. 进入 开发配置 → **事件订阅** 页面。 + +2. 根据 Flashduty 集成详情中的 `事件订阅请求地址`，配置 **事件订阅请求网址**。配置完成后 **保存**。 ![2025-09-10-17-14-22](https://docs-cdn.flashcat.cloud/images/png/ad81265339dc1ce50f6a6cb2c4321ee0.png) @@ -121,7 +114,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ![2025-09-10-16-47-06](https://docs-cdn.flashcat.cloud/images/png/3d16611b7a2131192808988c64d13585.png) -## 四、配置作战室 +## 三、配置作战室 ### 1. 配置群模版 @@ -131,7 +124,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" > 本步骤中配置的 **群机器人** 和 **应用机器人** 是两个不同的概念。群机器人被用于在生成群聊时自动创建群机器人。群机器人和应用机器人拥有不同的 **机器人 ID**。若要为钉钉开启作战室功能，必须额外配置 **群机器人**。 -填写群机器人配置。**消息回调地址**、**消息回调token**、**信息来源网站 **三项配置在 Flashduty 的应用场景中并无实际作用，您可选择任意满足要求的值进行配置。 +填写群机器人配置。**消息回调地址**、**消息回调token**、**信息来源网站** 三项配置在 Flashduty 的应用场景中并无实际作用，您可选择任意满足要求的值进行配置。 **示例配置**： From 7346a7bab5789be534ce133eff6366c4f505a98c Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Thu, 11 Sep 2025 15:41:20 +0800 Subject: [PATCH 10/41] refactor: wecom self deploy app, pt3 --- ...06\346\210\220\346\214\207\345\274\225.md" | 37 ++++++++----------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index 05b316a0..614e08ae 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -57,36 +57,31 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" ![2025-09-09-17-07-51](https://docs-cdn.flashcat.cloud/images/png/18cc9e9e35da7a71da70ca656d5d9814.png) -3. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，暂存生成的 `Token` 和 `EncodingAESKey` 备用。 +3. 回到 Flashduty 集成配置页面，根据情况选择企业微信是否为 `非私有化部署版本`。 -![2025-09-09-17-12-13](https://docs-cdn.flashcat.cloud/images/png/b689fe99780788309b327ffb5faee50b.png) +若企业微信为私有化部署版本，需要在配置页面中填写 `Endpoint`。此地址需要能够被 Flashduty 服务所访问，您可以考虑实现 **白名单授权**。 -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业，获取 `企业ID`。回到 Flashduty 集成配置页面，填写该配置项。 -![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) +5. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用，获取 `AgentId`。回到 Flashduty 集成配置页面，填写该配置项。 -5. 若您的企业微信为非私有化部署版本，请在 Flashduty 中完成如下配置： +6. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用，获取 `Secret`。回到 Flashduty 集成配置页面，填写该配置项。 -- 企业ID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 → 企业ID。 -- AgentID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → AgentId。 -- App Secret：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → Secret。 -- 消息加密 Token：先前步骤暂存。 -- 消息加密 Aes Key：先前步骤暂存。 -- 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 +7. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 -6. 若您的企业微信为私有化部署版本，请在 Flashduty 中完成如下配置： +> 详见企业微信官方文档[企业内部开发配置域名指引](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754)。 + +![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) -- Endpoint：此地址需要能够被Flashduty服务所访问，您可以考虑做白名单授权。 -- 企业ID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 → 企业ID。 -- AgentID：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → AgentId。 -- App Secret：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → Secret。 -- 消息加密 Token：先前步骤暂存。 -- 消息加密 Aes Key：先前步骤暂存。 -- 可信域名：[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名 +回到 Flashduty 集成配置页面，填写该配置项，然后完成可信域名的验证。 + +8. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，复制保存生成的 `Token` 和 `EncodingAESKey`。 + +![2025-09-09-17-12-13](https://docs-cdn.flashcat.cloud/images/png/b689fe99780788309b327ffb5faee50b.png) -7. 在 Flashduty 中，点击 **保存** 完成集成配置。 +回到 Flashduty 集成配置页面，填写保存的 Token 和 EncodingAESKey，点击 **保存** 完成集成配置。 -8. 访问[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和**先前步骤暂存的** `Token`、`EncodingAESKey`。 +9. 复制 Flashduty 集成详情中的 `回调地址`，回到 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和 **先前步骤暂存的** `Token`、`EncodingAESKey`。 ![2025-09-09-17-13-14](https://docs-cdn.flashcat.cloud/images/png/c3534c0afd8c5b868c943162acd2b6a8.png) From eb24197ab43caa3758729c7502d139286f269a27 Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Thu, 11 Sep 2025 15:50:33 +0800 Subject: [PATCH 11/41] refactor: wecom self deploy app, pt4 --- ...com \351\233\206\346\210\220\346\214\207\345\274\225.md" | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index 614e08ae..de9726bd 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -67,9 +67,11 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" 6. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用，获取 `Secret`。回到 Flashduty 集成配置页面，填写该配置项。 -7. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 可作为应用OAuth2.0网页授权功能的回调域名。该域名需要指向到 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 +7. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 **可作为应用OAuth2.0网页授权功能的回调域名**。 -> 详见企业微信官方文档[企业内部开发配置域名指引](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754)。 +> 可信域名需要指向 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 +> +> 关于可信域名的要求，详见企业微信官方文档[企业内部开发配置域名指引](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754)。 ![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) From 32dffffb1c82771c9d428592da76f81eb117cb1d Mon Sep 17 00:00:00 2001 From: debidong <1953531014@qq.com> Date: Mon, 15 Sep 2025 20:12:06 +0800 Subject: [PATCH 12/41] refactor: polish instructions --- README.md | 16 +- ...06\346\210\220\346\214\207\345\274\225.md" | 80 +++++----- ...06\346\210\220\346\214\207\345\274\225.md" | 133 ++++++++--------- ...06\346\210\220\346\214\207\345\274\225.md" | 138 ++++++++++-------- ...06\346\210\220\346\214\207\345\274\225.md" | 73 ++++----- ...06\346\210\220\346\214\207\345\274\225.md" | 114 ++++++--------- instructions.md => i18n_instructions.md | 0 polish_instructions.md | 105 +++++++++++++ 8 files changed, 376 insertions(+), 283 deletions(-) rename instructions.md => i18n_instructions.md (100%) create mode 100644 polish_instructions.md diff --git a/README.md b/README.md index 29e64f0a..f1914b24 100644 --- a/README.md +++ b/README.md @@ -50,4 +50,18 @@ date: "2023-12-18T10:00:00+08:00" ``` 格式：https://docs.flashcat.cloud/[lang]/[product]/[md] 示例：https://docs.flashcat.cloud/zh/flashduty/getting-started -``` \ No newline at end of file +``` + +## Flashduty 内部文档 + +[使用手册](https://alidocs.dingtalk.com/i/nodes/14lgGw3P8vBzjpwpuoARLPA385daZ90D) + +- 润色文档 + +在 cursor 中，选择优秀的模型之后，使用下面的prompt对中文文档进行润色： + +``` +请你严格依照 @polish_instructions.md 的要求，对文档 @your_doc_name 进行润色。 +``` + +完成润色后，可在 VSCode / Cursor 中打开文档，然后在文档 tab 页中右击，点击 `格式化文档`。 diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" index 06dc5f12..ff273d49 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.1 \351\243\236\344\271\246 Lark \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -1,11 +1,10 @@ --- -title: 飞书集成 -description: 通过集成飞书自建应用，实现在飞书端内接收和响应告警的能力 +title: "飞书集成" +description: "通过集成飞书自建应用，您可以在飞书端内接收和响应告警。" date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" --- - -通过集成飞书自建应用，实现在飞书端内接收和响应告警的能力。 +通过集成飞书自建应用，您可以在飞书端内接收和响应告警。
@@ -19,9 +18,9 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" ### 1. 创建自建应用 -访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +访问 [飞书开发者后台](https://open.feishu.cn/app)，创建企业内自建应用。应用图标可使用 [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 -详见飞书开发文档[创建企业自建应用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac)。 +详见飞书开发文档 [创建企业自建应用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac)。 ![2025-09-11-11-58-10](https://docs-cdn.flashcat.cloud/images/png/4d86df2305e788e1464b170835dec13d.png) @@ -34,18 +33,18 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" ### 3. 复制事件回调的 Token 信息 -前往 开发配置 → 事件与回调 → **加密策略** 页面，生成并复制 `Encrypt Key`（推荐启用，更安全） 和 `Verification Token ` 备用。 +前往 开发配置 → 事件与回调 → **加密策略** 页面，生成并复制 `Encrypt Key`（推荐启用，更安全）和 `Verification Token` 备用。 ![2025-09-11-12-02-33](https://docs-cdn.flashcat.cloud/images/png/10870591ec4c450c6014119a6f2b6b84.png) ## 二、添加飞书集成 --- -回到 Flashduty **集成中心** 页面，选择 **即时消息** → **飞书**，在表单中填入 `名称` 以及上一步复制的 `App ID`、`App Secret`、`Verification Token` 和 `Encrypt Key` 后，点击保存创建。 +回到 Flashduty **集成中心** 页面，选择 即时消息 → **飞书**，在表单中填入 `名称` 以及上一步复制的 `App ID`、`App Secret`、`Verification Token` 和 `Encrypt Key` 后，点击 **保存** 完成创建。 drawing -创建后在列表中会看到刚才添加的飞书集成，点击名称进入详情后，会看到 **网页配置** 地址、**重定向 URL** 地址以及 **消息卡片请求网址** 等信息，后边流程会用到。 +创建成功后，您将在列表中看到已添加的飞书集成。点击其名称进入详情页面，即可查看 **网页配置** 地址、**重定向 URL** 和 **消息卡片请求网址**，这些信息将在后续步骤中使用。 ![2025-09-11-14-23-52](https://docs-cdn.flashcat.cloud/images/png/bf2ae6f78c0637e8dfc7d46394e64fa5.png) @@ -54,17 +53,17 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" ### 1. 开通并配置应用能力 -1. 回到飞书开发者后台，进入刚才创建的飞书应用，进入 **添加应用能力** → **按能力添加** 页面，同时开通 **网页应用** 和 **机器人** 能力。 +1. 回到飞书开发者后台，进入刚才创建的飞书应用，进入 添加应用能力 → **按能力添加** 页面，同时开通 **网页应用** 和 **机器人** 能力。 ![2025-09-11-12-05-32](https://docs-cdn.flashcat.cloud/images/png/7f7a6417533dda0617e55a7729c3d18a.png) 2. 前往 **网页应用** 页面，配置 `桌面端主页` 和 `移动端主页`，内容均为集成详情中的 **网页配置** 地址。 -详见飞书开发文档[配置应用主页地址](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844)。 +详见飞书开发文档 [配置应用主页地址](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844)。 drawing -3. 前往 **事件回调** → **回调配置** 页面，配置 `订阅方式`（内容为集成详情中的 **消息卡片请求网址**）。然后，订阅下面两项回调： +3. 前往 事件回调 → **回调配置** 页面，配置 `订阅方式`（内容为集成详情中的 **消息卡片请求网址**）。然后，订阅以下两项回调事件： - `card.action.trigger` - `card.action.trigger_v1` @@ -75,13 +74,13 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" 进入 **安全设置** 页面，配置 `重定向URL`，内容为集成详情中的 **重定向 URL**。 -详见飞书开发文档[配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)。 +详见飞书开发文档 [配置重定向 URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533)。 ![2025-09-11-11-29-49](https://docs-cdn.flashcat.cloud/images/png/263849573db72f0ca6253b5d8572da94.png) ### 3. 申请应用权限 -进入 **权限管理** 页面，为先前步骤创建的群应用申请下面的权限： +进入 **权限管理** 页面，为先前步骤创建的群应用申请以下权限： - `im:chat`：获取与更新群组信息 - `im:message`：获取与发送单聊、群组消息 @@ -92,56 +91,51 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide" ## 四、应用发布与使用 --- -完成上述步骤后，进行应用的发布与使用，管理员审核后即可使用。 +完成上述所有配置后，请发布应用。待管理员审核通过后即可使用。 -详见飞书开发文档[应用发布与使用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4)。 +详见飞书开发文档 [应用发布与使用](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4)。 > 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 ![2025-09-11-12-07-30](https://docs-cdn.flashcat.cloud/images/png/f8262ed8cf28064c20e27d1a0c2afad6.png) -应用发布后，可以使用 手机端 / PC 端 访问应用。首次访问需要登录并关联（飞书 ↔ Flashduty）账号，后续可以免登录使用。 +应用发布后，即可通过 **手机端** 或 **PC 端** 访问应用。首次访问需要登录并关联飞书与 Flashduty 账号，后续可以免登录使用。 -1. 手机端：手机端通过 飞书 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 -2. PC 端：桌面端通过 飞书 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 +- **手机端**：通过 飞书 → 工作台 → 搜索应用名称 → **打开应用** 使用网页应用。 +- **PC 端**：通过 飞书 → 工作台 → 搜索应用名称 → **打开应用** 使用网页应用。 ## 五、常见问题 --- 1. **消息无法投递到个人，操作记录提示 `未关联应用`？** - - - 前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号，系统才能拿到用户身份进行消息推送 - -2. **消息卡片按钮点击无效或报错**？ - - - 确保账户已经完成关联，前往 飞书 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（飞书 ↔ Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 - - 确保已购买足够的 license，已使用 license 情况，可以在控制台 → 费用中心查看 - -3. **分派策略飞书群聊列表为空**？ - - - 前往飞书，选择群聊会话，添加已创建的 Flashduty 机器人，如下图所示： - - 回到分派策略配置页面，刷新后重新选择群聊列表 + - 前往 飞书 → 工作台 → 搜索应用名称 → **打开应用**，完成一次登录以关联飞书与 Flashduty 账号，系统才能获取用户身份进行消息推送。 +2. **消息卡片按钮点击无效或报错？** + - 确保账户已经完成关联。您可以前往 飞书 → 工作台 → 搜索应用名称 → **打开应用**，完成一次登录。如果已经登录过，请尝试点击右上角菜单，切换账户后重新登录以绑定账号。 + - 确保已购买足够的 License。已使用 License 情况，可以在 控制台 → **费用中心** 查看。 +3. **分派策略飞书群聊列表为空？** + - 前往飞书，在指定群聊会话中添加已创建的 Flashduty 机器人。 + - 回到分派策略配置页面，刷新后重新选择群聊列表。 drawing drawing -4. **飞书自建应用 API 限制？** +4. **飞书自建应用 API 限制？** **调用量限制：** -| 飞书版本 | 调用总量/月 | 刷新时间 | -| :----------: | :--: | :----: | -|基础免费版|10,000 次|每月1日| -|其他版本|不限制|-| +| **飞书版本** | **调用总量/月** | **刷新时间** | +| :---: | :---: | :---: | +| 基础免费版 | 10,000 次 | 每月 1 日 | +| 其他版本 | 不限制 | - | **频控限制：** -| 场景 | 限制 | -| :----------: | :--: | -|所有接口|每个应用最高频率 50 次/秒| -|发消息接口|每个应用最高频率 1000 次/分钟| -|群机器人 Webhook|最高频率 100 次/分钟| -|给同一个用户或同一个群发消息|最高频率 5 次/秒| +| **场景** | **限制** | +| :---: | :--- | +| 所有接口 | 每个应用最高频率 50 次/秒 | +| 发消息接口 | 每个应用最高频率 1000 次/分钟 | +| 群机器人 Webhook | 最高频率 100 次/分钟 | +| 给同一个用户或同一个群发消息 | 最高频率 5 次/秒 | -> 超出 API 调用量限制后，钉钉应用将无法正常推送消息，建议合理使用通知渠道。[飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit) \ No newline at end of file +> 超出 API 调用量限制后，飞书应用将无法正常推送消息，建议合理使用通知渠道。详见 [飞书官方文档](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)。 \ No newline at end of file diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" index 15fe06d7..4937d857 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.2 \351\222\211\351\222\211 Dingtalk \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -4,9 +4,10 @@ description: "通过集成钉钉自建应用，实现在钉钉端内接收和响 date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" --- -通过集成钉钉自建应用，实现在钉钉端内接收和响应告警的能力。 -**（本文档以钉钉开放平台新版为例）** +通过集成钉钉自建应用，您可以在钉钉端内接收和响应告警。 + +> 本文档以钉钉开放平台新版为例。
@@ -18,18 +19,19 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
-## 一、创建钉钉应用 & 添加钉钉集成 +## 一、创建钉钉应用与添加钉钉集成 + --- ### 1. 创建自建应用 -访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) → 应用开发 → **企业内部开发** 创建应用。 +访问 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app) → 应用开发 → **企业内部开发**，创建应用。 -详见钉钉开发文档[创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty) +详见钉钉开发文档 [创建企业内部应用-H5 微应用](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty)。 ![2025-09-10-17-05-48](https://docs-cdn.flashcat.cloud/images/png/aa658afccbf0e92e25071143c792955f.png) -应用图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +应用图标可使用 [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 ### 2. 复制企业 `CorpId` @@ -41,7 +43,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ### 3. 复制应用凭证信息 -进入创建的应用详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentId`、 `Client ID` 和 `Client Secret`。 +进入创建的应用详情界面，通过左侧菜单栏前往 应用能力 → **凭证与基础信息** 页面，复制 `AgentId`、`Client ID` 和 `Client Secret`。 ![2025-09-10-17-10-00](https://docs-cdn.flashcat.cloud/images/png/ac8765ffb106678e1c1a1217e8148567.png) @@ -56,30 +58,31 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" 回到 Flashduty 集成配置页面，在表单中填入对应的 `加密 aes_key` 和 `签名 Token`，点击 **保存** 按钮。 ## 二、配置钉钉应用 + --- -### 1. 添加酷应用、网页应用和机器人 +### 1. 添加应用能力 drawing -1. 创建酷应用。进入 酷应用 → **酷应用列表** 页面，点击 **创建酷应用** 按钮，选择 **扩展到群会话** +1. 创建酷应用。进入 酷应用 → **酷应用列表** 页面，点击 **创建酷应用** 按钮，选择 **扩展到群会话**。 drawing -2. 进入到 **编辑酷应用** 页面，完成以下步骤： - 1. 填写基本信息，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 +2. 进入 **编辑酷应用** 页面，完成以下步骤： + 1. 填写基本信息。图标可使用 [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 drawing - 2. 配置功能设计，左侧选中 **群快捷入口** 和 **消息卡片**。群快捷入口图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，桌面和移动端访问地址请复制集成详情里的 **酷应用网页地址**。 +2. 配置功能设计。在左侧选中 **群快捷入口** 和 **消息卡片**。群快捷入口图标可使用 [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，桌面和移动端访问地址请复制集成详情里的 **酷应用网页地址**。 drawing -3. 跳过第三步功能开发，来到第四步 **预览发布**，点击 **发布** 按钮并确认。 +3. 跳过第三步功能开发，进入第四步 **预览发布**，点击 **发布** 按钮并确认。 ### 2. 配置机器人与消息推送 -进入 应用能力 → **机器人** 页面，打开机器人配置，填写名称并上传图标，图标可使用[Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)，保存即可。 +进入 应用能力 → **机器人** 页面，打开机器人配置，填写名称并上传图标，然后点击 **保存**。图标可使用 [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png)。 drawing @@ -87,9 +90,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" 1. 进入 应用能力 → **网页应用** 页面。 -2. 根据 Flashduty 集成详情中的 `应用首页地址` 和 `PC 端首页地址`，配置 **应用首页地址** 和 **PC 端首页地址**。 - -3. 点击右上角 **保存**。 +2. 根据 Flashduty 集成详情中的 `应用首页地址` 和 `PC 端首页地址`，配置 **应用首页地址** 和 **PC 端首页地址**。完成后点击 **保存**。 drawing @@ -101,22 +102,22 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ![2025-09-10-17-14-22](https://docs-cdn.flashcat.cloud/images/png/ad81265339dc1ce50f6a6cb2c4321ee0.png) -2. **保存** 按钮下方，选中 `群会话更换群名称`、`群内安装酷应用` 和 `群内卸载酷应用` 三种群会话事件，配置完成后 **保存**。 +2. 在 **保存** 按钮下方，选中 `群会话更换群名称`、`群内安装酷应用` 和 `群内卸载酷应用` 三种群会话事件，配置完成后点击 **保存**。 drawing ### 5. 申请应用权限 -进入 开发配置 → 权限管理 页面，为先前步骤创建的群应用申请下面的权限： +进入 开发配置 → **权限管理** 页面，为先前步骤创建的群应用申请以下权限： -- `qyapi_chat_manage` ：获取群聊信息 +- `qyapi_chat_manage`：获取群聊信息 - `qyapi_robot_sendmsg`：向群聊或个人发送消息 ![2025-09-10-16-47-06](https://docs-cdn.flashcat.cloud/images/png/3d16611b7a2131192808988c64d13585.png) ## 三、配置作战室 -### 1. 配置群模版 +### 1. 配置群模板 通过钉钉开放平台顶部菜单栏，前往 开放能力 → **场景群**。 @@ -124,41 +125,41 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" > 本步骤中配置的 **群机器人** 和 **应用机器人** 是两个不同的概念。群机器人被用于在生成群聊时自动创建群机器人。群机器人和应用机器人拥有不同的 **机器人 ID**。若要为钉钉开启作战室功能，必须额外配置 **群机器人**。 -填写群机器人配置。**消息回调地址**、**消息回调token**、**信息来源网站** 三项配置在 Flashduty 的应用场景中并无实际作用，您可选择任意满足要求的值进行配置。 +填写群机器人配置。**消息回调地址**、**消息回调 token**、**信息来源网站** 三项配置在 Flashduty 的应用场景中并无实际作用，您可选择任意满足要求的值进行配置。 **示例配置**： -| 配置项 | 值 | -| ------------- | ------------------------------------------------------------ | -| 机器人名称 | Flashduty | -| 机器人头像 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | -| 简介 | Flashduty | -| 消息预览图 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | -| 详细描述 | Flashduty 消息推送机器人。 | -| 消息回调地址 | https://flashcat.cloud/ | -| 消息回调token | token | -| 信息来源网站 | https://flashcat.cloud/ | +| **配置项** | **值** | +| -------------- | --------------------------------------------------------------------------------- | +| 机器人名称 | Flashduty | +| 机器人头像 | [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 简介 | Flashduty | +| 消息预览图 | [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 详细描述 | Flashduty 消息推送机器人。 | +| 消息回调地址 | `https://flashcat.cloud/` | +| 消息回调 token | `token` | +| 信息来源网站 | `https://flashcat.cloud/` | -完成配置后，点击 **创建**，然后点击 **审批**。右上角弹出 “提交成功” 后，钉钉已自动完成群机器人的审批。 +完成配置后，点击 **创建**，然后点击 **审批**。右上角弹出 “提交成功” 后，钉钉已自动完成群机器ンの审批。 ![2025-09-10-15-36-24](https://docs-cdn.flashcat.cloud/images/png/ada57d1f58c50250ee2136a08bf3093c.png) -2. 配置 **群模版**。在左侧菜单栏中选择 **群模版**，点击 **创建群模版**。 +2. 配置 **群模板**。在左侧菜单栏中选择 **群模板**，点击 **创建群模板**。 -将 **企业类型** 设置为 `企业内部`，将 **可选应用** 设置为先前步骤创建的自建应用。然后，在下一步骤中填写模版信息。 +将 **企业类型** 设置为 `企业内部`，将 **可选应用** 设置为先前步骤创建的自建应用。然后，在下一步骤中填写模板信息。 -**模版名称**、**图标**、**描述**、**文案介绍**、**模版描述**、**图片介绍** 等介绍性信息不会影响群模版功能的使用，您可选择任意满足要求的值进行配置。 +**模板名称**、**图标**、**描述**、**文案介绍**、**模板描述**、**图片介绍** 等介绍性信息不会影响群模板功能的使用，您可选择任意满足要求的值进行配置。 **示例配置**： -| 配置项 | 值 | -| -------- | ------------------------------------------------------------ | -| 模版名称 | Flashduty 作战室 | -| 图标 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | -| 描述 | 为活跃故障一键创建作战室。 | -| 文案介绍 | 为活跃故障一键创建作战室。 | -| 模版描述 | 为活跃故障一键创建作战室。 | -| 图片介绍 | [Flashduty官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| **配置项** | **值** | +| ---------- | --------------------------------------------------------------------------------- | +| 模板名称 | Flashduty 作战室 | +| 图标 | [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | +| 描述 | 为活跃故障一键创建作战室。 | +| 文案介绍 | 为活跃故障一键创建作战室。 | +| 模板描述 | 为活跃故障一键创建作战室。 | +| 图片介绍 | [Flashduty 官方 icon](https://download.flashcat.cloud/flashcat_logo_circular.png) | 在 **选择机器人** 配置项中，点击 **选择已创建的机器人**，选择上一步骤中创建的群机器人。其他配置项保持默认。最后点击 **保存编辑**。 @@ -167,15 +168,15 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" 在 **填写灰度群** 步骤中，点击 **创建灰度群**，然后点击 **发布灰度**。 -最后，再次点击左侧菜单栏的 **群模版**，然后点击进入刚才创建的群模版。点击 **提交审核**，待钉钉自动通过审核后，最后点击 **发布**。 +最后，再次点击左侧菜单栏的 **群模板**，然后点击进入刚才创建的群模板。点击 **提交审核**，待钉钉自动通过审核后，最后点击 **发布**。 -3. 在已经发布的群模版详细信息页，复制 **模版 ID** 和 **机器人 ID** 备用。 +3. 在已经发布的群模板详细信息页，复制 **模板 ID** 和 **机器人 ID** 备用。 ![2025-09-10-15-45-42](https://docs-cdn.flashcat.cloud/images/png/3a7750ec7d7cfa05abfe4b8f3f8443fa.png) -### 5. 申请应用权限 +### 2. 申请作战室权限 -进入 权限管理 页面，为先前步骤创建的群应用申请下面的权限： +进入 开发配置 → **权限管理** 页面，为先前步骤创建的群应用申请以下权限： - `qyapi_chat_read`：获取群聊信息 - `qyapi_chat_base_read`：获取群聊信息 @@ -184,32 +185,34 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" ![2025-09-10-16-46-05](https://docs-cdn.flashcat.cloud/images/png/f85793aff8f1d97fe0c6e0259b14e2d7.png) ## 四、应用发布与使用 + --- -完成上述步骤后，进行 应用发布 → **版本管理与发布**，进行创建新版本，然后进行发布。 +完成上述步骤后，前往 应用发布 → **版本管理与发布**，创建新版本并发布。 -> 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 +> 为了确保所有人可以使用应用，需将应用 **可见范围** 调整为全部员工，再进行应用发布。 drawing drawing -应用发布后，就可以使用 **手机端 / PC 端** 访问应用。首次访问需要登录并关联（钉钉 ↔ Flashduty）账号，后续可以免登录使用。 +应用发布后，即可通过 **手机端** 或 **PC 端** 访问应用。首次访问需要登录并关联钉钉与 Flashduty 账号，后续可以免登录使用。 -1. 手机端：手机端通过 钉钉 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 -2. PC 端：桌面（PC）端通过 钉钉 → 工作台 → 搜索应用名称 → 打开应用 使用网页应用。 +- **手机端**：通过 钉钉 → 工作台 → 搜索应用名称 → **打开应用** 使用网页应用。 +- **PC 端**：通过 钉钉 → 工作台 → 搜索应用名称 → **打开应用** 使用网页应用。 ## 五、常见问题 + --- 1. **消息无法投递到个人，操作记录提示 `未关联应用`？** - - 前往 钉钉 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（钉钉 ↔ Flashduty）账号，系统才能拿到用户身份进行消息推送 + - 前往 钉钉 → 工作台 → 搜索应用名称 → **打开应用**，完成一次登录以关联钉钉与 Flashduty 账号，系统才能获取用户身份并推送消息。 2. **消息卡片按钮点击无效或报错？** - - 前往 钉钉 → 工作台 → 搜索应用名称 → 打开应用，完成一次登录并关联（钉钉 ↔ Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号 - - 确保已购买足够的 license，已使用 license 情况，可以在控制台 → 费用中心查看 + - 前往 钉钉 → 工作台 → 搜索应用名称 → **打开应用**，完成一次登录以关联钉钉与 Flashduty 账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号。 + - 确保您已购买足够的 License。已使用 License 情况，可以在 控制台 → **费用中心** 查看。 3. **分派策略钉钉群聊列表为空？** - - 前往 钉钉，选择群聊会话安装酷应用，否则无法拿到群聊列表 - - 回到分派策略配置页面，刷新后重新选择群聊列表 - - 如果仍然拿不到群聊列表，请尝试群内卸载酷应用后，重试以上步骤。如果还不可以，请联系客户或专属技术支持 + - 前往钉钉，选择群聊会话安装酷应用，否则无法获取群聊列表。 + - 回到分派策略配置页面，刷新后重新选择群聊列表。 + - 如果仍然无法获取群聊列表，请尝试在群内卸载酷应用后，重试以上步骤。如果问题依旧，请联系客户或专属技术支持。 drawing drawing @@ -218,10 +221,10 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide" 4. **钉钉自建应用 API 调用量？** -| 钉钉版本 | 调用总量/月 | QPS | 刷新时间 | -| :--------: | :-----------: | :---: | :--------: | -| 标准版 | 10,000 次 | 20 | 每月1日 | -| 专业版 | 50万次 | 40 | 每月1日 | -| 专属版 | 550万次 | 60 | 每月1日 | +| **钉钉版本** | **调用总量/月** | **QPS** | **刷新时间** | +| :----------: | :-------------: | :-----: | :----------: | +| 标准版 | 10,000 次 | 20 | 每月 1 日 | +| 专业版 | 50 万次 | 40 | 每月 1 日 | +| 专属版 | 550 万次 | 60 | 每月 1 日 | -> 超出 API 调用量限制后，钉钉应用将无法正常推送消息，建议合理使用通知渠道。[钉钉文档说明](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI) +> 超出 API 调用量限制后，钉钉应用将无法正常推送消息。建议合理使用通知渠道。详见 [钉钉官方文档](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI)。 diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" index de9726bd..0c0ce32d 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.3 \344\274\201\344\270\232\345\276\256\344\277\241 Wecom \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -1,137 +1,147 @@ --- -title: "企业微信集成" -description: "通过集成企业微信第三方应用，实现在企业微信端内接收和响应告警的能力" +title: "企业微信 WeCom 集成" +description: "通过集成企业微信第三方应用，实现在企业微信端接收和响应告警的能力" date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide" --- -通过集成企业微信应用，实现在企业微信端内接收和响应告警的能力。 +通过集成企业微信应用，您可以在企业微信端内接收和响应告警。 -支持 [集成第三方应用](#third-party) 或 [集成企业自建应用](#self)。 +本文档支持 [集成第三方应用](#third-party) 或 [集成企业自建应用](#self) 两种方式。
## 视频介绍 + --- + +
-> **集成第三方应用** 和 **集成自建应用** 只需按需配置其中之一。 +> **集成第三方应用** 和 **集成自建应用** 两种方式只需按需配置其中一种。 -## 一、企业微信应用授权：集成第三方应用 + +## 一、集成第三方应用 + --- -> Flashduty 作为企业微信服务商，为您提供 FlashDuty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录+消息发送）。 +> Flashduty 作为企业微信服务商，为您提供 Flashduty 应用的长期免费版本。该应用需要获得企业微信接口调用许可才能使用（免密登录 + 消息发送）。 > -> 该许可目前支持 **最多60天** 免费，超出该使用时长后我们必须为您购买企微许可，方可继续使用。 +> 该许可目前支持 **最多 60 天** 免费，超出该使用时长后，Flashduty 需要为您购买企业微信许可，您方可继续使用。 -1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 应用，选择 **添加第三方应用**。 +1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → **应用** 页面，点击 **添加第三方应用**。 -![2025-09-11-14-38-18](https://docs-cdn.flashcat.cloud/images/png/c02371e3e2e63ed54687127e9d1e5130.png) + ![2025-09-11-14-38-18](https://docs-cdn.flashcat.cloud/images/png/c02371e3e2e63ed54687127e9d1e5130.png) -2. 搜索栏输入 **FlashDuty**，检索到应用，并点击 **添加** 按钮。 +2. 在搜索栏输入 `Flashduty`，检索到应用后，点击 **添加** 按钮。 -![2025-09-11-14-39-06](https://docs-cdn.flashcat.cloud/images/png/6e476fa462d64e4b2fca9350aec3163f.png) + ![2025-09-11-14-39-06](https://docs-cdn.flashcat.cloud/images/png/6e476fa462d64e4b2fca9350aec3163f.png) -3. 修改应用 **可见范围**，推荐选择全员或具体部门节点，防止新增企业成员时仍需修改应用可见范围。点击 **同意以上授权并添加**，完成安装。 +3. 修改应用 **可见范围**，推荐选择全员或具体部门节点，以避免新增企业成员时仍需修改。然后，点击 **同意以上授权并添加** 完成安装。 -![2025-09-11-14-41-43](https://docs-cdn.flashcat.cloud/images/png/4b4d8bfbf7d97e3bcbd4ace800ff4390.png) + ![2025-09-11-14-41-43](https://docs-cdn.flashcat.cloud/images/png/4b4d8bfbf7d97e3bcbd4ace800ff4390.png) -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业 页面，获取 **企业ID** 。 +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 **我的企业** 页面，获取 `企业 ID`。 -![2025-09-11-14-45-59](https://docs-cdn.flashcat.cloud/images/png/cc887d8f20433c0427c15ef4f377578c.png) + ![2025-09-11-14-45-59](https://docs-cdn.flashcat.cloud/images/png/cc887d8f20433c0427c15ef4f377578c.png) -5. 前往 Flashduty 集成配置页面，填写先前步骤获取的 **企业ID**，点击保存后，完成集成配置。 +5. 返回 Flashduty 集成配置页面，填写上一步获取的 `企业 ID`，点击 **保存** 完成集成。 -## 二、企业微信应用授权：集成自建应用 +## 二、集成企业自建应用 + --- -1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 第三方 → 创建应用 +1. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → **应用** 页面，点击 **创建应用**。 -![2025-09-09-17-06-46](https://docs-cdn.flashcat.cloud/images/png/06dc41d1f832619fce3e7c87fba03ced.png) + ![2025-09-09-17-06-46](https://docs-cdn.flashcat.cloud/images/png/06dc41d1f832619fce3e7c87fba03ced.png) -2. 配置 **应用logo**、**应用名称** 和 **应用可见范围**。 +2. 配置 **应用 Logo**、**应用名称** 和 **应用可见范围**。 -![2025-09-09-17-07-51](https://docs-cdn.flashcat.cloud/images/png/18cc9e9e35da7a71da70ca656d5d9814.png) + ![2025-09-09-17-07-51](https://docs-cdn.flashcat.cloud/images/png/18cc9e9e35da7a71da70ca656d5d9814.png) -3. 回到 Flashduty 集成配置页面，根据情况选择企业微信是否为 `非私有化部署版本`。 +3. 返回 Flashduty 集成配置页面，根据您的实际情况选择企业微信是否为 `非私有化部署版本`。 -若企业微信为私有化部署版本，需要在配置页面中填写 `Endpoint`。此地址需要能够被 Flashduty 服务所访问，您可以考虑实现 **白名单授权**。 + 若您的企业微信为私有化部署版本，则需要在配置页面中填写 `Endpoint`。此地址需要能够被 Flashduty 服务访问，您可以考虑为其设置 **白名单授权**。 -4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 我的企业，获取 `企业ID`。回到 Flashduty 集成配置页面，填写该配置项。 +4. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 **我的企业** 页面，获取 `企业 ID`，并将其填写至 Flashduty 集成配置页面。 -5. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用，获取 `AgentId`。回到 Flashduty 集成配置页面，填写该配置项。 +5. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → **您的应用** 页面，获取 `AgentId`，并将其填写至 Flashduty 集成配置页面。 -6. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用，获取 `Secret`。回到 Flashduty 集成配置页面，填写该配置项。 +6. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → **您的应用** 页面，获取 `Secret`，并将其填写至 Flashduty 集成配置页面。 -7. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 网页授权及JS-SDK → 设置可信域名，配置 **可作为应用OAuth2.0网页授权功能的回调域名**。 +7. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → 您的应用 → **网页授权及 JS-SDK** 页面，**设置可信域名**，配置 **可作为应用 OAuth 2.0 网页授权功能的回调域名**。 -> 可信域名需要指向 Flashduty 的后端地址 `{api_host}`（CNAME或代理转发）。 -> -> 关于可信域名的要求，详见企业微信官方文档[企业内部开发配置域名指引](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754)。 + > 可信域名需要指向 Flashduty 的后端地址 `{api_host}`（可通过 CNAME 或代理转发实现）。 + > + > 关于可信域名的要求，详见企业微信官方文档 [《企业内部开发配置域名指引》](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754)。 -![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) + ![2025-09-09-17-09-05](https://docs-cdn.flashcat.cloud/images/png/d8f2d78c310330d2b27cd0f744e5733c.png) -回到 Flashduty 集成配置页面，填写该配置项，然后完成可信域名的验证。 + 返回 Flashduty 集成配置页面，填写该域名，并完成验证。 -8. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，复制保存生成的 `Token` 和 `EncodingAESKey`。 +8. 访问 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → 您的应用 → **接收消息** 页面，**设置 API 接收**，分别对 `Token` 和 `EncodingAESKey` 点击 **随机获取**，并复制保存生成的 `Token` 和 `EncodingAESKey`。 -![2025-09-09-17-12-13](https://docs-cdn.flashcat.cloud/images/png/b689fe99780788309b327ffb5faee50b.png) + ![2025-09-09-17-12-13](https://docs-cdn.flashcat.cloud/images/png/b689fe99780788309b327ffb5faee50b.png) -回到 Flashduty 集成配置页面，填写保存的 Token 和 EncodingAESKey，点击 **保存** 完成集成配置。 + 返回 Flashduty 集成配置页面，填写已保存的 `Token` 和 `EncodingAESKey`，点击 **保存** 完成集成。 -9. 复制 Flashduty 集成详情中的 `回调地址`，回到 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps) → 应用管理 → 您的应用 → 接收消息 → 设置API接收，填写并保存 URL 和 **先前步骤暂存的** `Token`、`EncodingAESKey`。 +9. 复制 Flashduty 集成详情页中的 `回调地址`，返回 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#apps)，进入 应用管理 → 您的应用 → **接收消息** 页面，**设置 API 接收**，填入该 `回调地址` 以及上一步保存的 `Token` 和 `EncodingAESKey`，并点击 **保存**。 -![2025-09-09-17-13-14](https://docs-cdn.flashcat.cloud/images/png/c3534c0afd8c5b868c943162acd2b6a8.png) + ![2025-09-09-17-13-14](https://docs-cdn.flashcat.cloud/images/png/c3534c0afd8c5b868c943162acd2b6a8.png) ## 三、配置作战室 + --- -作战室功能仅支持**企业自建应用**开启。在 Flashduty 集成配置页面的 **增强功能** 中勾选开启作战室，即可启用功该功能，无需额外配置。 +> 作战室功能仅支持在 **企业自建应用** 模式下开启。 + +在 Flashduty 集成配置页面的 **增强功能** 模块，勾选 **开启作战室** 即可启用该功能，无需额外配置。 ## 四、常见问题 + --- -1. **点击集成保存按钮，报错 `authorize app first`？** +1. **点击集成保存按钮后，系统报错 `authorize app first`？** - - 请检查您是否完成应用的安装步骤，比如您是否可以在工作台看到 FlashDuty 这个应用 - - 请检查您是否正确配置了 `Corp ID` +- 请检查您是否已完成应用的安装步骤。例如，您是否可以在企业微信工作台中看到 Flashduty 应用。 +- 请检查您是否正确配置了 `Corp ID`。 -2. **如何完成账户关联？或消息发送提示 `未关联应用`？** +2. **如何完成账户关联或消息发送提示 `未关联应用`？** - - 登入企业微信客户端（桌面端和移动端均可），进入 **工作台**，找到并进入应用 FlashDuty - - 首次进入应用需要登录，选择成员账号 → 密码或单点登录，登入成功后，即完成 Flashduty 到 **企业微信** 账户关联 - - 后续进入应用将免密登录 +- 登录企业微信客户端（桌面端和移动端均可），进入 **工作台**，找到并打开 Flashduty 应用。 +- 首次进入应用需要登录。选择您的成员账号，通过密码或单点登录方式登入成功后，即可完成 Flashduty 账号与企业微信账号的关联。 +- 后续进入应用将自动免密登录。 -3. **如何进行故障通知？** +3. **如何发送故障通知？** - - 必须参照问题 1，先完成账户关联，才能发送通知 - - 进入某个协作空间详情页面 → 分派策略，在个人渠道部分，选择通知到企业微信集成，完成通知配置 - - 支持对企业微信通知内容进行自定义，您前往模板管理页面，设定自定义模板。**自定义区域展示行数最多 8 行**，超出文本将会被企业微信截断 +- 发送通知前，必须参照上一问题完成账户关联。 +- 进入指定协作空间，导航至 分派策略 → **个人渠道**，选择 `企业微信` 作为通知方式即可。 +- Flashduty 支持对企业微信通知内容进行自定义。您可以前往 **模板管理** 页面，设定自定义模板。**自定义区域最多可展示 8 行**，超出部分将被企业微信截断。 - drawing + drawing -4. **如何在微信内处理告警？** +4. **如何在企业微信内处理告警？** - - 点击卡片消息，直接进入告警详情页面 - - 点击 开始处理，直接将告警置为 `处理中` 状态 - - 点击 直接关闭，直接将告警置为 `已关闭` 状态 - - 点击 屏蔽2小时，直接将告警屏蔽 2 小时；如果想屏蔽更多时间，点击卡片右上角 `...` 查看更多屏蔽选项 +- 点击卡片消息，可直接进入告警详情页面。 +- 点击 **开始处理**，可直接将告警置为 `处理中` 状态。 +- 点击 **直接关闭**，可直接将告警置为 `已关闭` 状态。 +- 点击 **屏蔽 2 小时**，可直接将告警屏蔽 2 小时。如果想屏蔽更长时间，可点击卡片右上角的 `...` 查看更多屏蔽选项。 5. **为什么卡片消息提供了 `状态刷新` 按钮？** - - 企业微信限制一次卡片交互后 72 小时只可更新一次。每一次按钮操作，都是一次交互 - - 当告警的状态发生变化时，Flashduty 会请求卡片内容更新 - - 当告警状态频繁变化时，可能因为超过更新次数限制，导致卡片无法实时更新，这时可以点击刷新按钮，来获得一次更新卡片状态机会 +- 根据企业微信的限制，一次卡片交互后，72 小时内只可更新一次。每一次按钮操作，都视为一次交互。 +- 当告警状态发生变化时，Flashduty 会请求更新卡片内容。 +- 当告警状态频繁变化时，可能因超出更新次数限制导致卡片无法实时更新。此时，您可以点击 **刷新** 按钮，手动获取一次更新卡片状态的机会。 -6. **Mac 桌面端点击卡片消息如何使用 `系统默认浏览器` 打开？** +6. **在 Mac 桌面端，如何设置点击卡片消息时使用 `系统默认浏览器` 打开？** - - Mac 桌面端默认使用端内浏览器打开链接 - - 您可以尝试快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 调试 → 浏览器、webView相关 → 系统浏览器打开网页，来更改链接打开模式。使用同样的快捷键可以关闭调试模式，并保持设置 +- Mac 桌面端默认使用企业微信的内置浏览器打开链接。 +- 您可以尝试使用快捷键 `ctrl` + `command` + `shift` + `d` 开启调试模式，然后选择 **调试** → **浏览器、webView 相关** → **系统浏览器打开网页**，来更改链接的打开方式。使用相同的快捷键可以关闭调试模式，设置将会保留。 -7. **故障通知失败，提示 `未开通企微许可` ？** +7. **故障通知失败，并提示 `未开通企微许可`？** - - 联系 Flashduty 客服或专属支持，为您购买开通 +- 请联系 Flashduty 客服或您的专属技术支持，为您购买并开通许可。 diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.4 Slack \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.4 Slack \351\233\206\346\210\220\346\214\207\345\274\225.md" index 95231e6e..7f47c6ba 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.4 Slack \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.4 Slack \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -1,55 +1,46 @@ --- title: "Slack 集成" -description: "通过集成Slack第三方应用，实现在Slack内接收和响应告警的能力" +description: "通过集成 Slack 第三方应用，您可以在 Slack 内接收和响应告警。" date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/slack-integration-guide" --- -通过集成Slack第三方应用，实现在Slack内接收和响应告警的能力。 +通过集成 Slack 第三方应用，您可以在 Slack 内接收和响应告警。 ## 一、安装应用 ---- - -1. 访问 FlashDuty `集成中心` - `即时消息` - `Slack` - `添加` - -2. 页面跳转到Slack的界面，右上角选择 `工作区` ，然后点击 `允许` - -drawing -3. 输入数据源名称，点击 `保存` - - -## 二、常见问题 --- -1. **分派策略的群聊列表中没有想要的私有频道** - - 添加应用到频道，需要 步骤一 `安装应用` 未报错 - - 进入到 slack 相关的频道中， 执行 `/invite @FlashDuty` , 提示 `已加入` 或 `已由 xx 添加至 xxx`, 表明添加成功 +1. 访问 Flashduty 集成中心 → 即时消息 → **Slack**，点击 **添加**。 +2. 在跳转的 Slack 页面，于右上角选择 **工作区**，然后点击 **允许**。 + drawing +3. 输入数据源名称，点击 **保存**。 -2. **分派策略的群聊列表中没有想要的公共频道** - - 将应用授权人添加到公共频道中 - - 或者参考 `常见问题 1` 将应用添加到频道中 - -3. **点击 安装步骤2的 允许 按钮，报错** - - 重新操作，可能是服务器跟 Slack 通信有问题，导致授权出现问题，回到添加数据源页面重新操作 - - 重试后仍然报错，联系客服 - -4. **点击 安装步骤3的 保存 按钮，报错** - - 重新操作，可能是服务器跟 Slack 通信有问题，FlashDuty去获取永久授权码错误，回到添加数据源页面重新操作 - - 重试后仍然报错，联系客服 - -5. **Slack App 内 not_authed，报错** - - 重新操作，可能是 Slack 服务有问题 - - 重试后仍然报错，联系客服 - -6. **Slack App 内 Operation timed out，报错** - - 重新操作，可能是服务器跟 Slack 超时了，可能是服务器与 Slack 通信出现了问题 - - 重试后仍然报错，联系客服 +## 二、常见问题 -7. **Slack App 内 This app responded with Status Code 500，报错** - - 重新操作，可能是服务报错了，例如 数据源被关闭了 - - 重试后仍然报错，联系客服 +--- -8. **Slack App 内 Other questions，报错** - - 重新操作，遇到了还没被记录的问题 - - 重试后仍然报错，联系客服 \ No newline at end of file +1. **分派策略的群聊列表中没有想要的私有频道？** + - 确保 **安装应用** 步骤已成功完成且未报错。 + - 进入相关的 Slack 频道，执行 `/invite @Flashduty` 命令。当看到 `已加入` 或 `已由 xxx 添加至 xxx` 的提示时，即表示添加成功。 +2. **分派策略的群聊列表中没有想要的公共频道？** + - 将应用授权人添加到公共频道中。 + - 参考 **常见问题 1** 的方法，将应用添加到频道中。 +3. **点击安装步骤 2 的“允许”按钮后报错？** + - 请重新操作。这可能是由于服务器与 Slack 通信异常导致授权失败。请返回添加数据源页面重试。 + - 如果重试后仍然报错，请联系客服。 +4. **点击安装步骤 3 的“保存”按钮后报错？** + - 请重新操作。这可能是由于 Flashduty 服务器在获取永久授权码时与 Slack 通信异常。请返回添加数据源页面重试。 + - 如果重试后仍然报错，请联系客服。 +5. **Slack App 提示 `not_authed` 错误？** + - 请重新操作，这可能是 Slack 服务暂时出现问题。 + - 如果重试后仍然报错，请联系客服。 +6. **Slack App 提示 `Operation timed out` 错误？** + - 请重新操作。这可能是服务器与 Slack 通信超时。 + - 如果重试后仍然报错，请联系客服。 +7. **Slack App 提示 `This app responded with Status Code 500` 错误？** + - 请重新操作。这可能是 Flashduty 服务端出现错误（例如，数据源被关闭）。 + - 如果重试后仍然报错，请联系客服。 +8. **Slack App 提示其他未知错误？** + - 请重新操作。 + - 如果重试后仍然报错，请联系客服以记录和解决新问题。 diff --git "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.5 Microsoft Teams \351\233\206\346\210\220\346\214\207\345\274\225.md" "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.5 Microsoft Teams \351\233\206\346\210\220\346\214\207\345\274\225.md" index c7c49c9d..63320b68 100644 --- "a/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.5 Microsoft Teams \351\233\206\346\210\220\346\214\207\345\274\225.md" +++ "b/flashduty/zh/1. On-call/5. \351\233\206\346\210\220\345\274\225\345\257\274/8.3 \345\215\263\346\227\266\346\266\210\346\201\257/8.3.5 Microsoft Teams \351\233\206\346\210\220\346\214\207\345\274\225.md" @@ -1,131 +1,107 @@ --- -title: "Microsoft Teams集成" -description: "通过集成 Microsoft Teams 第三方应用，实现在 Microsoft Teams 内接收和响应告警的能力" +title: "Microsoft Teams 集成" +description: "通过集成 Microsoft Teams 第三方应用，您可以在 Microsoft Teams 内接收和响应告警。" date: "2025-05-19T10:00:00+08:00" url: "https://docs.flashcat.cloud/zh/flashduty/microsoft-teams-integration-guide" --- +通过集成 Microsoft Teams 第三方应用，您可以在 Microsoft Teams 内接收和响应告警。 -通过集成 Microsoft Teams 第三方应用，实现在 Microsoft Teams 内接收和响应告警的能力。 -## 一、安装/更新应用 +## 一、安装与更新应用 --- -Microsoft Teams 集成现处于 Beta 阶段，在关联前您需要先完成以下操作： +Microsoft Teams 集成现处于 Beta 阶段，在关联前您需要先完成以下操作。 ::: caution -此步骤需由 Microsoft Teams 管理员完成 +此步骤需由 Microsoft Teams 管理员完成。 ::: ### 1. 下载应用 -将 [FlashDutyBot-v1.0.3.zip](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/docs/FlashdutyBot-v1.0.3.zip) 下载到本地 +将 [FlashDutyBot-v1.0.3.zip](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/docs/FlashdutyBot-v1.0.3.zip) 下载到本地。 ### 2. 安装应用 -进入 **Microsoft Teams，跳转 [+Apps] - [Manage your apps] - [Upload an app] - [Upload an app to your org's app catalog]** 上传应用包 FlashDutyBot.zip - +进入 Microsoft Teams，导航至 +Apps → Manage your apps → Upload an app → **Upload an app to your org's app catalog**，然后上传应用包 `FlashDutyBot.zip`。 ![](https://fcpub-1301667576.cos.ap-nanjing.myqcloud.com/flashduty/integration/microsoft-teams/upload-app.png) #### 配置应用可见范围 -进入 [Microsoft Teams 管理中心](https://admin.teams.microsoft.com/policies/manage-apps)，找到 FlashDuty 应用，将应用可见范围调整为所有人（或者您自定义的范围） +进入 [Microsoft Teams 管理中心](https://admin.teams.microsoft.com/policies/manage-apps)，找到 Flashduty 应用，将应用可见范围调整为所有人或您指定的范围。 ::: tip -如遇到应用状态为 [已阻止]，请稍等片刻后刷新页面或手动修改 +如遇到应用状态为“已阻止”，请稍等片刻后刷新页面或手动修改。 ::: ![](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/install-bot-2.png) #### 查看是否添加成功 -等待几分钟，组织成员即可在 [+Apps] - [Built for your org] 找到此应用集成 +等待几分钟，组织成员即可在 +Apps → **Built for your org** 找到此应用。 ![](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/find-bot.png) ### 3. 更新应用 ::: caution -若您已安装应用版本低于 1.0.3，请按照以下流程更新 +若您已安装的应用版本低于 1.0.3，请按照以下流程更新。 ::: -进入 [Microsoft Teams 管理中心](https://admin.teams.microsoft.com/policies/manage-apps)，找到并进入 FlashDuty 应用详情页 - +1. 进入 [Microsoft Teams 管理中心](https://admin.teams.microsoft.com/policies/manage-apps)，找到并进入 Flashduty 应用详情页。 ![update-bot-1](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/update-bot-1.png) -上传新版 FlashdutyBot.zip - +2. 上传新版 `FlashdutyBot.zip`。 ![update-bot-2](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/update-bot-2.png) -等待客户端内应用版本更新（可能需要几十分钟） - +3. 等待客户端内应用版本更新（可能需要几十分钟）。 ![update-bot-3](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/update-bot-3.png) -## 二、关联团队 - -### 1. 添加 FlashDuty 应用到目标 Team 中 - -#### 1.1 找到 FlashDuty 应用 -如无应用，请联系您的 Microsoft Teams 组织管理员 - +## 二、关联团队 (Team) +--- +### 1. 添加 Flashduty 应用 +1. 在应用市场中找到 Flashduty 应用。 +> 如无应用，请联系您的 Microsoft Teams 组织管理员。 ![link-bot](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-1.png) - -#### 1.2 添加到目标 Team +2. 将应用添加到目标 Team。 ::: caution -注意：此步必须选择目标 Team 的 General Channel，否则将无法发送故障到 Team 中 +此步骤必须选择目标 Team 的 General Channel，否则将无法发送故障到 Team 中。 ::: - ![link-bot-team-1](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-team-1.png) ### 2. 发送关联指令 -@FlashDuty 并发送 linkTeam {ID} 到添加的 Team 中，点击立即关联 +在 Team 中 @Flashduty 并发送指令 `linkTeam {ID}`，然后点击 **立即关联**。 ![link-bot-team-2](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-team-2.png) -## 三、关联团队 - -### 1. 添加 FlashDuty 应用到目标 Chat 中 - -#### 1.1 找到 FlashDuty 应用 -如无应用，请联系您的 Microsoft Teams 组织管理员 - +## 三、关联群聊 (Chat) +--- +### 1. 添加 Flashduty 应用 +1. 在应用市场中找到 Flashduty 应用。 +> 如无应用，请联系您的 Microsoft Teams 组织管理员。 ![link-bot](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-1.png) - -#### 1.2 添加到目标 Chat - +2. 将应用添加到目标 Chat。 ![link-bot-chat-1](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-chat-1.png) - ### 2. 发送关联指令 -@FlashDuty 并发送 linkChat {ID} {ChatName} 到添加的 Team 中，点击立即关联 +在 Chat 中 @Flashduty 并发送指令 `linkChat {ID} {ChatName}`，然后点击 **立即关联**。 ![link-bot-chat-2](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-chat-2.png) - - ## 四、关联用户 - -### 1. 添加 FlashDuty 应用 - -#### 1.1 找到 FlashDuty 应用 -如无应用，请联系您的 Microsoft Teams 组织管理员 - +--- +### 1. 添加 Flashduty 应用 +1. 在应用市场中找到 Flashduty 应用。 +> 如无应用，请联系您的 Microsoft Teams 组织管理员。 ![link-bot](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-1.png) - -#### 1.2 点击打开应用 +2. 点击 **打开应用**。 ![link-bot-user-1](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-user-1.png) ### 2. 发送关联指令 -复制指令：linkUser {} 发送到聊天中，再点击立即关联 +复制并发送指令 `linkUser {}` 到聊天中，然后点击 **立即关联**。 ![link-bot-user-2](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/imges/png/link-bot-user-2.png) -## 常见问题 -
-团队或个人收不到消息 -请前往集成中心=>即时消息=>Microsoft Teams中的团队和用户是否有关联成功 -
- -
-怎么查看已关联的团队和用户 -请前往集成中心=>即时消息=>Microsoft Teams中的关联Teams和关联用户中查看 -
- -
-怎么取消关联的团队和用户 -暂不支持 -
+## 五、常见问题 +--- + +1. **团队或个人收不到消息？** + - 请前往 集成中心 → 即时消息 → **Microsoft Teams**，检查团队和用户是否已成功关联。 +2. **如何查看已关联的团队和用户？** + - 请前往 集成中心 → 即时消息 → **Microsoft Teams**，在 **关联 Teams** 和 **关联用户** 中查看。 +3. **如何取消已关联的团队和用户？** + - 暂不支持此功能。 diff --git a/instructions.md b/i18n_instructions.md similarity index 100% rename from instructions.md rename to i18n_instructions.md diff --git a/polish_instructions.md b/polish_instructions.md new file mode 100644 index 00000000..17ddd130 --- /dev/null +++ b/polish_instructions.md @@ -0,0 +1,105 @@ +# 角色：SaaS 产品文档专家 + +您是一位顶级的 SaaS 产品技术文档工程师，专长是将原始功能说明转化为清晰、准确、用户友好的产品文档。您的核心任务是在不改变原文技术内核的前提下，对中文文档进行专业级润色。 + +# 核心任务：润色中文产品文档 + +严格遵循本指引，对指定的中文 `.md` 文档进行润色。 + +# 核心原则 + +1. **忠于原文**: **严禁改变原文的技术含义、操作步骤和核心信息。** 润色重点在于优化表达、格式和结构，而非内容创作或重新组织。 +2. **用户中心**: 以终端用户为中心，确保文档清晰易懂，能帮助他们快速解决问题。 +3. **专业严谨**: 保证技术术语的准确性和一致性，格式规范统一。 + +# 标准操作流程 (SOP) + +请严格按照以下步骤执行： + +1. **分析文档结构**: 根据本指引分析当前文档的整体结构（标题层级、章节顺序），识别需要优化的章节组织。判断是否符合“总-分-总”逻辑。**仅在结构严重混乱时才进行微调**，通常应保持原状。 +2. **优化内容结构与表达**: + - **优化段落结构**：调整段落内部的逻辑和信息层次，确保每个段落聚焦一个核心主题，使表达更清晰。 + - **优化语言表达**：逐句精炼语言，使其更专业、简洁、易读。遵循下文【语言风格】和【语法与表达规范】。 +3. **格式与术语标准化**: 严格按照【格式规范】和【术语使用】部分，对全文进行格式化，并统一所有技术术语。 +4. **质量自检**: 完成润色后，根据【质量检查清单】进行最后复核。 + +# 格式规范 + +文档应以 Markdown 格式呈现，严格遵循以下结构化格式。**除此外，不应出现其他格式。** + +| 格式类型 | 格式示例 | 核心用途与要求 | +| ----------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------- | +| YAML Front Matter | `---` 包围的区域 | 定义文档元数据，如 `title`、`description`。必须保留。 | +| 二级标题 | `## 章节标题` | 构建文档主要框架。`##`后必须有 1 个空格。 | +| 三级标题 | `### 步骤标题` | 细分章节内容，通常用于操作步骤。`###`后必须有 1 个空格。 | +| 分隔线 | `---` | 在不同逻辑章节之间提供视觉分隔，增强层次感。 | +| 有序列表 | `1. 列表项` | 展示需要按顺序执行的操作步骤。注 | +| 无序列表 | `- 列表项` | 列举功能特性、配置选项等无序信息。 | +| 缩进 | ` - 嵌套列表项` | 用于创建层级结构（如嵌套列表）。每个缩进层级使用 2 个半角空格。 | +| **粗体文本** | `**文本内容**` | 突出显示 UI 元素（如按钮名、菜单项）、关键概念或警告信息。**文本两侧必须有空格**，除非紧跟标点符号。 | +| `行内代码` | `` `代码内容` `` | 标识技术术语、参数名、配置项、状态值（如 `AgentId`、`Secret`）。 | +| > 引用块 | `> 文本内容` | 突出显示重要提示、前置条件或警告信息。 | +| 图片 | `![图片描述](图片地址)` | 直观展示操作界面和预期结果。**禁止修改图片地址。** | +| 链接 | `[链接文本](链接地址)` | 引用相关文档或外部资源。**禁止修改链接地址。** | +| 表格 | `| Head | Text |` | 用于结构化地展示数据，如参数对比、配置说明等。表格第一行（标题行）应该加粗 | +| 页面内引用 | `[文本内容](#anchor_id)` | 引用页面内内容。当出现页面短文本内容引用页面内段落时，可以考虑添加页面内引用。 | +| HTML `` | `` | 用于页面内锚点定位，必须保留。 | +| HTML `