Bot(Oicq) API
<h1>Bot(Oicq) API</h1>
<p>KiviBot 框架基于 icqq/OICQ，在插件中可以通过 <code>ctx.bot</code> 访问 OICQ 的完整 API。具体参考:</p>
<ul>
<li><a href="https://icqq.pages.dev/"><code>icqq</code> 文档</a></li>
<li><a href="https://oicqjs.github.io/oicq/classes/Client.html"><code>oicq v2</code> 文档</a> - 官方文档</li>
<li><a href="https://ltxhhz.github.io/oicq-wiki/api/%E5%BA%94%E7%94%A8%E7%B1%BBapi.html"><code>oicq</code> 带注解文档</a> - 中文详解(旧版)</li>
</ul>
<p>> ⚠️ 注意：旧版文档中的 CQCode 已弃用，请使用 segment 代替。</p>
<h2>示例</h2>
<p>typescript</p>
<pre><code>import { definePlugin } from &quot;kivibot&quot;;
export default definePlugin({
name: &quot;demo&quot;,
version: &quot;1.0.0&quot;,
async setup(ctx) {
// ctx.bot 即为 OICQ Client 实例
// 发送私聊消息
ctx.bot.sendPrivateMsg(1234567, &quot;Hello&quot;);
// 获取好友列表
const friendList = ctx.bot.getFriendList();
// 处理群消息
ctx.handle(&quot;message.group&quot;, (e) =&gt; {
// 使用 OICQ API
const groupInfo = ctx.bot.getGroupInfo(e.group_id);
console.log(groupInfo);
});
},
});</code></pre>
<p>更多 API 用法请参考 OICQ 文档。</p>