Skip to content

获取帖子[列表]

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

Headers 可选参数

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

Query 参数

参数名类型是否必传说明
usersStringNO指定范围:用户,uidOrUsername 多个以英文逗号隔开
hashtagsStringNO指定范围:话题,htid 多个以英文逗号隔开
geotagsStringNO指定范围:地理,gtid 多个以英文逗号隔开
groupsStringNO指定范围:小组,gid 多个以英文逗号隔开
includeSubgroupsBooleanNOgroups 配置使用,是否包含子级小组的内容
默认为 false
langTagStringNO指定范围:语言标签
contentTypeStringNO指定范围:内容类型(内容类型扩展配置的参数)
allDigestBooleanNO指定范围:全部精华,一级精华和二级精华
传参后,将忽略 digestState 参数
digestStateNumberNO指定范围:精华(留空输出全部)
digest_state 字段 1.否 2.一级精华 3.二级精华
stickyStateNumberNO指定范围:置顶(留空输出全部)
sticky_state 字段 1.否 2.小组页置顶 3.全局置顶
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屏蔽数小于
commentCountGtNumberNO评论总数大于
commentCountLtNumberNO评论总数小于
blockUsersStringNO过滤用户,uidOrUsername 多个以英文逗号隔开
blockGroupsStringNO过滤小组,gid 多个以英文逗号隔开
blockHashtagsStringNO过滤话题,htid 多个以英文逗号隔开
blockGeotagsStringNO过滤地理,gtid 多个以英文逗号隔开
blockPostsStringNO过滤帖子,pid 多个以英文逗号隔开
sincePidStringNO查询该帖子之后的新内容
beforePidStringNO查询该帖子之前的旧内容
orderTypeStringNO排序类型 createdTime,commentTime,random,view,like,dislike,follow,block,comment
默认 createdTime
orderDirectionStringNO排序方向,默认 desc
asc,desc
mapIdNumberNO地图服务商编号
mapLngStringNO地图经度(用于计算距离)
mapLatStringNO地图纬度(用于计算距离)
filterTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
filterKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterGroupTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 group 参数有效
filterGroupKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterHashtagTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 hashtags 参数有效
filterHashtagKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterGeotagTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 geotag 参数有效
filterGeotagKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterAuthorTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 author 参数有效
filterAuthorKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterQuotedPostTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 quotedPost 参数有效
filterQuotedPostKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterPreviewLikeUserTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 previewLikeUsers 参数有效
filterPreviewLikeUserKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
filterPreviewCommentTypeStringNOwhitelist 只返回给定键名的键值对
blacklist 从返回数据中删除指定的键值对
仅对返回结果中 previewComments 参数有效
filterPreviewCommentKeysStringNO多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberNO每页显示条数(默认 15 条)
pageNumberNO页码(默认 1)

接口使用说明

  • 如果是私有模式,当过期后 users->expired_at,需判断到期后的状态。
    • 配置表 site_private_end_after 键值为 1 时,该接口不可请求;
    • 键值为 2 时,仅输出 posts->created_at 发表时间小于失效时间 users->expired_at 的帖子。
  • uidOrUsername 参数值代表获取指定用户的帖子,根据 运营 > 互动配置 > 查看别人内容设置 决定是否输出。
    • it_posts 配置,是否输出点赞我的用户
  • 如果 uidOrUsername 为登录用户自己时,上方配置无效,直接输出数据,表示查看自己的内容时无视开关。
  • 如果是非公开小组的帖子,不是小组内成员(未关注小组),不输出。
  • 屏蔽对象的帖子(用户、小组、话题、地理、帖子)不输出。
contentType 参数(大驼峰格式)说明
输出全部内容
All输出全部内容
Text输出纯文本帖子
Image输出带图片的帖子
Video输出带视频的帖子
Audio输出带音频的帖子
Document输出带文档的帖子
输出含有插件 fskey 为 AbcName 扩展内容的帖子

返回结果

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

Released under the Apache-2.0 License