Plus (ThinkSNS+)

Plus (ThinkSNS+)

  • 文档 [New]
  • 文档
  • REST API v2
  • 反馈
  • GitHub

›基本

基本

  • 概述
  • 启动信息
  • Json Web Token 授权
  • 验证码
  • 位置
  • 标签
  • 消息通知
  • 钱包(旧版本)
  • Plus Pay(新钱包-支付工具)
  • 支付能力
  • 文件
  • 关于我们
  • 广告
  • 举报
  • 积分
  • 环信
  • 评论
  • 文件存储

用户

  • 用户
  • 注册
  • 收到的评论
  • 收到的喜欢
  • 关注
  • 标签
  • 身份认证
  • 找人
  • 排行榜
  • 反馈
  • 打赏用户
  • 未读消息
  • 签到
  • 消息

动态

  • 发布动态
  • 获取动态
  • 删除动态
  • 设置评论收费
  • 评论
  • 喜欢
  • 收藏
  • 置顶
  • 打赏
  • 排行榜
  • 举报
  • 积分部分新增接口
  • 话题

音乐

  • 音乐
  • 专辑
  • 点赞
  • 评论
  • 收藏

问答

  • 概述
  • 话题
  • 问题
  • 评论
  • 回答
  • 回答 · 打赏
  • 回答 · 围观
  • 用户 · 关注问题
  • 用户 · 喜欢回答
  • 用户 · 收藏回答
  • 用户 · 申请精选
  • 排行榜
  • 举报
  • 问答部分积分相关新增接口

资讯

  • 概述
  • 分类
  • 投稿
  • 获取
  • 评论
  • 喜欢
  • 打赏
  • 置顶
  • 收藏
  • 排行榜
  • 举报
  • 资讯部分积分相关新增接口

圈子

  • 概述
  • 分类
  • 圈子
  • 圈子 · 管理
  • 圈子 · 举报
  • 圈子 · 成员
  • 帖子
  • 帖子 · 评论
  • 帖子 · 喜欢
  • 帖子 · 收藏
  • 帖子 · 打赏
  • 帖子 · 置顶
  • 圈子部分积分相关新增接口
Edit

消息通知

对用户发送通知时,如果配置了推送证书,将会产生推送,推送消息为通知内容,extras字段内容为通知的频道标识,如:

{
    "extras":{"channel":"news:comment"}
}
  • 未读通知数量检查
  • 通知列表
  • 读取通知
  • 标记通知阅读
  • 标记所有通知已读
  • 数据解析

未读通知数量检查

HEAD /user/notifications

本接口可用于消息分组显示的客户端,可以提前得到未读消息数量,然后将 Unread-Notification-Limit 拼接为 limit 参数,type 设置为 unread 得到全部未读消息。

查看 通知列表 请求头

通知列表

GET /user/notifications

Parameters

名称类型描述
limitInteger获取条数,默认 20
offsetInteger数据偏移量,默认 0
typeString获取通知类型,可选 all,read,unread 默认 all
notificationString,Array检索具体通知,可以是由 , 拼接的 IDs 组,也可以是 Array

Response

Status: 200 OK
Unread-Notification-Limit: 10
[
    // ...
    {
        "id": "98aaae93-9d9e-446e-b894-691569b686b5",
        "read_at": null,
        "data": {
            "channel": "feed:pinned",
            "target": 1,
            "content": "我是测试消息",
            "extra": []
        },
        "created_at": "2017-07-10 04:23:08"
    }
]

Unread-Notification-Limit 为当前用户未读消息数量。 详情数据结构参考数据解析

读取通知

GET /user/notifications/:notification

Response

Status: 200 OK
{
    "id": "98aaae93-9d9e-446e-b894-691569b686b5",
    "read_at": "2017-07-10 09:31:04",
    "data": {
        "channel": "feed:pinned",
        "target": 1,
        "content": "我是测试消息",
        "extra": []
    },
    "created_at": "2017-07-10 04:23:08"
}

读取通知详情,会使这条通知状态变为已读状态。

标记通知阅读

PATCH /user/notifications/:notification?

notification 为可选,为单条标记提供快捷而已。

Parameters

名称类型描述
notificationString\Array通知ID,可以是由 , 拼接的 IDs 组,也可以是 Array

Response

Status: 201 Created
{
    "message": [
        "操作成功"
    ]
}

标记所有通知已读

PUT /user/notifications/all

Response

Status: 201 Created
{
    "message": [
        "操作成功"
    ]
}

数据解析

Example:

{
    "id": "98aaae93-9d9e-446e-b894-691569b686b5",
    "read_at": null,
    "data": {
        "channel": "feed:pinned-comment",
        "target": 1,
        "content": "我是测试消息",
        "extra": []
    },
    "created_at": "2017-07-10 04:23:08"
}

id

通知ID

read_at

消息阅读时间,如果是未读消息,则值为 null

created_at

消息创建时间

data

消息数据详情

channel

通知来源频道,客户端需要根据 data.channel 值进行独立解析。已知频道:

  • feed:comment 动态被评论
  • feed:reply-comment 动态评论被回复
  • feed:pinned-comment 动态评论申请置顶
  • feed:digg 动态被点赞
target

根据 data.channel 的目标标识,例如 channel=feed:comment 则表示 target 为 动态 ID。

content

消息内容

extra

为 Array|Object 类型,来自 channel 标识的额外数据,具体参见不同标识详情进行解析使用。

← 标签钱包(旧版本) →
  • 未读通知数量检查
  • 通知列表
    • Parameters
  • 读取通知
  • 标记通知阅读
    • Parameters
  • 标记所有通知已读
  • 数据解析
Plus (ThinkSNS+)
More
GitHubStar
Copyright © 2019 Chengdu ZhiYiChuangXiang Technology Co., Ltd. All rights reserved.