Skip to content

获取小组[列表] 小组

  • 接口地址:/api/fresns/v1/group/list
  • 请求方式:GET
  • 传参方式:Query

Headers 可选参数

参数名公开模式(是否必传)私有模式(是否必传)
X-Fresns-AidNOYES
X-Fresns-Aid-TokenNOYES
X-Fresns-UidNOYES
X-Fresns-Uid-TokenNOYES

Query 参数

参数名类型是否必传说明
typeNumberNO指定自定义类型
gidStringNO获取该 gid 下小组
topGroupsBooleanNO获取顶级小组 0.否 / 1.是
recommendBooleanNO推荐状态 0.不推荐 / 1.推荐
createdDaysNumberNO创建天数:指定天数内创建的小组
createdDateStringNO创建日期:today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createdDateGtStringNO创建时间大于 Y-m-d
createdDateLtStringNO创建时间小于 Y-m-d
viewCountGtNumberNO查看数大于
viewCountLtNumberNO查看数小于
likeCountGtNumberNO点赞数大于
likeCountLtNumberNO点赞数小于
dislikeCountGtNumberNO点踩数大于
dislikeCountLtNumberNO点踩数小于
followCountGtNumberNO关注数大于
followCountLtNumberNO关注数小于
blockCountGtNumberNO屏蔽数大于
blockCountLtNumberNO屏蔽数小于
postCountGtNumberNO帖子数大于
postCountLtNumberNO帖子数小于
postDigestCountGtNumberNO精华数大于
postDigestCountLtNumberNO精华数小于
orderTypeStringNO排序类型 view,like,dislike,follow,block,post,postDigest,createdTime,createdTime,createdTime,lastPostTime,lastCommentTime,random,sortOrder
默认 sortOrder
orderDirectionStringNO排序方向 asc,desc,默认 asc
filterTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
filterKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberNO每页显示条数(默认 15 条)
pageNumberNO页码(默认 1)

返回结果

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                // 通用数据结构->小组信息
            }
        ]
    }
}

Released under the Apache-2.0 License