212 lines
6.1 KiB
Markdown
212 lines
6.1 KiB
Markdown
# Basic
|
|
|
|
群组
|
|
|
|
- [/group.Basic/Search](#groupbasicsearch)
|
|
- [/group.Basic/Fetch](#groupbasicfetch)
|
|
- [/group.Basic/Get](#groupbasicget)
|
|
- [/group.Basic/Create](#groupbasiccreate)
|
|
- [/group.Basic/Modify](#groupbasicmodify)
|
|
- [/group.Basic/Disband](#groupbasicdisband)
|
|
|
|
## /group.Basic/Search
|
|
|
|
搜索
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
keyword: "", // type<string>, 关键词
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
total: 0, // type<int32>, 总记录数
|
|
version: "0", // type<int64>, 版本号
|
|
groups: [{
|
|
id: "0", // type<int64>, 主键
|
|
identity: "", // type<string>, 唯一标识
|
|
number: "0", // type<int64>, 群组编号
|
|
avatar: "", // type<string>, 群组头像
|
|
name: "", // type<string>, 群组名称
|
|
introduce: "", // type<string>, 群组简介
|
|
creator_id: "0", // type<int64>, 创建者ID
|
|
cretor_identity: "", // type<string>, 创建者Identity
|
|
member_limit: 0, // type<int32>, 最大成员数,0代表不限制
|
|
master: [""], // list<string>, 管理员
|
|
notice: "", // type<string>, 群组公告
|
|
background: "", // type<string>, 群组背景
|
|
tags: [""], // list<string>, 群组标签
|
|
member_total: 0, // type<int32>, 群组成员数
|
|
enable_search_by_number: false, // type<bool>, 是否开启群号搜索
|
|
enable_search_by_name: false, // type<bool>, 是否开启群名搜索
|
|
created_at: "", // type<string>, 群组创建时间
|
|
}], // list<GroupItem>, 群组信息
|
|
}
|
|
```
|
|
## /group.Basic/Fetch
|
|
|
|
获取群组列表
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
total: 0, // type<int32>, 总记录数
|
|
version: "0", // type<int64>, 版本号
|
|
groups: [{
|
|
id: "0", // type<int64>, 主键
|
|
identity: "", // type<string>, 唯一标识
|
|
number: "0", // type<int64>, 群组编号
|
|
avatar: "", // type<string>, 群组头像
|
|
name: "", // type<string>, 群组名称
|
|
introduce: "", // type<string>, 群组简介
|
|
creator_id: "0", // type<int64>, 创建者ID
|
|
cretor_identity: "", // type<string>, 创建者Identity
|
|
member_limit: 0, // type<int32>, 最大成员数,0代表不限制
|
|
master: [""], // list<string>, 管理员
|
|
notice: "", // type<string>, 群组公告
|
|
background: "", // type<string>, 群组背景
|
|
tags: [""], // list<string>, 群组标签
|
|
member_total: 0, // type<int32>, 群组成员数
|
|
enable_search_by_number: false, // type<bool>, 是否开启群号搜索
|
|
enable_search_by_name: false, // type<bool>, 是否开启群名搜索
|
|
created_at: "", // type<string>, 群组创建时间
|
|
}], // list<GroupItem>, 群组信息
|
|
}
|
|
```
|
|
## /group.Basic/Get
|
|
|
|
获取群组信息
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
id: "0", // type<int64>, 唯一ID
|
|
identity: "", // type<string>, 唯一码
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
id: "0", // type<int64>, 主键
|
|
identity: "", // type<string>, 唯一标识
|
|
number: "0", // type<int64>, 群组编号
|
|
avatar: "", // type<string>, 群组头像
|
|
name: "", // type<string>, 群组名称
|
|
introduce: "", // type<string>, 群组简介
|
|
creator_id: "0", // type<int64>, 创建者ID
|
|
cretor_identity: "", // type<string>, 创建者Identity
|
|
member_limit: 0, // type<int32>, 最大成员数,0代表不限制
|
|
master: [""], // list<string>, 管理员
|
|
notice: "", // type<string>, 群组公告
|
|
background: "", // type<string>, 群组背景
|
|
tags: [""], // list<string>, 群组标签
|
|
member_total: 0, // type<int32>, 群组成员数
|
|
enable_search_by_number: false, // type<bool>, 是否开启群号搜索
|
|
enable_search_by_name: false, // type<bool>, 是否开启群名搜索
|
|
created_at: "", // type<string>, 群组创建时间
|
|
}
|
|
```
|
|
## /group.Basic/Create
|
|
|
|
创建群组
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
id: "0", // type<int64>, 主键
|
|
identity: "", // type<string>, 唯一标识
|
|
number: "0", // type<int64>, 群组编号
|
|
avatar: "", // type<string>, 群组头像
|
|
name: "", // type<string>, 群组名称
|
|
introduce: "", // type<string>, 群组简介
|
|
creator_id: "0", // type<int64>, 创建者ID
|
|
cretor_identity: "", // type<string>, 创建者Identity
|
|
member_limit: 0, // type<int32>, 最大成员数,0代表不限制
|
|
master: [""], // list<string>, 管理员
|
|
notice: "", // type<string>, 群组公告
|
|
background: "", // type<string>, 群组背景
|
|
tags: [""], // list<string>, 群组标签
|
|
member_total: 0, // type<int32>, 群组成员数
|
|
enable_search_by_number: false, // type<bool>, 是否开启群号搜索
|
|
enable_search_by_name: false, // type<bool>, 是否开启群名搜索
|
|
created_at: "", // type<string>, 群组创建时间
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
data: "", // type<string>, 数据
|
|
timeseq: "0", // type<int64>, 响应时间序列
|
|
}
|
|
```
|
|
## /group.Basic/Modify
|
|
|
|
修改群组信息
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
id: "0", // type<int64>, 主键
|
|
identity: "", // type<string>, 唯一标识
|
|
number: "0", // type<int64>, 群组编号
|
|
avatar: "", // type<string>, 群组头像
|
|
name: "", // type<string>, 群组名称
|
|
introduce: "", // type<string>, 群组简介
|
|
creator_id: "0", // type<int64>, 创建者ID
|
|
cretor_identity: "", // type<string>, 创建者Identity
|
|
member_limit: 0, // type<int32>, 最大成员数,0代表不限制
|
|
master: [""], // list<string>, 管理员
|
|
notice: "", // type<string>, 群组公告
|
|
background: "", // type<string>, 群组背景
|
|
tags: [""], // list<string>, 群组标签
|
|
member_total: 0, // type<int32>, 群组成员数
|
|
enable_search_by_number: false, // type<bool>, 是否开启群号搜索
|
|
enable_search_by_name: false, // type<bool>, 是否开启群名搜索
|
|
created_at: "", // type<string>, 群组创建时间
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
data: "", // type<string>, 数据
|
|
timeseq: "0", // type<int64>, 响应时间序列
|
|
}
|
|
```
|
|
## /group.Basic/Disband
|
|
|
|
解散群组
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
id: "0", // type<int64>, 唯一ID
|
|
identity: "", // type<string>, 唯一码
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
data: "", // type<string>, 数据
|
|
timeseq: "0", // type<int64>, 响应时间序列
|
|
}
|
|
```
|
|
|