Skip to content

Commit 39d2dc1

Browse files
committed
Update friend.md
添加/v1/friend/request-list API,感谢三连,hehe提供的proto和注释
1 parent e535496 commit 39d2dc1

1 file changed

Lines changed: 80 additions & 0 deletions

File tree

src/api/v1/friend.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,83 @@ message address_book_list {
166166
```
167167

168168
:::
169+
170+
## 获取对象请求列表
171+
172+
POST /v1/friend/request-list
173+
174+
请求头:
175+
176+
|名称|必须|备注|
177+
|-----|-----|-----|
178+
|token|||
179+
180+
响应体:
181+
182+
```ProtoBuf
183+
status {
184+
number: 114514
185+
code: 1 // 请求状态码,1为正常
186+
msg: "success" // 返回消息
187+
}
188+
requests {
189+
receiverName: "测试接收者名称" // 接收者名称
190+
receiverAvatar: "https://..." // 接收者头像
191+
name: "测试用户名称" // 请求方名称
192+
avatar: "https://..." // 请求方头像
193+
groupName: "测试群组名称" // 群组名称
194+
groupAvata: "https://..." // 群组头像
195+
inviterId: "123" // 邀请者ID (字段8同此含义)
196+
ourceType: 1 // 来源类型
197+
targetType: 1 // 目标类型
198+
targetId: "123" // 目标ID
199+
receiverId: "123" // 接收者ID
200+
result: 0 // 处理结果
201+
processedAt: 1231231230 // 处理时间戳
202+
inviteAt: 1231231230 // 邀请时间戳
203+
inviteAtStr: "1231-23-12 31:23:00" // 邀请时间字符串
204+
requestI: 123; // 请求ID
205+
botName: 测试机器人名称" // 机器人名称
206+
botAvatar: "https://..." // 机器人头像
207+
processorName: "测试处理者名称" 处理者名称
208+
note: "测试对象请求" // 备注信息
209+
}
210+
total: 1 // 总请求数
211+
pending: 0 // 待处理请求数
212+
```
213+
214+
::: details ProtoBuf数据结构
215+
216+
```proto
217+
// 对象请求列表
218+
message Response {
219+
Status status = 1;
220+
message Request {
221+
string receiverName = 1; // 接收者名称
222+
string receiverAvatar = 2; // 接收者头像
223+
string name = 3; // 请求方名称
224+
string avatar = 4; // 请求方头像
225+
string groupName = 5; // 群组名称
226+
string groupAvatar = 6; // 群组头像
227+
string inviterId = 7; // 邀请者ID (字段8同此含义)
228+
int32 sourceType = 9; // 来源类型
229+
int32 targetType = 10; // 目标类型
230+
string targetId = 11; // 目标ID
231+
string receiverId = 12; // 接收者ID
232+
int32 result = 13; // 处理结果
233+
int64 processedAt = 14; // 处理时间戳
234+
int64 inviteAt = 16; // 邀请时间戳
235+
string inviteAtStr = 17; // 邀请时间字符串
236+
int32 requestId = 18; // 请求ID
237+
string botName = 19; // 机器人名称
238+
string botAvatar = 20; // 机器人头像
239+
string processorName = 22; // 处理者名称
240+
string note = 23; // 备注信息
241+
}
242+
repeated Request requests = 2; // 请求列表
243+
int32 total = 3; // 总请求数
244+
int32 pending = 4; // 待处理请求数
245+
}
246+
```
247+
248+
:::

0 commit comments

Comments
 (0)