更新时间:2026-02-03 GMT+08:00

查询未读通知 - GetUnreadNotification

功能介绍

查询未读通知

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/notification/getUnread

表1 Query参数

参数

是否必选

参数类型

描述

messageType

Long

参数解释:

查询的通知类型

0: 所有通知 1: 删除共享文件夹通知

约束限制:

目前只支持查询 删除共享文件夹通知

取值范围:

0,1

默认取值:

不涉及

pageSize

Integer

参数解释:

一次查询的数量

约束限制:

不涉及

取值范围:

1~100

默认取值:

不涉及

cursor

String

参数解释:

分页的游标

首次调用,接口返回nextCursor,将nextCursor赋给该参数以查询下一页的通知

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token}

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Traceid

String

参数解释:

业务跟踪id(必须58位)

约束限制:

不涉及

取值范围:

长度为58位

默认值:

不涉及

language

String

参数解释:

国际化语言标识

约束限制:

符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语

取值范围:

符合i18n规范

默认取值:

en-US

X-User-Id

String

参数解释:

KooDrive侧用户id,用于app鉴权

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Date

String

参数解释:

日期,用于app鉴权

约束限制:

日期格式:yyyyMMDD'T'HHmmss'Z' ; 例如20251103T070140Z

取值范围:

距当前时间15分钟以内,不能晚于当前时间

默认值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

tenantId

String

当前的租户ID

notifications

Array of GetNotificationInfo objects

通知列表

nextCursor

String

下一页游标

code

Integer

响应码

msg

String

响应信息

表4 GetNotificationInfo

参数

参数类型

描述

messageType

Long

消息类型 目前只有 1: 删除共享文件夹通知

ownerId

Long

通知对应的用户ID

info

Object

通知内容

请求示例

GET /koodrive/ose/v1/notification/getUnread

param: messageType=1&pageSize=100

响应示例

状态码:200

通知内容

{
  "code" : 0,
  "msg" : "success",
  "tenantId" : "42d35c25d3e94b679f0116ff580bd7dc",
  "nextCursor" : "100",
  "notifications" : [ {
    "id" : 1760107780892534800,
    "messageType" : 1,
    "ownerId" : 1720340043077429800,
    "info" : {
      "shareFolderId" : "FvFwd6mWjDY8D6v4ICj1AFKuM19KLoFyP",
      "name" : "liu22"
    }
  }, {
    "id" : 1760215471786829800,
    "messageType" : 1,
    "ownerId" : 1720340043077429800,
    "info" : {
      "shareFolderId" : "FnjDDr3cUVWhaP28h8UFIDIngCZeZFwRo",
      "name" : "ABCD"
    }
  } ]
}

状态码

状态码

描述

200

通知内容