Help Center/KooDrive/API Reference（Carrier）/API/Notification Management/Querying Unread Notifications
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Querying Unread Notifications

Function

Query unread notifications.

URI

GET /koodrive/ose/v1/notification/getUnread

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

messageType

Yes

Long

Definition:

Type of the notification to be queried.

0: all notifications 1: notifications of deleting shared folders

Constraints:

Currently, only notifications of deleting shared folders can be queried.

Range:

0,1

Default Value:

N/A

pageSize

Yes

Integer

Definition:

Number of records queried at a time.

Constraints:

N/A

Range:

1~100

Default Value:

N/A

cursor

No

String

Definition:

Pagination cursor.

When the API is called for the first time, the API returns nextCursor. Set this parameter to nextCursor to query notifications on the next page.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication.

Constraints:

The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z.

Range:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tenantId

String

Current tenant ID.

notifications

Array of GetNotificationInfo objects

Notification list.

nextCursor

String

Next page cursor.

code

Integer

Response code.

msg

String

Response.

Table 4 GetNotificationInfo

Parameter

Type

Description

messageType

Long

Message type. Currently, the message type can only be 1, indicating that a shared folder is deleted.

ownerId

Long

ID of the user to be notified.

info

Object

Notification content.

Example Requests

GET /koodrive/ose/v1/notification/getUnread

param: messageType=1&pageSize=100

Example Responses

Status code: 200

Notification content.

{
  "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"
    }
  } ]
}

Status Codes

Status Code

Description

200

Notification content.