diff --git a/docs/Lagrange.OneBot/API/Extend/index.md b/docs/Lagrange.OneBot/API/Extend/index.md index 235efea7..b4c815e5 100644 --- a/docs/Lagrange.OneBot/API/Extend/index.md +++ b/docs/Lagrange.OneBot/API/Extend/index.md @@ -1 +1,52 @@ -# 拓展API \ No newline at end of file +# 拓展API + +## 构造合并转发消息 + +**方法名**: +`send_forward_msg` + +**参数** + +| 字段 | 类型 | 说明 | +| --- | --- | --- | +| `messages` | list[OneBotSegment.node] | 参考下方 | + +其中`OneBotSegment.node`的`data`部分要求如下 + +| 字段 | 类型 | 说明 | +| --- | --- | --- | +| `name` | string | 自定义消息发送者昵称 | +| `uin` | string | 自定义消息发送者QQ号 | +| `content` | list[OneBotSegment] | 消息内容 | + +**响应数据** + +| 字段 | 类型 | 说明 | +| --- | --- | --- | +| `resid` | string | Resid | + +:::tip +**发送合并转发消息** + +请使用标准消息发送API发送一个`"type": "forward", "id": Resid`的`OneBotSegment`消息 + + +**参考代码** + +::: code-group + +```python{10-11} [Nonebot OneBot V11] +from nonebot.adapters.onebot.v11 import MessageSegment + +async def test_send_forward_message(target_id: int): + messages = [ + { + "type": "node", + "data": {"name": "小助手", "uin": "2854196310", "content": [MessageSegment.text("测试消息")]}, + } + ] + res_id = await bot.call_api("send_forward_msg", messages=messages) + await bot.send_group_msg(group_id=target_id, message=MessageSegment.forward(res_id)) +``` + +:::