From 30d6e5a9cd55a00a570cd6fc48d78dd478da7007 Mon Sep 17 00:00:00 2001 From: yyyytawa <116234899+yyyytawa@users.noreply.github.com> Date: Fri, 26 Jun 2026 19:48:09 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=A0=BC=E5=BC=8F=E5=8C=96+=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E5=93=8D=E5=BA=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/api/v1/group-tag.md | 2 +- src/api/v1/group.md | 208 +++++++++++++++++----------------------- src/full.proto | 75 ++++++++++----- 3 files changed, 142 insertions(+), 143 deletions(-) diff --git a/src/api/v1/group-tag.md b/src/api/v1/group-tag.md index 1124ecbb..08a6da62 100644 --- a/src/api/v1/group-tag.md +++ b/src/api/v1/group-tag.md @@ -215,5 +215,5 @@ POST /v1/group-tag/members 响应体: ```protobuf - + ``` \ No newline at end of file diff --git a/src/api/v1/group.md b/src/api/v1/group.md index bb95a336..89738a9c 100644 --- a/src/api/v1/group.md +++ b/src/api/v1/group.md @@ -47,85 +47,16 @@ POST /v1/group/list-member ### 请求体 -```ProtoBuf -data { - size: 50 // 分页大小 - page: 1 // 页数 -} -group_id: "big" // 群聊 ID -keywords: "测试群成员" // 搜索关键词 -``` - -::: details ProtoBuf 数据结构 - -```proto -message list_member_send { - Data data = 2; - - message Data { - int32 size = 1; // 分页大小 - int32 page = 2; // 页数 - } - - string group_id = 3; // 群聊 ID - string keywords = 4; // 搜索关键词 -} +```protobuf + ``` -::: - ### 响应数据 -```ProtoBuf -status { - request_id: 114514 - code: 1 - msg: "success" -} -user { - group_id: "big" // 所属群聊 ID - user_info { - user_id: "7356666" // 用户 ID - name: "Feng" // 用户名 - avatar_url: "https://..." // 头像 URL - is_vip: 0 // 是否为 vip 用户,: 0-非 vip 用户, 1-vip 用户 - - } - permission_level: 100 // 权限等级, 群主 100 管理员 2 普通用户无/0 - gag_time: 123456 // 禁言时间戳 - is_gag: 0 // 是否处于禁言状态 -} -// 可以有多个 -// ... -``` - -::: details ProtoBuf 数据结构 - -```proto -message list_member { - Status status = 1; - repeated User user = 2; - - message User { - string group_id = 1; - User_info user_info = 2; - - message User_info { - string user_id = 1; - string name = 2; - string avatar_url = 4; - int32 is_vip = 6; - } - - int32 permission_level = 3; - int64 gag_time = 4; // 禁言时间 - int32 is_gag = 5; - } -} +```protobuf + ``` -::: - ## 获取群聊语音房间 ```http request @@ -269,6 +200,10 @@ POST /v1/group/remove-member ### 响应体 +::: tabs + +@tab:active 正常 + ```JSON { "code": 1, @@ -276,6 +211,34 @@ POST /v1/group/remove-member } ``` +@tab 踢群主 + +```JSON +{ + "code":-1, + "msg":"不可以移除群主！" +} +``` + +@tab 非管理员/群主或无效群聊 ID + +```JSON +{ + "code":-1, + "msg":"您无权操作此群聊，请联系群主或者管理员" +} + +@tab 无效用户 ID/不在群聊 + +```JSON +{ + "code":-1, + "msg":"该用户不在这个群聊，请重试" +} +``` + +::: + ## 禁言用户 ```http request @@ -300,6 +263,10 @@ POST /v1/group/gag-member ### 响应体 +::: tabs + +@tab:active 正常 + ```JSON { "code": 1, @@ -307,6 +274,44 @@ POST /v1/group/gag-member } ``` +@tab 禁言群主 + +```JSON +{ + "code":-1, + "msg":"不可以禁言群主！" +} +``` + +@tab 无效用户 ID/不在群聊 + +```JSON +{ + "code":-1, + "msg":"该用户不在这个群聊，请重试" +} +``` + +@tab 非特定禁言时长 + +```JSON +{ + "code":-1, + "msg":"禁言时长错误，请重试" +} +``` + +@tab 非管理员/群主或无效群聊 ID + +```JSON +{ + "code":-1, + "msg":"您无权操作此群聊，请联系群主或者管理员" +} +``` + +::: + ## 获取群聊推荐分类 ```http request @@ -573,6 +578,12 @@ POST /v1/group/msg-type-limit POST /v1/group/edit-group ``` +::: tip + +此编辑会覆盖原有设置,不是合并! + +::: + ### 请求头 | 名称 | 必须 | 备注 | @@ -581,59 +592,16 @@ POST /v1/group/edit-group ### 请求体 -```ProtoBuf -group_id: "123" // 目标群聊 ID -name: "测试群聊名称" // 群聊名称 -introduction: "测试群聊简介" // 群聊简介 -avatarUrl: "https://..." // 群聊头像u rl -direct_join: 0 // 进群免审核,1 为开启 -history_msg: 1 // 历史消息,1 为开启 -category_name: "无" // 分类名 -category_id: 40 // 分类 ID -private: 0 // 是否私有,1 为私有 -hide_group_members: 0 // 隐藏群成员 -``` - -::: details ProtoBuf 数据结构 - -```proto -message edit_group_send { - string group_id = 2; // 目标群聊 ID - string name = 3; // 群聊名称 - string introduction = 4; // 群聊简介 - string avatarUrl = 5; // 群聊头像 url - uint64 direct_join = 6; // 进群免审核,1 为开启 - uint64 history_msg = 7; // 历史消息,1 为开启 - string category_name = 8; // 分类名 - uint64 category_id = 9; // 分类 ID - uint64 private = 10; // 是否私有,1 为私有 - uint64 hide_group_members = 11; // 隐藏群成员 - -} +```protobuf + ``` -::: - ### 响应体 -```ProtoBuf -status { - request_id: 114514 - code: 1 - msg: "success" -} -``` - -::: details ProtoBuf 数据结构 - -```proto -message edit_group { - Status status = 1; -} +```protobuf + ``` -::: - ## 获取群机器人列表 ```http request diff --git a/src/full.proto b/src/full.proto index 0ee2c508..674b2e95 100644 --- a/src/full.proto +++ b/src/full.proto @@ -599,28 +599,6 @@ message TagMemberRequest { } // #endregion TagMemberRequest -// #region TagMemberResponse -message TagMemberResponse { - Status status = 1; - repeated User user = 2; - message User { - string group_id = 1; - UserInfo user_info = 2; - - message UserInfo { - string user_id = 1; - string name = 2; - string avatar_url = 4; - bool is_vip = 6; - } - int32 permission_level = 3; // 权限等级, 群主 100 管理员 2 普通用户无/0 - int64 gag_time = 4; // 禁言时间戳 - bool is_gag = 5; // 是否被禁言 - } - int32 total = 3; // 总数 -} -// #endregion TagMemberResponse - // group // 获取群聊信息 @@ -684,3 +662,56 @@ message GroupInfoResponse { } } // #endregion GroupInfoResponse + +// 获取群成员 +// #region ListMemberRequest +message ListMemberRequest { + Data data = 2; + + message Data { + int32 size = 1; // 分页大小 + int32 page = 2; // 页数 + } + + string group_id = 3; // 群聊 ID + string keywords = 4; // 搜索关键词 +} +// #endregion ListMemberRequest + +// #region ListMemberResponse +message ListMemberResponse { + Status status = 1; + repeated User user = 2; + message User { + string group_id = 1; + UserInfo user_info = 2; + + message UserInfo { + string user_id = 1; + string name = 2; + string avatar_url = 4; + bool is_vip = 6; + } + int32 permission_level = 3; // 权限等级, 群主 100 管理员 2 普通用户无/0 + int64 gag_time = 4; // 禁言时间戳 + bool is_gag = 5; // 是否被禁言 + } + int32 total = 3; // 总数 +} +// #endregion ListMemberResponse + +// 编辑群信息 +// #region EditGroupRequest +message EditGroupRequest { + string group_id = 2; // 目标群聊 ID + string name = 3; // 群聊名称 + string introduction = 4; // 群聊简介 + string avatar_url = 5; // 群聊头像 url + bool direct_join = 6; // 进群免审核,1 为开启 + bool history_msg = 7; // 历史消息,1 为开启 + string category_name = 8; // 分类名 + uint64 category_id = 9; // 分类 ID + bool private = 10; // 是否私有,1 为私有 + bool hide_group_members = 11; // 隐藏群成员 +} +// #endregion EditGroupRequest