Skip to content

Commit 0e31acb

Browse files
committed
Document API for getting group bot list
Added API documentation for retrieving group bot list, including request headers, request body structure, and response format. 感谢Copilot的自动总结awa
1 parent 02d6477 commit 0e31acb

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

src/api/v1/group.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,3 +540,86 @@ message edit_group {
540540
```
541541

542542
:::
543+
544+
## 获取群机器人列表
545+
546+
POST /v1/group/bot-list
547+
548+
请求头:
549+
550+
|名称|必须|备注|
551+
|-----|----|----|
552+
|token||群内成员|
553+
554+
请求体:
555+
556+
```ProtoBuf
557+
group_id: "123" // 目标群聊ID
558+
```
559+
560+
::: details ProtoBuf数据结构
561+
562+
```proto
563+
message edit_group_send {
564+
string group_id = 2; // 目标群聊ID
565+
}
566+
```
567+
568+
:::
569+
570+
响应体:
571+
572+
```ProtoBuf
573+
status {
574+
number: 114514
575+
code: 1
576+
msg: "success"
577+
}
578+
// ...
579+
```
580+
581+
::: details ProtoBuf数据结构
582+
583+
```proto
584+
// 获取群机器人列表
585+
message bot_list_send {
586+
string group_id = 2;
587+
}
588+
589+
message bot_list {
590+
Status status = 1;
591+
repeated Bot_data bot = 2;
592+
593+
repeated Instruction_data instruction = 3;
594+
595+
message Instruction_data {
596+
int64 id = 1;
597+
string bot_id = 2;
598+
string name = 3; // 指令名
599+
string desc = 4; // 指令描述
600+
int32 type = 5; // 指令类型
601+
string hint_text = 6; // 输入框提示文字
602+
string default_text = 7; // 输入框默认文字
603+
// int32 hidden/del_flag = 8; // 是否隐藏/删除,猜的,有误欢迎指正
604+
int64 sort = 9; // 和排序相关 不确定
605+
string form = 10; // 表单
606+
string bot_name = 11;
607+
}
608+
repeated Menu_data menu = 4; // 快捷菜单相关
609+
610+
message Menu_data {
611+
int64 id = 1;
612+
string bot_id = 2;
613+
// int32 hidden/del_flag = 3; // 是否隐藏/删除,猜的
614+
string name = 4;
615+
string content = 5; // 内容
616+
int32 menu_type = 6; // 按钮类型,1-普通按钮 2-选中按钮 3-下拉选择
617+
int64 create_time = 7;
618+
// 8,9没找到
619+
int32 menu_action = 10; // 操作类型
620+
string select = 99; // 选择的选项,在选择按钮的时候也作为状态,选中为1,未选中为0
621+
}
622+
}
623+
```
624+
625+
:::

0 commit comments

Comments
 (0)