MDClubAPI 文档

Notification:getList

注意：该接口需要登陆后才能调用。

获取通知列表。

HTTP 请求

GET /api/notifications

参数

参数名参数位置类型默认值说明
pagequeryinteger1

当前页数

per_pagequeryinteger15

每页条数（最大为 100）

includequerystring

响应中需要包含的关联数据，用 , 分隔。可以为 receiver, sender, article, question, answer, comment, reply

typequerystring

通知类型

取值范围包括：question_answered, question_commented, question_deleted, article_commented, article_deleted, answer_commented, answer_deleted, comment_replied, comment_deleted

readqueryboolean

默认包含已读和未读的通知。若 read 为 true，则仅包含已读的通知；若为 false，则仅包含未读的通知。

响应

通知列表

示例

{
  "code": 0,
  "data": [
    {
      "notification_id": 1,
      "receiver_id": 1,
      "sender_id": 2,
      "type": "question_answered",
      "article_id": 1,
      "question_id": 1,
      "answer_id": 1,
      "comment_id": 1,
      "reply_id": 1,
      "content_deleted": {
        "question_id": 1,
        "user_id": 1,
        "title": "请问作者开发了哪些软件？",
        "content_markdown": "如题",
        "content_rendered": "<p>如题</p>",
        "comment_count": 6,
        "answer_count": 18,
        "follower_count": 12,
        "vote_count": 44,
        "vote_up_count": 96,
        "vote_down_count": 52,
        "last_answer_time": 1563512214,
        "create_time": 1563512214,
        "update_time": 1563512214,
        "delete_time": 0,
      },
      "create_time": 1563512214,
      "read_time": 1563512214,
      "relationships": {
        "receiver": {
          "user_id": 1,
          "username": "zdhxiong",
          "headline": "mdui作者",
          "avatar": {
            "original": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
            "small": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_small.jpg",
            "middle": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_middle.jpg",
            "large": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_large.jpg"
          }
        },
        "sender": {
          "user_id": 1,
          "username": "zdhxiong",
          "headline": "mdui作者",
          "avatar": {
            "original": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
            "small": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_small.jpg",
            "middle": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_middle.jpg",
            "large": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_large.jpg"
          }
        },
        "article": {
          "article_id": 1,
          "title": "欢迎使用 MDClub 开源社区系统",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "question": {
          "question_id": 1,
          "title": "请问作者开发了哪些软件？",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "answer": {
          "answer_id": 1,
          "question_id": 1,
          "content_summary": "mdui 是目前最具有逻辑性、一致性、简洁性、高可用、且对规范实现的最好的 Material Design 框架。",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "comment": {
          "comment_id": 1,
          "content_summary": "mdui 是我见过的 Web 框架里对规范实现最好的一版了",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "reply": {
          "comment_id": 1,
          "content_summary": "mdui 是我见过的 Web 框架里对规范实现最好的一版了",
          "create_time": 1563512214,
          "update_time": 1563512214
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 15,
    "previous": null,
    "next": 2,
    "total": 124,
    "pages": 9
  }
}

参数说明

参数名 类型 说明
code integer

无任何错误时，状态码为 0
data[].notification_id integer

通知ID
data[].receiver_id integer

通知接收者ID
data[].sender_id integer

通知发送者ID
data[].type string

通知类型：

  • question_answered：有人对提问发表了回答。此时会包含 question_id、answer_id
  • question_commented：有人对提问发表了评论。此时会包含 question_id、comment_id
  • question_deleted：提问被删除。此时会包含 question_id，但 relationships 中将不存在 question，可从 content_deleted 字段中获取被删除的提问内容
  • article_commented：有人对文章发表了评论。此时会包含 article_id、comment_id
  • article_deleted：文章被删除。此时会包含 article_id，但 relationships 中将不存在 article，可从 content_deleted 字段中获取被删除的文章内容
  • answer_commented：有人对回答发表了评论。此时会包含 question_id、answer_id、comment_id
  • answer_deleted：回答被删除。此时会包含 answer_id、question_id，但 relationships 中将不包含 answer，可从 content_deleted 字段中获取被删除的回答内容
  • comment_replied：有人对评论发表了回复。此时会包含 reply_id、comment_id，额外的，评论属于提问时会包含 question_id，属于文章时会包含 article_id，属于回答时会包含 answer_id、question_id
  • comment_deleted：评论被删除。此时会包含 comment_id，但 relationships 中将不包含 comment，可从 content_deleted 字段中获取被删除的评论内容；额外的，评论属于提问时会包含 question_id，属于文章时会包含 article_id，属于回答时会包含 answer_id、question_id

取值范围包括：question_answered, question_commented, question_deleted, article_commented, article_deleted, answer_commented, answer_deleted, comment_replied, comment_deleted
data[].article_id integer

相关文章ID
data[].question_id integer

相关提问ID
data[].answer_id integer

相关回答ID
data[].comment_id integer

相关评论ID
data[].reply_id integer

相关回复ID
data[].content_deleted object

根据通知类型，此字段的值可以为以下对象之一：

参数名 类型 说明
question_id integer

提问ID
user_id integer

用户ID
title string

提问标题
content_markdown string

Markdown 格式的提问内容
content_rendered string

HTML 格式的提问内容
comment_count integer

评论数量
answer_count integer

回答数量
follower_count integer

关注者数量
vote_count integer

投票数（赞成票 - 反对票，可能为负数）
vote_up_count integer

赞成票总数
vote_down_count integer

反对票总数
last_answer_time integer

最后回答时间
create_time integer

创建时间
update_time integer

更新时间（更新提问本身，或在提问下发表回答，都会更新该字段）
delete_time integer

🔐删除时间
参数名 类型 说明
article_id integer

文章ID
user_id integer

用户ID
title string

文章标题
content_markdown string

Markdown 格式的文章内容
content_rendered string

HTML 格式的文章内容
comment_count integer

评论数量
follower_count integer

关注者数量
vote_count integer

投票数（赞成票 - 反对票，可能为负数）
vote_up_count integer

赞成票总数
vote_down_count integer

反对票总数
create_time integer

创建时间
update_time integer

更新时间（用户可以更新自己的文章）
delete_time integer

🔐删除时间
参数名 类型 说明
answer_id integer

回答ID
question_id integer

提问ID
user_id integer

用户ID
content_markdown string

markdown 格式的内容
content_rendered string

html 格式的内容
comment_count integer

评论数量
vote_count integer

投票数（赞成票 - 反对票，可能为负数）
vote_up_count integer

赞成票总数
vote_down_count integer

反对票总数
create_time integer

创建时间
update_time integer

更新时间
delete_time integer

🔐删除时间
参数名 类型 说明
comment_id integer

评论ID
commentable_id integer

评论目标的ID
commentable_type string

评论目标类型

取值范围包括：article, question, answer, comment
user_id integer

用户ID
content string

评论内容
vote_count integer

投票数（赞成票 - 反对票，可能为负数）
vote_up_count integer

赞成票总数
vote_down_count integer

反对票总数
create_time integer

发表时间
update_time integer

修改时间
delete_time integer

🔐删除时间
data[].create_time integer

通知发送时间
data[].read_time integer

通知阅读时间
data[].relationships.receiver.user_id integer

用户ID
data[].relationships.receiver.username string

用户名
data[].relationships.receiver.headline string

一句话介绍
data[].relationships.receiver.avatar.original string

头像原图地址
data[].relationships.receiver.avatar.small string

小头像地址
data[].relationships.receiver.avatar.middle string

中头像地址
data[].relationships.receiver.avatar.large string

大头像地址
data[].relationships.sender.user_id integer

用户ID
data[].relationships.sender.username string

用户名
data[].relationships.sender.headline string

一句话介绍
data[].relationships.sender.avatar.original string

头像原图地址
data[].relationships.sender.avatar.small string

小头像地址
data[].relationships.sender.avatar.middle string

中头像地址
data[].relationships.sender.avatar.large string

大头像地址
data[].relationships.article.article_id integer

文章ID
data[].relationships.article.title string

文章标题
data[].relationships.article.create_time integer

发布时间
data[].relationships.article.update_time integer

更新时间
data[].relationships.question.question_id integer

提问ID
data[].relationships.question.title string

提问标题
data[].relationships.question.create_time integer

发布时间
data[].relationships.question.update_time integer

更新时间
data[].relationships.answer.answer_id integer

回答ID
data[].relationships.answer.question_id integer

提问ID
data[].relationships.answer.content_summary string

内容摘要
data[].relationships.answer.create_time integer

发布时间
data[].relationships.answer.update_time integer

更新时间
data[].relationships.comment.comment_id integer

评论ID
data[].relationships.comment.content_summary string

内容摘要
data[].relationships.comment.create_time integer

发布时间
data[].relationships.comment.update_time integer

更新时间
data[].relationships.reply.comment_id integer

评论ID
data[].relationships.reply.content_summary string

内容摘要
data[].relationships.reply.create_time integer

发布时间
data[].relationships.reply.update_time integer

更新时间
pagination.page integer

当前页码
pagination.per_page integer

每页条数
pagination.previous integer

上一页页码，为 null 表示没有上一页
pagination.next integer

下一页页码，为 null 表示没有下一页
pagination.total integer

数据总数
pagination.pages integer

总页数