获取小组[列表]

  • 接口地址: /api/fresns/group/lists
  • 请求方式: POST
  • 请求格式: JSON

header 可选参数:

参数名公开模式(是否必传)私有模式(是否必传)
uidNOYES
midNOYES
tokenNOYES

body 参数:

参数名类型是否必传说明
typeNumberYES1.小组分类 / 2.小组
searchKeyStringNO搜索:关键词(查询 name 字段)
parentGidStringNO父级小组 UUID,获取该父级小组 ID 下的小组
recommendNumberNO推荐状态 1.不推荐 / 2.推荐
viewCountGtNumberNO查看数大于 view_count 字段
viewCountLtNumberNO查看数小于 view_count 字段
likeCountGtNumberNO点赞数大于 like_count 字段
likeCountLtNumberNO点赞数小于 like_count 字段
followCountGtNumberNO关注数大于 follow_count 字段
followCountLtNumberNO关注数小于 follow_count 字段
shieldCountGtNumberNO屏蔽数大于 shield_count 字段
shieldCountLtNumberNO屏蔽数小于 shield_count 字段
postCountGtNumberNO帖子数大于 post_count 字段
postCountLtNumberNO帖子数小于 post_count 字段
essenceCountGtNumberNO精华数大于 essence_count 字段
essenceCountLtNumberNO精华数小于 essence_count 字段
createdTimeGtStringNO创建时间大于 created_at 字段
createdTimeLtStringNO创建时间小于 created_at 字段
sortTypeStringNO排序类型 view / like / follow / shield / post / essence / time / rankNum
默认 rankNum
sortDirectionNumberNO排序方式 1.升序 2.降序
默认 2.降序
pageSizeNumberNO每页显示条数(默认 30 条)
pageNumberNO页码(默认 1)

返回结果:

成功

{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "一共有多少条数据",
            "current": "当前页码",
            "pageSize": "每页有多少条数据",
            "lastPage": "最后一页页码"
        },
        "list": [
            {
                "gid": "groups > uuid",
                "gname": "groups > name 多语言",
                "type": "groups > type",
                "description": "groups > description 多语言",
                "cover": "groups > cover_file_url",
                "banner": "groups > banner_file_url",
                "recommend": "groups > is_recommend",
                "mode": "groups > type_mode",
                "find": "groups > type_find",
                "followSetting": "配置表键名 follow_group_setting 布尔型",
                "followName": "配置表键名 follow_group_name 多语言",
                "followStatus": "查询 member_follows 表。输出 0.未关注 1.已关注",
                "followType": "groups > type_follow",
                "followUrl": "groups > plugin_unikey 如果 type_follow=2 则生成插件 URL",
                "likeSetting": "配置表键名 like_group_setting 布尔型",
                "likeName": "配置表键名 like_group_name 多语言",
                "likeStatus": "查询 member_likes 表。输出 0.未点赞 1.已点赞",
                "shieldSetting": "配置表键名 shield_group_setting 布尔型",
                "shieldName": "配置表键名 shield_group_name 多语言",
                "shieldStatus": "查询 member_shields 表。输出 0.未屏蔽 1.已屏蔽",
                "groupName": "配置表键名 group_name 多语言",
                "viewCount": "groups > view_count",
                "likeCount": "groups > like_count",
                "followCount": "groups > follow_count",
                "shieldCount": "groups > shield_count",
                "postCount": "groups > post_count",
                "essenceCount": "groups > essence_count",
                "parentInfo": {
                    "gid": "groups > parent_id >> groups > uuid",
                    "gname": "groups > name 多语言",
                    "cover": "groups > cover_file_url"
                },
                "admins": [
                    //groups > permission > admin.members 小组管理员列表
                    {
                        "mid": "members > uuid",
                        "mname": "members > name",
                        "nickname": "members > nickname",
                        "nicknameColor": "主角色的值 member_roles > nickname_color",
                        "avatar": "members > avatar_file_url",
                    }
                ],
                "publishRule": {
                    "allowPost": "groups > permission > publish.post 和 publish.post.roles 当前请求接口的成员,是否拥有该小组发表帖子权限",
                    "reviewPost": "groups > permission > publish.post.review 当前请求接口的成员,发帖是否需要审核(如果是管理员,无需审核)",
                    "allowComment": "groups > permission > publish.post 和 publish.post.roles 当前请求接口的成员,是否拥有该小组发表评论权限",
                    "reviewComment": "groups > permission > publish.comment.review 当前请求接口的成员,评论是否需要审核(如果是管理员,无需审核)"
                },
                "permission": {
                    // groups 表 permission 字段其他内容
                    // 删除输出 admin.members、publish.post、publish.post.review、publish.post、publish.comment.review 这几个参数,因为上面已经使用。
                    "权限名称": "值",
                    "权限名称": [
                        "值"
                    ],
                    "权限名称": "值"
                }
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

失败

{
    "code": "code_messages > code",
    "message": "code_messages > message"
}
1
2
3
4

开发说明

  • 小组数据表 type_find = 2 只有当前请求的用户已经 follow 了该小组才输出,否则不输出在列表中。
  • body 参数 sortType 的值为 rankNum 时,排序类型是 groups > rank_num 字段值。
  • 所有涉及图片的参数,需要判断是否开启了防盗链,如果开启了,不能直接使用 URL 字段值,需要获取防盗链链接。