merge f-warroom

Author: ysyneu

README.md

@@ -64,5 +64,9 @@ date: "2023-12-18T10:00:00+08:00"
 请你严格依照 @polish_instructions.md 的要求，对文档 @your_doc_name 进行润色。
 ```
 
+<<<<<<< HEAD
 完成润色后，可在 VSCode / Cursor 中打开文档，然后在文档 tab 页中右击，点击 `格式化文档`。
 
+=======
+完成润色后，可在 VSCode / Cursor 中打开文档，然后在文档 tab 页中右击，点击 `格式化文档`。
+>>>>>>> f-warroom

flashduty/en/1. On-call/8. Integrations/8.3 IM integration/8.3.1 Feishu(Lark) Integration Guide.md

@@ -1,136 +1,140 @@
 ---
-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: "Feishu/Lark Integration"
+description: "By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark."
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/lark-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
 ---
+By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark.
 
-Integrate with Feishu(Lark) custom application to receive and respond to alerts within Feishu/Lark.
-
-<!--
-## Video Tutorial
----
-<Video src="https://download.flashcat.cloud/flashduty/video/feishu.mp4"></Video>
--->
-
-## I. Create Feishu/Lark Application
+## 1. Create Feishu/Lark application
 ---
 
-### 1. Create Custom Application
+### 1. Create a custom application
 
-Visit [Feishu/Lark Developer Console](https://open.feishu.cn/app) to create an internal custom application. (For details, see Feishu/Lark development documentation - [Create Enterprise Custom Application](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac))
+Visit [Feishu/Lark Developer Console](https://open.feishu.cn/app) and create an internal custom application. You can use the [official Flashduty icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the application icon.
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-1.png" alt="drawing" width="400"/>
+For details, see the Feishu/Lark development documentation [Create an internal custom application](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac).
 
-You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) as the application icon.
+![2025-09-17-19-20-33](https://docs-cdn.flashcat.cloud/images/png/9af11beec76ef03b935e5ba71ac2f5f5.png)
+### 2. Copy credential information
 
-### 2. Copy Credentials
+Go to the **Credentials and Basic Information** page and copy the `App ID` and `App Secret` for later use.
 
-Go to the **Credentials & Basic Info** page, copy the `App ID` and `App Secret` for later use.
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-2.png" alt="drawing" width="800"/>
+![2025-09-17-19-24-11](https://docs-cdn.flashcat.cloud/images/png/9b72a772eaa94a7115e8568e9ae7b496.png)
 
-### 3. Copy Event Callback Token Information
+### 3. Copy the event callback Token information
 
-Go to **Development Configuration - Events & Callbacks - Encryption Configuration** page, copy the `Encrypt Key` (recommended for better security) and `Verification Token` for later use.
+Go to Development Configuration → Events & Callbacks → **Encryption Strategy** page, generate and copy the `Encrypt Key` (recommended for better security) and `Verification Token` for later use.
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-2.png" alt="drawing" width="800"/>
+![2025-09-17-19-27-24](https://docs-cdn.flashcat.cloud/images/png/48d8ef62cef639cb433078c878c3a4a0.png)
 
-## II. Add Feishu/Lark Integration
+## 2. Add Feishu/Lark integration
 ---
 
-Return to Flashduty **Integration Center** page, select **Instant Messaging => Feishu/Lark**, fill in the `Name` and the previously copied `App ID`, `App Secret`, `Verification Token`, and `Encrypt Key`, then click save to create.
+Return to the Flashduty **Integration Center** page, select IM → **Feishu/Lark**, fill in the `Name` and the `App ID`, `App Secret`, `Verification Token`, and `Encrypt Key` copied in the previous step, then click **Save** to complete the creation.
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-4.png" alt="drawing" width="800"/>
+After successful creation, you will see the added Feishu/Lark integration in the list. Click its name to enter the details page, where you can view the **Web Configuration** address, **Redirect URL**, and **Message Card Request URL**, which will be used in subsequent steps.
 
-After creation, you'll see the newly added Feishu/Lark integration in the list. Click on the name to enter details, where you'll find the **Web Configuration** URL, **Redirect URL**, and **Message Card Request URL** information, which will be used in later steps.
+![2025-09-17-19-32-56](https://docs-cdn.flashcat.cloud/images/png/b4bfa3d7fdf1af9b8006be168d454700.png)
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-5.png" alt="drawing" width="800"/>
-
-## III. Configure Feishu/Lark Application
+## 3. Configure Feishu/Lark application
 ---
 
-### 1. Enable and Configure Application Capabilities
-
-1). Return to the Feishu/Lark Developer Console, enter the newly created application, go to **Add Capabilities - Add by Capability** page, and enable both **Web Application** and **Bot** capabilities.
+### 1. Enable and configure application capabilities
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-6.png" alt="drawing" width="800"/>
+1. Return to the Feishu/Lark Developer Console, enter the created Feishu/Lark application, go to Add Application Capabilities → **Add by Capability** page, and enable both **Web Application** and **Bot** capabilities.
 
-2). Go to **Web Application** page, configure both `Desktop Homepage` and `Mobile Homepage` with the **Web Configuration** URL from the integration details.
+![2025-09-17-19-42-32](https://docs-cdn.flashcat.cloud/images/png/b12ddbeed2b8d7f508eccc1078c2c12c.png)
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-7.png" alt="drawing" width="800"/>
+2. Go to the **Web app** page and configure the `Desktop Homepage` and `Mobile Homepage`, both using the **Web configuration** address from the integration details.
 
-(See Feishu/Lark development documentation - [Configure Application Homepage URL](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844))
+For details, see the Feishu/Lark development documentation [Configure application homepage address](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844).
 
-3). Go to **Event Callbacks - Callback Configuration** page, configure the `Message Card Request URL` (using the **Message Card Request URL** from integration details) and add the callback.
+![2025-09-17-19-49-19](https://docs-cdn.flashcat.cloud/images/png/393e7629de652d1793b69af7d4f3831c.png)
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-8.png" alt="drawing" width="800"/>
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-9.png" alt="drawing" width="800"/>
+3. Go to Event Callbacks → **Callback Configuration** page, configure the `Subscription Method` (using the **Message Card Request URL** from the integration details). Then, subscribe to the following two callback events:
 
-### 2. Add Redirect URL to Feishu/Lark Application
+- `card.action.trigger`
+- `card.action.trigger_v1`
 
-Go to **Security Settings** page, configure the `Redirect URL` using the **Redirect URL** from integration details.
+![2025-09-17-19-53-14](https://docs-cdn.flashcat.cloud/images/png/c42542dc49930c2e20f5921749bf3565.png)
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-10.png" alt="drawing" width="800"/>
+### 2. Add redirect URL to Feishu/Lark application
 
-(See Feishu/Lark development documentation - [Configure Redirect URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533))
+Go to the **Security Settings** page and configure the `Redirect URL` using the **Redirect URL** from the integration details.
 
-### 3. Request Application Permissions
+For details, see the Feishu/Lark development documentation [Configure redirect URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533).
 
-Go to **Permission Management** page, request `im:chat` and `im:message` permissions. These permissions will allow the application to access its group chat information and send messages to groups or individuals.
+![2025-09-17-19-55-04](https://docs-cdn.flashcat.cloud/images/png/6f97810d9542514c40c276588179e04f.png)
 
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-11.png" alt="drawing" width="800"/>
+### 3. Apply for application permissions
 
-## IV. Application Publication and Usage
----
-
-After completing the above steps, proceed with application publication and usage. The application can be used after administrator approval.
-Note: **Available Range** needs special configuration, recommended for **All Employees**.
-
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-12.png" alt="drawing" width="800"/>
+Go to the **Permission Management** page and apply for the following permissions for the group application created in the previous steps:
 
-See Feishu/Lark development documentation - [Application Publication and Usage](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4).
+- `im:chat`: Get and update group information
+- `im:message`: Get and send single chat and group messages
+- `contact:user.id:readonly`: Get user ID by phone number or email (for configuring war rooms)<span id="war-room-scope"></span>
 
-Once published, you can access the application via mobile/PC client. First-time access requires login and account association (Feishu/Lark 《-》 Flashduty), subsequent uses will be login-free.
+![2025-09-17-19-59-38](https://docs-cdn.flashcat.cloud/images/png/61cb9fbc295e94b4d9acd7e44ac75e13.png)
 
-1. Mobile: Access the web application through Feishu/Lark > Workspace > Search application name > Open application.
-2. PC: Access the web application through Feishu/Lark > Workspace > Search application name > Open application.
-
-## V. Common Issues
+## 4. Application release
 ---
 
-1. **Unable to deliver messages to individuals**, operation record shows `Application Not Associated`?
+After completing all the above configurations, please release the application. It can be used after administrator approval.
 
-    - Go to Feishu/Lark > Workspace > Search application name > Open application, complete one login and account association (Feishu/Lark 《-》 Flashduty) for the system to obtain user identity for message pushing
+For details, see the Feishu/Lark development documentation [Application release and usage](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4).
 
-2. **Message card buttons not working or showing errors**?
+> To ensure that everyone can use the application, adjust the application **visibility** to all employees before releasing the application.
 
-    - Ensure account association is completed. Go to Feishu/Lark > Workspace > Search application name > Open application, complete one login and account association (Feishu/Lark 《-》 Flashduty). If already logged in, try clicking the top-right menu to switch accounts and re-login to bind the account
-    - Ensure sufficient licenses are purchased. You can check license usage in Console > Billing Center
+![2025-09-17-20-01-46](https://docs-cdn.flashcat.cloud/images/png/af3d458ed4c1a3e3346c91dc6a8fa667.png)
 
-3. **Empty Feishu/Lark group chat list in escalation rule**?
 
-    - Go to Feishu/Lark, select group chat conversation, add the created Flashduty bot as shown below:
-    - Return to the escalation rule configuration page, refresh and reselect the group chat list
+After the application is released, you can access it via **mobile** or **PC**. The first access requires login to link your Feishu/Lark and Flashduty accounts. Subsequent access will be login-free.
 
-<img alt="drawing" width="800" src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-13.png" />
-<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-14.png" alt="drawing" width="800"/> 
+- **Mobile**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
+- **PC**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
 
-4. **Feishu/Lark Custom Application API Limits:** [Feishu/Lark Documentation](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)
+![2025-09-17-20-05-01](https://docs-cdn.flashcat.cloud/images/png/1da64327149790ceb45ff3b66476be7f.png)
 
-    **Call Volume Limits:**
+## 5. Configure war room
 
-    |     Feishu/Lark Version     | Total Calls/Month | Reset Time  |                       
-    | :----------: | :--: | :----: |
-    |Basic Free Version|10,000 calls|1st of each month|
-    |Other Versions|Unlimited|-|        
+> Ensure the application has been authorized with the [additional permissions](#war-room-scope) required for the war room feature.
 
-    **Frequency Control Limits:**
+After completing the previous steps, in the **Enhanced Features** module of the Flashduty integration configuration page, check **Enable War Room** to enable this feature without additional configuration.
 
-    |    Scenario     | Limit |                   
-    | :----------: | :--: | 
-    |All APIs|Maximum 50 calls/second per application|
-    |Message Sending API|Maximum 1000 calls/minute per application|
-    |Group Bot Webhook|Maximum 100 calls/minute|
-    |Sending messages to the same user or group|Maximum 5 calls/second|
+## 6. FAQ
+---
 
-    **Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably
+1. **Messages cannot be delivered to individuals, and the operation log shows `app not linked`?**
+   - Go to Feishu/Lark → Workplace → Search for application name → **Open Application**, complete login once to link your Feishu/Lark and Flashduty accounts, so the system can obtain user identity for message push.
+2. **Message card buttons are unresponsive or show errors?**
+   - Ensure the account has been linked. You can go to Feishu/Lark → Workplace → Search for application name → **Open Application** to complete login once. If you have already logged in, try clicking the menu in the upper right corner, switch accounts, and log in again to bind the account.
+   - Ensure you have purchased sufficient licenses. You can check the license usage in Console → **Billing Center**.
+3. **The Feishu/Lark group chat list in escalation rules is empty?**
+   - Go to Feishu/Lark and add the created Flashduty bot to the specified group chat.
+   - Return to the escalation rule configuration page, refresh and reselect the group chat list.
+
+![2025-09-17-20-07-23](https://docs-cdn.flashcat.cloud/images/png/27a5422ec27b5f63fb6dee81b3d50510.png)
+
+4. **Feishu/Lark custom application API limits?**
+   - **Call volume limits:**
+
+     | **Feishu/Lark Version** | **Total Calls/Month** | **Refresh Time** |
+     | :---: | :---: | :---: |
+     | Basic Free | 10,000 | 1st of each month |
+     | Other Versions | Unlimited | - |
+
+   - **Rate limits:**
+
+     | **Scenario** | **Limit** |
+     | :---: | :--- |
+     | All APIs | Max 50 calls/second per app |
+     | Send message APIs | Max 1000 calls/minute per app |
+     | Group bot webhook | Max 100 calls/minute |
+     | Send to same user or group | Max 5 calls/second |
+   
+   > After exceeding API call limits, the Feishu/Lark application will not be able to push messages normally. It is recommended to use notification channels reasonably. See [Feishu/Lark official documentation](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit) for details.
+5. **Why is the war room feature not working as expected?**
+   - Please check again whether you have configured the [required permissions](#war-room-scope) for the war room feature.
+   - Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).