Updated on 2025-08-28 GMT+08:00

Listing Messages

Function

List messages.

URI

GET /koodrive/ose/v1/message/list

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

pageSize

No

Integer

Number of records to be returned on each page. Default and maximum value: 100. It is possible that partial or empty result pages are returned before the end of the result list has been reached.

pageCursor

No

String

Current page cursor, which is obtained from nextCursor of the previous response. Default value: 0.

filterType

No

String

Filter type.

000: sharing messages.

001: team messages.

002: system messages.

003: management messages.

state

No

Integer

Message status. 0: unread; 1: read.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

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}.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

X-User-Id

Yes

String

User ID, which is used for app authentication.

X-Date

Yes

String

Date, which is used for app authentication.

Host

Yes

String

Address, which is used for app authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

nextCursor

String

Pagination cursor. If the cursor does not exist, the last record has been returned.

messages

MessageInfo object

Message object.

Table 4 MessageInfo

Parameter

Type

Description

id

String

Message ID.

sender

String

Message sender.

type

String

Message type.

context

String

Message body.

state

Integer

Message status.

createTime

String

Message receiving time.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response body for obtaining the message list.