评论 - fresns

请求参数

Query 参数

searchKey

string

搜索词

可选

followUsers

integer

可选

指定范围：我关注的用户发表的

followGroups

integer

可选

指定范围：我关注的小组里

followHashtags

integer

可选

指定范围：我关注的话题里

followComments

integer

可选

指定范围：我关注的评论

mapId

number

地图服务商编号

可选

mapLng

string

可选

地图经度（用于计算距离）

mapLat

string

可选

地图纬度（用于计算距离）

uidOrUsername

string

指定范围：用户

可选

pid

string

指定范围：帖子

可选

cid

string

可选

指定范围：评论（获取该评论的子孙级评论）

hid

string

指定范围：话题

可选

gid

string

指定范围：小组

可选

includeSubgroups

integer

可选

与 gid 配置使用，是否包含子级小组的内容
默认为 false

sticky

integer

可选

是否置顶（留空输出全部）

allDigest

integer

可选

指定范围：全部精华，一级精华和二级精华
传参后，将忽略 digestState 参数

digestState

number

可选

指定范围：精华（留空输出全部）
digest_state 字段 1.否 2.一级精华 3.二级精华

contentType

string

可选

内容类型（内容类型扩展配置的参数）

createDate

string

可选

发表日期：today

createDateGt

string

可选

发表时间大于 Y-m-d

createDateLt

string

可选

发表时间小于 Y-m-d

likeCountGt

number

点赞数大于

可选

likeCountLt

number

点赞数小于

可选

followCountGt

number

关注数大于

可选

followCountLt

number

关注数小于

可选

blockCountGt

number

屏蔽数大于

可选

blockCountLt

number

屏蔽数小于

可选

commentCountGt

number

子级评论总数大于

可选

commentCountLt

number

子级评论总数小于

可选

orderType

string

可选

排序类型，默认 createDate
createDate

orderDirection

string

可选

排序方向，默认 desc
asc

whitelistKeys

string

可选

白名单键名，只返回给定键名的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组

blacklistKeys

string

可选

黑名单键名，从返回数据中删除指定的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组

pageSize

number

可选

每页显示条数（默认 15 条）

page

number

页码（默认 1）

可选

Header 参数

X-Fresns-App-Id

string

必需

密钥 App ID
密钥位置：控制面板->应用中心->应用密钥

默认值:

X-Fresns-Client-Platform-Id

integer

必需

平台编号，与密钥的「平台」匹配

默认值:

X-Fresns-Client-Version

string

必需

你的客户端版本号，推荐使用语义化版本号

默认值:

X-Fresns-Client-Device-Info

string

必需

交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参

默认值:

X-Fresns-Aid

string

可选

账号参数（留空则视为未登录账号）

默认值:

X-Fresns-Aid-Token

string

可选

账号身份凭证（传参 aid 时必传）

默认值:

X-Fresns-Uid

integer

可选

用户参数（留空则视为未登录用户）

默认值:

X-Fresns-Uid-Token

string

可选

用户身份凭证（传参 uid 时必传）

默认值:

X-Fresns-Signature

string

签名

必需

X-Fresns-Signature-Timestamp

string

必需

签名生成时间（当前 Unix 时间戳，精确到秒或毫秒都支持）

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://localhost:8080/api/v2/search/comments?searchKey=&followUsers=&followGroups=&followHashtags=&followComments=&mapId=&mapLng=&mapLat=&uidOrUsername=&pid=&cid=&hid=&gid=&includeSubgroups=&sticky=&allDigest=&digestState=&contentType=&createDate=&createDateGt=&createDateLt=&likeCountGt=&likeCountLt=&followCountGt=&followCountLt=&blockCountGt=&blockCountLt=&commentCountGt=&commentCountLt=&orderType=&orderDirection=&whitelistKeys=&blacklistKeys=&pageSize=&page=' \
--header 'X-Fresns-App-Id;' \
--header 'X-Fresns-Client-Platform-Id;' \
--header 'X-Fresns-Client-Version;' \
--header 'X-Fresns-Client-Device-Info;' \
--header 'X-Fresns-Aid: ' \
--header 'X-Fresns-Aid-Token: ' \
--header 'X-Fresns-Uid: ' \
--header 'X-Fresns-Uid-Token: ' \
--header 'X-Fresns-Signature;' \
--header 'X-Fresns-Signature-Timestamp;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

pagination

object (Pagination)

必需

list

array[object (Comment) {49}]

必需

示例

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