Skip to content

Commit 3113be5

Browse files
committed
Update bot.md
新添加获取机器人信息API
1 parent b748d33 commit 3113be5

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

src/api/v1/bot.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,3 +256,86 @@ POST /v1/bot/web-edit-bot
256256
"msg": "success" // 返回消息
257257
}
258258
```
259+
260+
## 获取机器人信息
261+
262+
POST /v1/bot/bot-info
263+
264+
请求头:
265+
266+
|名称|必须|备注|
267+
|-----|----|----|
268+
|token|是|无|
269+
270+
请求体:
271+
272+
```ProtoBuf
273+
i: 123 // 机器人ID
274+
```
275+
276+
::: details ProtoBuf数据结构
277+
278+
```proto
279+
message bot_info_send {
280+
string id = 2; // 机器人ID
281+
}
282+
```
283+
284+
:::
285+
286+
响应体:
287+
288+
```ProtoBuf
289+
status {
290+
number: 114514
291+
code: 1
292+
msg: "success"
293+
}
294+
Bot_data {
295+
bot_id: "123" // 机器人ID
296+
name: "测试机器人名称" // 机器人名称
297+
name_id: 123 // 机器人名称ID
298+
avatar_url: "https://..." // 机器人头像url
299+
avatar_id: 123 // 机器人头像ID
300+
introduction: "测试机器人介绍" // 机器人介绍
301+
create_by: "123" // 机器人创建者ID
302+
create_time: 123123123 // 机器人创建时间戳
303+
headcount: 123 // 使用人数
304+
private: 0 // 是否为私有,0-公开,1-私有
305+
is_stop: 0 // 是否停用,0-启用,1-停用
306+
always_agree: 0 // 自动进群,0-不自动进群,1-自动进群
307+
do_not_disturb: 0 // 免打扰,0-不免打扰,1-免打扰
308+
top: 0 // 置顶,0-未置顶,1-已置顶
309+
group_limit: 0 // 限制进群,0-允许进群,1-限制进群
310+
}
311+
```
312+
313+
::: details ProtoBuf数据结构
314+
315+
```proto
316+
// 获取机器人信息返回信息
317+
message bot_info {
318+
Status status = 1;
319+
Bot_data data = 2;
320+
message Bot_data {
321+
string bot_id = 1; // 机器人ID
322+
string name = 2; // 机器人名称
323+
int64 name_id = 3; // 机器人名称ID
324+
string avatar_url = 4; // 机器人头像url
325+
string avatar_id = 5; // 机器人头像ID
326+
string introduction = 6; // 机器人介绍
327+
string create_by = 7; // 机器人创建者ID
328+
int64 create_time = 8; // 机器人创建时间戳
329+
int64 headcount = 9; // 使用人数
330+
int32 private = 10; // 是否为私有,0-公开,1-私有
331+
int32 is_stop = 11; // 是否停用,0-启用,1-停用
332+
int32 always_agree = 13; // 自动进群,0-不自动进群,1-自动进群
333+
int32 do_not_disturb = 15; // 免打扰,0-不免打扰,1-免打扰
334+
int32 top = 18; // 置顶,0-未置顶,1-已置顶
335+
int32 group_limit = 20; // 限制进群,0-允许进群,1-限制进群
336+
}
337+
}
338+
339+
```
340+
341+
:::

0 commit comments

Comments
 (0)