Skip to content
On this page

Comment List

  • Endpoint Path: /api/v2/comment/list
  • Method: GET
  • Request: Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Query Params

Parameter NameTypeRequiredDescription
mapIdNumberoptional地图服务商编号
mapLngStringoptional地图经度(用于计算距离)
mapLatStringoptional地图纬度(用于计算距离)
uidOrUsernameStringoptional指定范围:用户
pidStringoptional指定范围:帖子
cidStringoptional指定范围:评论(获取该评论的子孙级评论)
hidStringoptional指定范围:话题
gidStringoptional指定范围:小组
includeSubgroupsBooleanoptionalgid 配置使用,是否包含子级小组的内容
默认为 false
stickyBooleanoptional是否置顶(留空输出全部)
allDigestBooleanoptional指定范围:全部精华,一级精华和二级精华
传参后,将忽略 digestState 参数
digestStateNumberoptional指定范围:精华(留空输出全部)
digest_state 字段 1.否 2.一级精华 3.二级精华
contentTypeStringoptional内容类型(内容类型扩展配置的参数)
createDateStringoptional发表日期:today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createDateGtStringoptional发表时间大于 Y-m-d
createDateLtStringoptional发表时间小于 Y-m-d
likeCountGtNumberoptional点赞数大于
likeCountLtNumberoptional点赞数小于
followCountGtNumberoptional关注数大于
followCountLtNumberoptional关注数小于
blockCountGtNumberoptional屏蔽数大于
blockCountLtNumberoptional屏蔽数小于
commentCountGtNumberoptional子级评论总数大于
commentCountLtNumberoptional子级评论总数小于
orderTypeStringoptional排序类型,默认 createDate
createDate,like,dislike,follow,block,comment
orderDirectionStringoptional排序方向,默认 desc
asc,desc
whitelistKeysStringoptional白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
blacklistKeysStringoptional黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberoptional每页显示条数(默认 15 条)
pageNumberoptional页码(默认 1)

Request Description

  • uidOrUsername 参数有值,代表获取指定用户的帖子,将根据 运营 > 互动配置 > 查看别人内容设置 决定是否输出数据。
    • it_comments 配置,是否输出点赞我的用户
  • 如果 uidOrUsername 为登录用户自己时,上方配置无效,直接输出数据,表示查看自己的内容时无视开关。
contentType 参数(大驼峰格式)说明
输出全部内容
All输出全部内容
Text输出纯文本评论
Image输出带图片的评论
Video输出带视频的评论
Audio输出带音频的评论
Document输出带文档的评论
输出含有插件 unikey 为 AbcName 扩展内容的评论

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                // Common Data Structure -> Comment Info
            }
        ]
    }
}

Released under the Apache-2.0 License