shkong/OpenShamrock
1
0
Fork 0
mirror of https://github.com/whitechi73/OpenShamrock.git synced 2024-08-14 13:12:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: get_group_at_all_remain

Browse Source
This commit is contained in:
ikechan8370 2024-01-06 18:58:49 +08:00 committed by GitHub
parent d19ffdce76
commit f881c5797a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/api/group.md
View File

@ -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"
}
```
:::