fresns
  1. 帖子
fresns
  • 请求标头
  • 通用数据结构
  • 错误码
  • 全局配置
    • 全局配置信息
      GET
    • 状态码信息
      GET
    • 扩展档案配置
      GET
    • 上传用的令牌
      GET
    • 用户角色
      GET
    • 地图服务商
      GET
    • 内容类型
      GET
    • 表情图
      GET
    • 阻止词
      GET
  • 公共业务
    • 输入提示信息
      GET
    • 回调返参查询
      GET
    • 发送验证码
      POST
    • 上传日志
      POST
    • 上传文件
      POST
    • 文件下载链接
      GET
    • 下载过文件的用户
      GET
  • 账号
    • 注册
    • 登录
    • 重置密码
    • 获取账号详情
    • 钱包交易记录
    • 身份验证
    • 修改账号资料
    • 退出登录
    • 申请删除账号
    • 撤销删除申请
  • 用户
    • 获取用户列表
    • 获取用户详情
    • 获取用户认识的关注者
    • 获取用户互动的用户列表
    • 获取用户标记的内容列表
    • 用户登录
    • 用户面板
    • 修改用户资料
    • 操作标记
    • 标记备注
  • 消息
    • [通知]获取消息列表
    • [通知]更新阅读状态
    • [通知]删除消息
    • [对话]获取对话列表
    • [对话]获取对话详情
    • [对话]获取消息列表
    • [对话]置顶对话
    • [对话]更新阅读状态
    • [对话]发送消息
    • [对话]删除对话或对话的消息
  • 小组
    • 获取树结构小组列表
    • 获取小组分类
    • 获取小组列表
    • 获取小组详情
    • 获取小组互动的用户列表
  • 话题
    • 获取话题列表
    • 获取话题详情
    • 获取话题互动的用户列表
  • 帖子
    • 获取帖子列表
      GET
    • 获取关注对象的帖子列表
      GET
    • 获取位置附近的帖子列表
      GET
    • 获取帖子详情
      GET
    • 获取帖子互动的用户列表
      GET
    • 获取帖子的附属用户列表
      GET
    • 获取帖子的日志列表
      GET
    • 获取帖子日志详情
      GET
    • 删除帖子
      DELETE
  • 评论
    • 获取评论列表
    • 获取关注对象的评论列表
    • 获取位置附近的评论列表
    • 获取评论详情
    • 获取评论互动的用户列表
    • 获取评论的日志列表
    • 获取评论日志详情
    • 删除评论
  • 编辑器
    • 快速发表(帖子)
    • 快速发表(评论)
    • 编辑器配置信息
    • 获取草稿列表(帖子)
    • 获取草稿列表(评论)
    • 创建草稿(帖子)
    • 创建草稿(评论)
    • 生成编辑草稿(帖子)
    • 生成编辑草稿(评论)
    • 获取草稿详情(帖子)
    • 获取草稿详情(评论)
    • 更新草稿内容(帖子)
    • 更新草稿内容(评论)
    • 提交发表(或审核)
    • 撤回审核中草稿
    • 删除草稿
  • 搜索
    • 用户
    • 小组
    • 话题
    • 帖子
    • 评论
  1. 帖子

获取帖子列表

开发中
GET
http://localhost:8080/api/v2/post/list
如果是私有模式,当过期后 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输出带文档的帖子
{AbcName}输出含有插件 unikey 为 AbcName 扩展内容的帖子
内容类型列表参考 /api/v2/global/{type}/content-types

请求参数

Query 参数
mapId
number 
地图服务商编号
可选
mapLng
string 
可选
地图经度(用于计算距离)
mapLat
string 
可选
地图纬度(用于计算距离)
uidOrUsername
string 
指定范围:用户
可选
hid
string 
指定范围:话题
可选
gid
string 
指定范围:小组
可选
includeSubgroups
integer 
可选
与 gid 配置使用,是否包含子级小组的内容
默认为 false
allDigest
integer 
可选
指定范围:全部精华,一级精华和二级精华
传参后,将忽略 digestState 参数
digestState
number 
可选
指定范围:精华(留空输出全部)
digest_state 字段 1.否 2.一级精华 3.二级精华
stickyState
number 
可选
指定范围:置顶(留空输出全部)
sticky_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
blockGroups
string 
可选
过滤小组,多个以英文逗号隔开
blockHashtags
string 
可选
过滤话题,多个以英文逗号隔开
whitelistKeys
string 
可选
白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
blacklistKeys
string 
可选
黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
pluginRatingId
number 
可选
排序编号(插件专用)
pageSize
number 
可选
每页显示条数(默认 15 条)
page
number 
页码(默认 1)
可选
Header 参数
X-Fresns-App-Id
string 
必需
密钥 App ID
密钥位置:控制面板->应用中心->应用密钥
默认值:
{{appId}}
X-Fresns-Client-Platform-Id
integer 
必需
平台编号,与密钥的「平台」匹配
默认值:
{{clientPlatformId}}
X-Fresns-Client-Version
string 
必需
你的客户端版本号,推荐使用语义化版本号
默认值:
{{clientVersion}}
X-Fresns-Client-Device-Info
string 
必需
交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参
默认值:
{{clientDeviceInfo}}
X-Fresns-Aid
string 
可选
账号参数(留空则视为未登录账号)
默认值:
{{aid}}
X-Fresns-Aid-Token
string 
可选
账号身份凭证(传参 aid 时必传)
默认值:
{{aidToken}}
X-Fresns-Uid
integer 
可选
用户参数(留空则视为未登录用户)
默认值:
{{uid}}
X-Fresns-Uid-Token
string 
可选
用户身份凭证(传参 uid 时必传)
默认值:
{{uidToken}}
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
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8080/api/v2/post/list?mapId=&mapLng=&mapLat=&uidOrUsername=&hid=&gid=&includeSubgroups=&allDigest=&digestState=&stickyState=&contentType=&createDate=&createDateGt=&createDateLt=&likeCountGt=&likeCountLt=&followCountGt=&followCountLt=&blockCountGt=&blockCountLt=&commentCountGt=&commentCountLt=&orderType=&orderDirection=&blockGroups=&blockHashtags=&whitelistKeys=&blacklistKeys=&pluginRatingId=&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 (Post) {58}] 
必需
示例
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                // 通用数据结构->帖子信息
            }
        ]
    }
}
上一页
获取话题互动的用户列表
下一页
获取关注对象的帖子列表
Built with