Skip to content

获取评论[列表]

  • 接口地址:/api/v2/comment/list
  • 请求方式:GET
  • 传参方式:Query

Headers 可选参数

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

Query 参数

参数名类型是否必传说明
mapIdNumberNO地图服务商编号
mapLngStringNO地图经度(用于计算距离)
mapLatStringNO地图纬度(用于计算距离)
uidOrUsernameNumber / StringNO指定范围:用户
pidStringNO指定范围:帖子
cidStringNO指定范围:评论(获取该评论的子孙级评论)
hidStringNO指定范围:话题
gidStringNO指定范围:小组
includeSubgroupsBooleanNOgid 配置使用,是否包含子级小组的内容
默认为 false
stickyBooleanNO是否置顶(留空输出全部)
allDigestBooleanNO指定范围:全部精华,一级精华和二级精华
传参后,将忽略 digestState 参数
digestStateNumberNO指定范围:精华(留空输出全部)
digest_state 字段 1.否 2.一级精华 3.二级精华
contentTypeStringNO内容类型(内容类型扩展配置的参数)
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子级评论总数小于
orderTypeStringNO排序类型 createdTime,commentTime,random,view,like,dislike,follow,block,comment
默认 createdTime
orderDirectionStringNO排序方向,默认 desc
asc,desc
whitelistKeysStringNO白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
blacklistKeysStringNO黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberNO每页显示条数(默认 15 条)
pageNumberNO页码(默认 1)

接口使用说明

  • uidOrUsername 参数值代表获取指定用户的评论,根据 运营 > 互动配置 > 查看别人内容设置 决定是否输出。
    • it_comments 配置,是否输出点赞我的用户
  • 如果 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