From f881c5797a2fd87ad60714391aa2fa26fe4df9d9 Mon Sep 17 00:00:00 2001
From: ikechan8370 <geyinchibuaa@gmail.com>
Date: Sat, 6 Jan 2024 18:58:49 +0800
Subject: [PATCH] docs: get_group_at_all_remain

---
 docs/api/group.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/docs/api/group.md b/docs/api/group.md
index ada2df9..154a6b8 100644
--- a/docs/api/group.md
+++ b/docs/api/group.md
@@ -373,3 +373,49 @@ data 的响应内容为 json 数组，每个元素内容如下：
 ```
 
 :::
+
+## 获取群 @全体成员 剩余次数
+
+当机器人是管理员时可用
+
+### API端点
+
+`/get_group_at_all_remain`
+
+### 参数
+
+| 字段     | 类型  | 必须 | 说明  |
+| -------- | ----- | ---- | ----- |
+| group_id | int64 | 是   | 群号  |
+
+### 响应
+
+::: tabs
+
+@tab 响应字段
+
+| 字段     | 类型   | 说明  |
+| -------- | ------ | ----- |
+| can_at_all  | bool  | 是否可以 @全体成员 |
+| remain_at_all_count_for_group | int32 | 群内所有管理当天剩余 @全体成员 次数  |
+| remain_at_all_count_for_uin | int32 | Bot 当天剩余 @全体成员 次数  |
+
+@tab 响应示例
+
+```json
+{
+  "status": "ok",
+  "retcode": 0,
+  "data": [
+    {
+      "can_at_all": true,
+      "remain_at_all_count_for_group": 20,
+      "remain_at_all_count_for_group": 10
+    }
+  ],
+  "echo": "xxxx"
+}
+```
+
+:::
+