diff --git a/docs/api/message.md b/docs/api/message.md index 3ec2853..889b8a9 100644 --- a/docs/api/message.md +++ b/docs/api/message.md @@ -139,6 +139,60 @@ icon: comment 该接口将返回处理结果,其中 `data` 字段无数据。。 +## 获取历史消息 + +### API 端点 + +`/get_history_msg` + +### 参数 + +| 字段 | 类型 | 必须 | 说明 | +| ---------- | ----- | ---- | ------- | +| message_type | string | 是 | 消息 类型 | +| user_id | int64 | 否 | 私聊QQ | +| group_id | int64 | 否 | 群号 | +| count | int32 | 否 | 获取的消息数量(默认为20)| + +### 响应 + +| 字段 | 类型 | 说明 | +| ------------ | ------------------------- | ---------- | +| messages | Message[] | 消息集 | + +#### Message + +| 字段 | 类型 | 说明 | +| ------------ | ------------------------- | ---------- | +| time | int64 | 时间戳 | +| message_type | string | 消息类型 | +| message_id | int32 | 消息 ID | +| real_id | int32 | 真实 ID | +| sender | Object<[Sender](#sender)> | 发送人信息 | +| message | object | 消息体 | +| group_id | int64 | 群号 | +| target_id | int64 | 消息目标(私聊) | +| peer_id | int64 | 消息接收者,群聊是群号,私聊时是目标QQ | + +> `peer_id`是其他同类框架所表达的`target_id`! + +### API 端点 + +`/get_group_msg_history` + +### 参数 + +| 字段 | 类型 | 必须 | 说明 | +| ---------- | ----- | ---- | ------- | +| group_id | int64 | 是 | 群号 | +| count | int32 | 否 | 获取的消息数量(默认为20)| + +### 响应 + +| 字段 | 类型 | 说明 | +| ------------ | ------------------------- | ---------- | +| messages | Message[] | 消息集 | + ## 清除本地缓存消息 该接口用于撤回消息。