更新时间:2024-10-25 GMT+08:00
分享

获取消息列表

功能介绍

获取当前用户的消息列表

URI

GET /koodrive/ose/v1/message/list

表1 Query参数

参数

是否必选

参数类型

描述

pageSize

Integer

每页返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果

pageCursor

String

当前页游标,由前一个响应的nextCursor获取,默认为0

filterType

String

过滤类型。

000:分享消息;

001:团队消息;

002:系统消息;

003:管理消息

state

Integer

消息状态。0:未读;1:已读

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

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

language

String

国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

nextCursor

String

分页游标,如果不存在,代表已返回最后一个

messages

MessageInfo object

消息对象

表4 MessageInfo

参数

参数类型

描述

id

String

消息ID

sender

String

消息发送方

type

String

消息类型

context

String

消息内容

state

Integer

消息状态

createTime

String

消息接收时间

请求示例

响应示例

状态码

状态码

描述

200

获取消息列表响应体。

相关文档