Skip to content

通知 - 私信 ​

登录后调用此接口 ,可获取私信

接口信息 ​

项目值
接口地址/msg/private
请求方式GET / POST
需要登录是
对应模块msg_private
文档分类社交与消息

请求参数 ​

参数类型必填默认值说明
limitnumber | string—30返回数量,默认为 30
offsetnumber | string—0偏移数量,用于分页,如:(页数 - 1)*30, 其中 30 为 limit 的值,默认为 0

HTTP 示例 ​

bash
GET /msg/private?limit=3

编程式调用 ​

ts
import { msgPrivate } from 'hana-music-api';

const result = await msgPrivate({
  limit: '3',
});

console.log(result.body);

返回内容 ​

body.msgs 是私信会话列表,每个会话只收紧自己的编号 msgs[].user.id;会话双方 fromUser、toUser 是附带资料,复用 UserProfile 的字段但把 userId 放宽,另补 expertTags,整个对象按宽松字段处理。lastMsg 是最后一条消息的 JSON 字符串,lastMsgId、lastMsgTime、msgSenderType、newMsgCount、noticeAccountFlag、more 都宽松。offset 越界时返回空数组;未登录时上游返回 code: 200 和空会话列表。结构定义和类型是 MsgPrivateBody。

补充说明 ​

说明 : 登录后调用此接口 ,可获取私信

可选参数 :

limit : 返回数量,默认为 30

offset : 偏移数量,用于分页,如:(页数 - 1)*30, 其中 30 为 limit 的值,默认为 0

接口地址 : /msg/private

调用例子 : /msg/private?limit=3

Released under the MIT License.