GET 通知列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/notice |
| 所属业务 | 消息通知 |
| 来源模块/系统 | 消息通知 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
通知列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字搜索 搜索范围:标题 内容 |
| read | query | integer(int32) | 否 | 是否已读 0未读 1已读 |
| type | query | string | 否 | 消息类型 idcsmart官方通知 system系统通知 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序字段 默认id |
| sort | query | string | 否 | 排序 desc asc |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | — |
data.list[].id | integer(int32) | 否 | — | ID |
data.list[].title | string | 否 | — | 标题 |
data.list[].content | string | 否 | — | 内容 |
data.list[].attachment | string | 否 | — | 附件 逗号分隔 |
data.list[].accept_time | integer(int32) | 否 | — | 接收时间 |
data.list[].read | integer(int32) | 否 | — | 是否已读 1是 0否 |
data.list[].type | string | 否 | — | 消息类型 idcsmart官方通知 system系统通知 |
data.list[].rel_id | integer(int32) | 否 | — | 关联ID 消息类型是idcsmart时表示官方消息ID |
data.list[].priority | integer(int32) | 否 | — | — |
data.list[].create_time | integer(int32) | 否 | — | — |
data.list[].update_time | integer(int32) | 否 | — | — |
data.list[].is_delete | integer(int32) | 否 | — | — |
data.list[].delete_time | integer(int32) | 否 | — | — |
data.count | integer(int32) | 否 | — | 总数 |
data.total_count | integer(int32) | 否 | — | 所有消息未读总数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |