获取评论[列表]

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

Headers 可选参数

参数名	公开模式（是否必传）	私有模式（是否必传）
X-Fresns-Aid	NO	YES
X-Fresns-Aid-Token	NO	YES
X-Fresns-Uid	NO	YES
X-Fresns-Uid-Token	NO	YES

Query 参数

参数名	类型	是否必传	说明
pid	String	NO	指定范围：帖子
cid	String	NO	指定范围：评论（获取该评论的子孙级评论）
users	String	NO	指定范围：用户，uidOrUsername 多个以英文逗号隔开
hashtags	String	NO	指定范围：话题，htid 多个以英文逗号隔开
geotags	String	NO	指定范围：地理，gtid 多个以英文逗号隔开
groups	String	NO	指定范围：小组，gid 多个以英文逗号隔开
includeSubgroups	Boolean	NO	与 groups 配置使用，是否包含子级小组的内容 默认为 false
langTag	String	NO	指定范围：语言标签
contentType	String	NO	指定范围：内容类型（内容类型扩展配置的参数）
allDigest	Boolean	NO	指定范围：全部精华，一级精华和二级精华 传参后，将忽略 digestState 参数
digestState	Number	NO	指定范围：精华（留空输出全部） digest_state 字段 1.否 2.一级精华 3.二级精华
sticky	Boolean	NO	是否置顶（留空输出全部）
createdDays	Number	NO	发表天数：指定天数内创建的内容
createdDate	String	NO	发表日期：today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createdDateGt	String	NO	发表时间大于 Y-m-d
createdDateLt	String	NO	发表时间小于 Y-m-d
viewCountGt	Number	NO	查看数大于
viewCountLt	Number	NO	查看数小于
likeCountGt	Number	NO	点赞数大于
likeCountLt	Number	NO	点赞数小于
dislikeCountGt	Number	NO	点踩数大于
dislikeCountLt	Number	NO	点踩数小于
followCountGt	Number	NO	关注数大于
followCountLt	Number	NO	关注数小于
blockCountGt	Number	NO	屏蔽数大于
blockCountLt	Number	NO	屏蔽数小于
commentCountGt	Number	NO	子级评论总数大于
commentCountLt	Number	NO	子级评论总数小于
blockUsers	String	NO	过滤用户，uidOrUsername 多个以英文逗号隔开
blockGroups	String	NO	过滤小组，gid 多个以英文逗号隔开
blockHashtags	String	NO	过滤话题，htid 多个以英文逗号隔开
blockGeotags	String	NO	过滤地理，gtid 多个以英文逗号隔开
blockPosts	String	NO	过滤帖子，pid 多个以英文逗号隔开
blockComments	String	NO	过滤评论，cid 多个以英文逗号隔开
sinceCid	String	NO	查询该评论之后的新内容
beforeCid	String	NO	查询该评论之前的旧内容
orderType	String	NO	排序类型 createdTime,commentTime,random,view,like,dislike,follow,block,comment 默认 createdTime
orderDirection	String	NO	排序方向，默认 desc asc,desc
mapId	Number	NO	地图服务商编号
mapLng	String	NO	地图经度（用于计算距离）
mapLat	String	NO	地图纬度（用于计算距离）
filterType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对
filterKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterHashtagType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 hashtags 参数有效
filterHashtagKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterGeotagType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 geotag 参数有效
filterGeotagKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterAuthorType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 author 参数有效
filterAuthorKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterPreviewLikeUserType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 previewLikeUsers 参数有效
filterPreviewLikeUserKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterPreviewCommentType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 previewComments 参数有效
filterPreviewCommentKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterReplyToPostType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 replyToPost 参数有效
filterReplyToPostKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
filterReplyToCommentType	String	NO	whitelist 只返回给定键名的键值对 blacklist 从返回数据中删除指定的键值对 仅对返回结果中 replyToComment 参数有效
filterReplyToCommentKeys	String	NO	多个以英文逗号隔开，支持「点表示法」表示多维数组
pageSize	Number	NO	每页显示条数（默认 15 条）
page	Number	NO	页码（默认 1）

接口使用说明

• uidOrUsername 参数值代表获取指定用户的评论，根据 运营 > 互动配置 > 查看别人内容设置 决定是否输出。
  • it_comments 配置，是否输出点赞我的用户
• 如果 uidOrUsername 为登录用户自己时，上方配置无效，直接输出数据，表示查看自己的内容时无视开关。

contentType 参数（大驼峰格式）	说明
	输出全部内容
All	输出全部内容
Text	输出纯文本评论
Image	输出带图片的评论
Video	输出带视频的评论
Audio	输出带音频的评论
Document	输出带文档的评论
	输出含有插件 fskey 为 AbcName 扩展内容的评论

• 内容类型列表参考 /api/fresns/v1/global/{type}/content-types

返回结果

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

• 通用数据结构->评论信息