简要描述:
- 通知记录
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
2.1.0 | 毛成 | 2020-08-30 | xxxx-xx-xx |
请求URL:
请求方式:
- GET
请求参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
start | 否 | string | 开始时间 示例:2020-09-01 不传默认7天前 |
end | 否 | string | 结束时间 示例:2020-09-05 |
page | 否 | int | 分页 0开始 |
pageSize | 否 | int | 分页个数 |
from | 否 | string | 发送人id 或者用户名称 |
to | 否 | string | 接收人id 或者用户名称 |
keyword | 否 | string | 标题和内容关键词 |
belong_type | 否 | int | 通知类型 |
belong_type
0 本地圈点赞
1 本地圈回复
2 帖子点赞
3 帖子评论
4 关注
5 打赏
6 交友
7 帖子评论的赞
8 本地圈@某人通知
9 本地圈评论@某人通知
10 帖子@某人通知
11 帖子评论@某人通知
12 帖子楼中楼通知
当使用page进行分页时,我们还会在响应头中返回额外的分页基础数据:
- X-Pagination-Current-Page 指示当前返回的是第几页的数据
- X-Pagination-Per-Page 指示每页数据的条数
- X-Pagination-Page-Count 指示总页数
- X-Pagination-Total-Count 指示信息流总条数
请求示例
# GET请求
curl -X GET 'http://front.sapi.com/openapi/message/notice-list?start=1&from=0&to=&keyword=沈' \
-H 'Authorization: Bearer 5d39164d1f281' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
返回示例:
正确时返回:
{
"code": 0,
"text": "",
"data": [
{
"id": "625",
"user_id": "2521",
"friend_id": "225",
"belong_id": "203764",
"belong_type": 3,
"relation_id": "225576",
"title": "测试",
"content": "[quote][size=2][color=#999999]沈佳维2 发表于 2019-11-5 17:37[/color][/size]\n424324242[/quote]\n\nznjs",
"is_read": 1,
"created_at": "2019-11-14 07:57:14",
"is_delete": 0,
"user_name": "沈佳维2",
"friend_name": "vipwang"
},
{
"id": "624",
"user_id": "2521",
"friend_id": "225",
"belong_id": "203764",
"belong_type": 3,
"relation_id": "225575",
"title": "测试",
"content": "[quote][size=2][color=#999999]沈佳维2 发表于 2019-11-5 17:37[/color][/size]\n424324242[/quote]\n\nznjs",
"is_read": 1,
"created_at": "2019-11-14 06:29:46",
"is_delete": 0,
"user_name": "沈佳维2",
"friend_name": "vipwang"
},
{
"id": "623",
"user_id": "2521",
"friend_id": "225",
"belong_id": "203764",
"belong_type": 3,
"relation_id": "225572",
"title": "测试",
"content": "[quote][size=2][color=#999999]沈佳维2 发表于 2019-11-5 17:37[/color][/size]\n424324242[/quote]\n\nniubi",
"is_read": 1,
"created_at": "2019-11-14 02:47:07",
"is_delete": 0,
"user_name": "沈佳维2",
"friend_name": "vipwang"
},
{
"id": "622",
"user_id": "2521",
"friend_id": "225",
"belong_id": "203764",
"belong_type": 3,
"relation_id": "225571",
"title": "测试",
"content": "[quote][size=2][color=#999999]沈佳维2 发表于 2019-11-5 17:37[/color][/size]\n424324242[/quote]\n\nniubi",
"is_read": 1,
"created_at": "2019-11-14 02:46:25",
"is_delete": 0,
"user_name": "沈佳维2",
"friend_name": "vipwang"
}
],
"time": 1599096850
}
错误时返回:
{
"errcode": 500,
"errmsg": "invalid appid"
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
id | int | 消息id |
user_id | int | 用户接收者id |
friend_id | int | 操作用户id |
belong_id | int | 评论或赞的动态的id |
belong_type | int | 类别,本地圈点赞0, 本地圈评论1 帖子点赞2 帖子评论3 关注4 打赏5 交友6 7帖子评论的赞 8本地圈@ 9本地圈评论@ 10帖子@ 11帖子评论@ |
relation_id | int | 关联id,暂时仅是回复id |
title | string | 标题 |
content | string | 内容 |
is_delete | int | 是否已清除 |
user_name | string | 用户接收者名称 |
friend_name | string | 用户操作者名称 |
备注:
- 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2022-11-02 10:52 作者:李伟