diff --git a/docs/api/message.md b/docs/api/message.md index 156bb58..456360f 100644 --- a/docs/api/message.md +++ b/docs/api/message.md @@ -267,3 +267,112 @@ icon: comment "echo": "" } ``` + +## 发送群聊合并转发 + +发送群聊合并转发。 + +### API 端点 + +`/send_group_forward_msg` + +### 参数 + +| 字段 | 类型 | 必须 | 说明 | +| ---------- | ----- | ---- | ------- | +| group_id | int64 | 是 | 发送到的目标群号 | +| message | foward message[] | 合并转发消息集 | + +### 响应 + +该接口将返回处理结果,其中 `data` 字段无数据。 + +### 示例 + +直接引用消息的合并转发,id为`消息id`: + +```json +[ + { + "type": "node", + "data": { + "id": "123" + } + }, + { + "type": "node", + "data": { + "id": "456" + } + } +] +``` + +自定义消息合并转发: + +```json +[ + { + "type": "node", + "data": { + "name": "消息发送者A", + "content": [ + { + "type": "text", + "data": { + "text": "测试消息1" + } + } + ] + } + }, + { + "type": "node", + "data": { + "name": "消息发送者B", + "content": "[CQ:image,file=xxxxx]测试消息2" + } + } +] +``` + +引用自定义混合合并转发: + +```json +[ + { + "type": "node", + "data": { + "name": "自定义发送者", + "content": "我是自定义消息", + } + }, + { + "type": "node", + "data": { + "id": "123" + } + } +] +``` + +> 由于QQ限制,该接口不提供合并转发后的消息ID以及合并转发ID。 + +## 发送私聊合并转发 + +发送私聊合并转发。 + +### API 端点 + +`/send_private_forward_msg` + +### 参数 + +| 字段 | 类型 | 必须 | 说明 | +| ---------- | ----- | ---- | ------- | +| user_id | int64 | 是 | 发送到的目标QQ | +| message | foward message[] | 合并转发消息集 | + +### 响应 + +该接口将返回处理结果,其中 `data` 字段无数据。 \ No newline at end of file