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

[通知]获取消息列表

开发中
GET
http://localhost:8080/api/v2/notification/list
types 留空输出全部,传参支持多个,以英文逗号隔开。
按时间倒序排列,最新的在前面。
系统消息解读:
types=1 代表系统给你发了一条 content 消息内容
isAccessPlugin 是否访问插件页
actionUser 是否有触发用户
actionObject + actionInfo 是否有附带内容
推荐消息解读:
types=2 代表系统给你推荐了内容
content 推荐语
isAccessPlugin 是否访问插件页
actionUser 是否有触发用户
actionObject + actionInfo 推荐的内容
互动消息解读:
types=3 代表 actionUser 点赞了你的 actionObject + actionInfo
types=4 代表 actionUser 踩了你的 actionObject + actionInfo
types=5 代表 actionUser 关注了你的 actionObject + actionInfo
types=6 代表 actionUser 屏蔽了你的 actionObject + actionInfo
types=7 代表 actionUser 在 actionObject + actionInfo 中提及了你
content 提及内容的摘要
types=8 代表 actionUser 评论了你的 actionObject + actionInfo
content 评论内容的摘要
actionCid 他的评论 cid
触发行为 actionType 类型介绍:
1.点赞
2.点踩
3.关注
4.屏蔽
5.发表
6.编辑
7.删除
8.置顶
9.设精
10.管理

请求参数

Query 参数
types
string 
可选
系统通知 2 推荐内容 3 点赞 4 踩 5 关注 6 屏蔽 7 提及(艾特) 8 评论(回复)
status
integer 
可选
0 未读
1 已读
留空输出全部
userWhitelistKeys
string 
可选
白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 actionUser 参数有效
userBlacklistKeys
string 
可选
黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 actionUser 参数有效
whitelistKeys
string 
可选
白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 actionInfo 参数有效
blacklistKeys
string 
可选
黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
仅对 actionInfo 参数有效
pageSize
string 
可选
每页显示条数(默认 15 条)
page
string 
页码(默认 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/notification/list?types=&status=&userWhitelistKeys=&userBlacklistKeys=&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) 
必需
list2
array [object {14}] 
必需
示例
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / 一共有多少条数据",
            "pageSize": "Number / 每页有多少条数据",
            "currentPage": "Number / 当前页码",
            "lastPage": "Number / 最后一页页码"
        },
        "list": [
            {
                "id": "Number / 通知 ID",
                "type": "Number / 通知类型",
                "content": "String / 通知内容",
                "isMarkdown": "Boolean / 内容是否为 Markdown 格式",
                "isAccessPlugin": "Boolean / 是否访问插件页",
                "pluginUrl": "String / 插件页地址",
                "actionUser": {
                    // 触发消息的用户信息
                    // 通用数据结构->用户信息
                },
                "actionType": "Number / 触发行为类型",
                "actionObject": "Number / 触发目标",
                "actionInfo": {
                    // 触发关联内容(通用数据结构)
                    // actionObject=1  用户信息
                    // actionObject=2  小组信息
                    // actionObject=3  话题信息
                    // actionObject=4  帖子信息
                    // actionObject=5  评论信息
                },
                "actionCid": "String / 评论事件的 cid",
                "datetime": "String / 通知时间",
                "datetimeFormat": "String / 通知时间格式化",
                "readStatus": "Boolean / 阅读状态"
            }
        ]
    }
}
上一页
标记备注
下一页
[通知]更新阅读状态
Built with