@mrlingxd/koishi-plugin-adapter-onebot 0.1.0

package/lib/utils.js

@@ -0,0 +1,297 @@
+import { h, hyphenate, omit } from "koishi";
+import * as qface from "qface";
+import { CQCode } from "./bot";
+export * from "./types";
+export const decodeUser = (user) => ({
+    id: user.tiny_id || user.user_id.toString(),
+    name: user.nickname,
+    userId: user.tiny_id || user.user_id.toString(),
+    avatar: user.user_id ? `http://q.qlogo.cn/headimg_dl?dst_uin=${user.user_id}&spec=640` : undefined,
+    username: user.nickname
+});
+export const decodeGuildMember = (user) => ({
+    user: decodeUser(user),
+    nick: user.card,
+    roles: [user.role]
+});
+export const adaptQQGuildMemberInfo = (user) => ({
+    user: {
+        id: user.tiny_id,
+        name: user.nickname,
+        isBot: user.role_name === "机器人"
+    },
+    name: user.nickname,
+    roles: user.role_name ? [user.role_name] : []
+});
+export const adaptQQGuildMemberProfile = (user) => ({
+    user: {
+        id: user.tiny_id,
+        name: user.nickname,
+        isBot: user.roles?.some((r) => r.role_name === "机器人")
+    },
+    name: user.nickname,
+    roles: user.roles?.map((r) => r.role_name) || []
+});
+export async function adaptMessage(bot, data, message = {}, payload = message) {
+    message.id = message.messageId = data.message_id.toString();
+    // message content
+    const chain = CQCode.parse(data.message);
+    if (bot.config.advanced.splitMixedContent) {
+        chain.forEach((item, index) => {
+            if (item.type !== "image")
+                return;
+            const left = chain[index - 1];
+            if (left && left.type === "text" && left.attrs.content.trimEnd() === left.attrs.content) {
+                left.attrs.content += " ";
+            }
+            const right = chain[index + 1];
+            if (right && right.type === "text" && right.attrs.content.trimStart() === right.attrs.content) {
+                right.attrs.content = " " + right.attrs.content;
+            }
+        });
+    }
+    message.elements = h.transform(chain, {
+        at(attrs) {
+            if (attrs.qq !== "all")
+                return h.at(attrs.qq, { name: attrs.name });
+            return h("at", { type: "all" });
+        },
+        face({ id }) {
+            const name = qface.get(id)?.QDes.slice(1);
+            return h("face", { id, name, platform: bot.platform }, [h.image(qface.getUrl(id))]);
+        },
+        image(attrs) {
+            return h("img", {
+                src: attrs.url || attrs.file,
+                ...omit(attrs, ["url"])
+            });
+        },
+        record(attrs) {
+            return h("audio", {
+                src: attrs.url || attrs.file,
+                ...omit(attrs, ["url"])
+            });
+        },
+        video(attrs) {
+            return h("video", {
+                src: attrs.url || attrs.file,
+                ...omit(attrs, ["url"])
+            });
+        },
+        file(attrs) {
+            return h("file", {
+                src: attrs.url || attrs.file,
+                ...omit(attrs, ["url"])
+            });
+        }
+    });
+    const [guildId, channelId] = decodeGuildChannelId(data);
+    if (message.elements[0]?.type === "reply") {
+        const reply = message.elements.shift();
+        message.quote = await bot.getMessage(channelId, reply.attrs.id).catch((error) => {
+            bot.logger.warn(error);
+            return undefined;
+        });
+    }
+    message.content = message.elements.join("");
+    if (!payload)
+        return message;
+    payload.user = decodeUser(data.sender);
+    payload.member = decodeGuildMember(data.sender);
+    payload.timestamp = data.time * 1000;
+    payload.guild = guildId && { id: guildId };
+    payload.channel = channelId && {
+        id: channelId,
+        type: guildId ? 0 /* Universal.Channel.Type.TEXT */ : 1 /* Universal.Channel.Type.DIRECT */
+    };
+    return message;
+}
+const decodeGuildChannelId = (data) => {
+    if (data.guild_id) {
+        return [data.guild_id, data.channel_id];
+    }
+    else if (data.group_id) {
+        return [data.group_id.toString(), data.group_id.toString()];
+    }
+    else {
+        return [undefined, "private:" + data.sender.user_id];
+    }
+};
+export const adaptGuild = (info) => {
+    if (info.guild_id) {
+        const guild = info;
+        return {
+            id: guild.guild_id,
+            name: guild.guild_name
+        };
+    }
+    else {
+        const group = info;
+        return {
+            id: group.group_id.toString(),
+            name: group.group_name
+        };
+    }
+};
+export const adaptChannel = (info) => {
+    if (info.channel_id) {
+        const channel = info;
+        return {
+            id: channel.channel_id,
+            name: channel.channel_name,
+            type: 0 /* Universal.Channel.Type.TEXT */
+        };
+    }
+    else {
+        const group = info;
+        return {
+            id: group.group_id.toString(),
+            name: group.group_name,
+            type: 0 /* Universal.Channel.Type.TEXT */
+        };
+    }
+};
+export async function dispatchSession(bot, data) {
+    if (data.self_tiny_id) {
+        // don't dispatch any guild message without guild initialization
+        bot = bot["guildBot"];
+        if (!bot)
+            return;
+    }
+    const session = await adaptSession(bot, data);
+    if (!session)
+        return;
+    session.setInternal("onebot", data);
+    bot.dispatch(session);
+}
+export async function adaptSession(bot, data) {
+    const session = bot.session();
+    session.selfId = data.self_tiny_id ? data.self_tiny_id : "" + data.self_id;
+    session.type = data.post_type;
+    if (data.post_type === "message" || data.post_type === "message_sent") {
+        await adaptMessage(bot, data, (session.event.message = {}), session.event);
+        if (data.post_type === "message_sent" && !session.guildId) {
+            session.channelId = "private:" + data.target_id;
+        }
+        session.type = "message";
+        session.subtype = data.message_type === "guild" ? "group" : data.message_type;
+        session.isDirect = data.message_type === "private";
+        session.subsubtype = data.message_type;
+        return session;
+    }
+    session.subtype = data.sub_type;
+    if (data.user_id)
+        session.userId = "" + data.user_id;
+    if (data.group_id)
+        session.guildId = session.channelId = "" + data.group_id;
+    if (data.guild_id)
+        session.guildId = "" + data.guild_id;
+    if (data.channel_id)
+        session.channelId = "" + data.channel_id;
+    if (data.target_id)
+        session["targetId"] = "" + data.target_id;
+    if (data.operator_id)
+        session.operatorId = "" + data.operator_id;
+    if (data.message_id)
+        session.messageId = "" + data.message_id;
+    if (data.post_type === "request") {
+        session.content = data.comment;
+        session.messageId = data.flag;
+        if (data.request_type === "friend") {
+            session.type = "friend-request";
+            session.channelId = `private:${session.userId}`;
+        }
+        else if (data.sub_type === "add") {
+            session.type = "guild-member-request";
+        }
+        else {
+            session.type = "guild-request";
+        }
+    }
+    else if (data.post_type === "notice") {
+        switch (data.notice_type) {
+            case "group_recall":
+                session.type = "message-deleted";
+                session.subtype = "group";
+                break;
+            case "friend_recall":
+                session.type = "message-deleted";
+                session.subtype = "private";
+                session.channelId = `private:${session.userId}`;
+                break;
+            // from go-cqhttp source code, but not mentioned in official docs
+            case "guild_channel_recall":
+                session.type = "message-deleted";
+                session.subtype = "guild";
+                break;
+            case "friend_add":
+                session.type = "friend-added";
+                break;
+            case "group_admin":
+                session.type = "guild-member";
+                session.subtype = "role";
+                break;
+            case "group_ban":
+                session.type = "guild-member";
+                session.subtype = "ban";
+                break;
+            case "group_decrease":
+                session.type = session.userId === session.selfId ? "guild-deleted" : "guild-member-removed";
+                session.subtype = session.userId === session.operatorId ? "active" : "passive";
+                break;
+            case "group_increase":
+                session.type = session.userId === session.selfId ? "guild-added" : "guild-member-added";
+                session.subtype = session.userId === session.operatorId ? "active" : "passive";
+                break;
+            case "group_card":
+                session.type = "guild-member-updated";
+                session.subtype = "nickname";
+                break;
+            case "notify":
+                session.type = "notice";
+                session.subtype = hyphenate(data.sub_type);
+                if (session.subtype === "poke") {
+                    session.channelId ||= `private:${session.userId}`;
+                }
+                else if (session.subtype === "honor") {
+                    session.subsubtype = hyphenate(data.honor_type);
+                }
+                break;
+            case "message_reactions_updated":
+                session.type = "onebot";
+                session.subtype = "message-reactions-updated";
+                break;
+            case "channel_created":
+                session.type = "onebot";
+                session.subtype = "channel-created";
+                break;
+            case "channel_updated":
+                session.type = "onebot";
+                session.subtype = "channel-updated";
+                break;
+            case "channel_destroyed":
+                session.type = "onebot";
+                session.subtype = "channel-destroyed";
+                break;
+            // https://github.com/koishijs/koishi-plugin-adapter-onebot/issues/33
+            // case 'offline_file':
+            //   session.elements = [h('file', data.file)]
+            //   session.type = 'message'
+            //   session.subtype = 'private'
+            //   session.isDirect = true
+            //   session.subsubtype = 'offline-file-added'
+            //   break
+            // case 'group_upload':
+            //   session.elements = [h('file', data.file)]
+            //   session.type = 'message'
+            //   session.subtype = 'group'
+            //   session.subsubtype = 'guild-file-added'
+            //   break
+            default:
+                return;
+        }
+    }
+    else
+        return;
+    return session;
+}

package/lib/ws.d.ts

@@ -0,0 +1,33 @@
+import { WebSocketLayer } from "@koishijs/plugin-server";
+import { Adapter, Context, HTTP, Logger, Schema, Universal } from "koishi";
+import { OneBotBot } from "./bot";
+interface SharedConfig<T = "ws" | "ws-reverse"> {
+    protocol: T;
+    responseTimeout?: number;
+}
+export declare class WsClient<C extends Context = Context> extends Adapter.WsClient<C, OneBotBot<C, any>> {
+    fork(ctx: C, bot: OneBotBot<C, OneBotBot.BaseConfig & WsClient.Options>): Promise<void>;
+    accept(socket: Universal.WebSocket): void;
+    prepare(): any;
+    disconnect(bot: OneBotBot<C>): Promise<void>;
+}
+export declare namespace WsClient {
+    interface Options extends SharedConfig<"ws">, HTTP.Config, Adapter.WsClientConfig {
+    }
+    const Options: Schema<Options>;
+}
+export declare class WsServer<C extends Context> extends Adapter<C, OneBotBot<C, OneBotBot.BaseConfig & WsServer.Options>> {
+    static inject: string[];
+    logger: Logger;
+    wsServer?: WebSocketLayer;
+    constructor(ctx: C, bot: OneBotBot<C>);
+    disconnect(bot: OneBotBot<C>): Promise<void>;
+}
+export declare namespace WsServer {
+    interface Options extends SharedConfig<"ws-reverse"> {
+        path?: string;
+    }
+    const Options: Schema<Options>;
+}
+export declare function accept(socket: Universal.WebSocket, bot: OneBotBot<Context, any>): void;
+export {};

package/lib/ws.js

@@ -0,0 +1,122 @@
+import { Adapter, HTTP, Schema, Time } from "koishi";
+import { dispatchSession, TimeoutError } from "./utils";
+let counter = 0;
+const listeners = {};
+export class WsClient extends Adapter.WsClient {
+    async fork(ctx, bot) {
+        super.fork(ctx, bot);
+    }
+    accept(socket) {
+        accept(socket, this.bot);
+    }
+    prepare() {
+        const { token, endpoint } = this.bot.config;
+        const http = this.ctx.http.extend(this.bot.config);
+        if (token)
+            http.config.headers.Authorization = `Bearer ${token}`;
+        return http.ws(endpoint);
+    }
+    async disconnect(bot) {
+        bot.status = 4 /* Universal.Status.RECONNECT */;
+    }
+}
+(function (WsClient) {
+    WsClient.Options = Schema.intersect([
+        Schema.object({
+            protocol: Schema.const("ws").required(process.env.KOISHI_ENV !== "browser"),
+            responseTimeout: Schema.natural()
+                .role("time")
+                .default(Time.minute)
+                .description("等待响应的时间 (单位为毫秒)。")
+        }).description("连接设置"),
+        HTTP.createConfig(true),
+        Adapter.WsClientConfig
+    ]);
+})(WsClient || (WsClient = {}));
+const kSocket = Symbol("socket");
+export class WsServer extends Adapter {
+    static inject = ["server"];
+    logger;
+    wsServer;
+    constructor(ctx, bot) {
+        super(ctx);
+        this.logger = ctx.logger("onebot");
+        const { path = "/onebot" } = bot.config;
+        this.wsServer = ctx.server.ws(path, (socket, { headers }) => {
+            this.logger.debug("connected with", headers);
+            if (headers["x-client-role"] !== "Universal") {
+                return socket.close(1008, "invalid x-client-role");
+            }
+            const selfId = headers["x-self-id"].toString();
+            const bot = this.bots.find((bot) => bot.selfId === selfId);
+            if (!bot)
+                return socket.close(1008, "invalid x-self-id");
+            bot[kSocket] = socket;
+            accept(socket, bot);
+        });
+        ctx.on("dispose", () => {
+            this.logger.debug("ws server closing");
+            this.wsServer.close();
+        });
+    }
+    async disconnect(bot) {
+        bot[kSocket]?.close();
+        bot[kSocket] = null;
+        bot.status = 4 /* Universal.Status.RECONNECT */;
+    }
+}
+(function (WsServer) {
+    WsServer.Options = Schema.object({
+        protocol: Schema.const("ws-reverse").required(process.env.KOISHI_ENV === "browser"),
+        path: Schema.string().description("服务器监听的路径。").default("/onebot"),
+        responseTimeout: Schema.natural().role("time").default(Time.minute).description("等待响应的时间 (单位为毫秒)。")
+    }).description("连接设置");
+})(WsServer || (WsServer = {}));
+export function accept(socket, bot) {
+    socket.addEventListener("message", async ({ data }) => {
+        let parsed;
+        try {
+            parsed = JSON.parse(data.toString());
+        }
+        catch {
+            return bot.logger.warn("cannot parse message", data);
+        }
+        if ("post_type" in parsed) {
+            bot.logger.debug("[receive] %o", parsed);
+            await dispatchSession(bot, parsed);
+        }
+        else if (parsed.echo in listeners) {
+            listeners[parsed.echo](parsed);
+            delete listeners[parsed.echo];
+        }
+    });
+    socket.addEventListener("close", () => {
+        delete bot.internal._request;
+        Object.keys(listeners).forEach((echo) => {
+            delete listeners[Number(echo)];
+        });
+    });
+    bot.internal._request = (action, params) => {
+        const echo = ++counter;
+        const data = { action, params, echo };
+        return Promise.race([
+            new Promise((resolve, reject) => {
+                listeners[echo] = resolve;
+                try {
+                    socket.send(JSON.stringify(data));
+                }
+                catch (error) {
+                    delete listeners[echo];
+                    reject(error);
+                }
+            }),
+            new Promise((_, reject) => {
+                setTimeout(() => {
+                    delete listeners[echo];
+                    reject(new TimeoutError(params, action));
+                }, bot.config.responseTimeout);
+            })
+        ]);
+    };
+    bot.initialize();
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@mrlingxd/koishi-plugin-adapter-onebot",
+  "version": "0.1.0",
+  "description": "OneBot Adapter for Koishi",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "contributors": [
+    "MrlingXD <90316914+wling-art@users.noreply.github.com>"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/wling-art/koishi-plugin-adapter-onebot",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wling-art/koishi-plugin-adapter-onebot.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wling-art/koishi-plugin-adapter-onebot/issues"
+  },
+  "keywords": [
+    "bot",
+    "chatbot",
+    "koishi",
+    "plugin",
+    "adapter",
+    "onebot",
+    "im",
+    "chat"
+  ],
+  "koishi": {
+    "description": {
+      "en": "OneBot Adapter for Koishi",
+      "zh": "OneBot 适配器"
+    },
+    "service": {
+      "implements": [
+        "adapter"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "atsc -b",
+    "lint": "eslint --ext=ts --cache"
+  },
+  "devDependencies": {
+    "@cordisjs/eslint-config": "^1.1.1",
+    "@koishijs/plugin-server": "^3.2.7",
+    "@types/node": "^25.0.3",
+    "atsc": "^2.1.0",
+    "esbuild": "^0.27.2",
+    "esbuild-register": "^3.6.0",
+    "eslint": "^9.39.2",
+    "koishi": "^4.18.9",
+    "typescript": "^5.9.3",
+    "yml-register": "^1.2.5"
+  },
+  "peerDependencies": {
+    "koishi": "^4.18.6"
+  },
+  "dependencies": {
+    "qface": "^1.4.1"
+  }
+}

package/readme.md

@@ -0,0 +1,153 @@
+# koishi-plugin-adapter-onebot
+
+> 本项目基于 [koishijs/koishi-plugin-adapter-onebot](https://github.com/koishijs/koishi-plugin-adapter-onebot) fork，<br>
+> 用于优化和补充原仓库功能，便于后续维护和更新。
+
+适用于 [Koishi](https://koishi.chat/) 的 OneBot 适配器。
+
+[OneBot](https://github.com/howmanybots/onebot) 是一个聊天机器人应用接口标准。
+
+## 配置项
+
+### config.protocol
+
+- 可选值: http, ws, ws-reverse
+
+要使用的协议类型。
+
+### config.token
+
+- 类型：`string`
+
+发送信息时用于验证的字段。
+
+### config.endpoint
+
+- 类型：`string`
+
+如果使用了 HTTP，则该配置将作为发送信息的服务端；如果使用了 WebSocket，则该配置将作为监听事件和发送信息的服务端。
+
+### config.proxyAgent
+
+- 类型: `string`
+- 默认值: [`app.config.request.proxyAgent`](https://koishi.chat/zh-CN/api/core/app.html#options-request-proxyagent)
+
+请求时默认使用的网络代理。
+
+### config.path
+
+- 类型：`string`
+- 默认值：`'/onebot'`
+
+服务器监听的路径。仅用于 HTTP 或 WS Reverse 通信方式。
+
+### config.secret
+
+- 类型：`string`
+
+接收信息时用于验证的字段，应与 OneBot 的 `secret` 配置保持一致。
+
+## 内部 API
+
+你可以通过 `bot.internal` 或 `session.onebot` 访问内部 API，参见 [访问内部接口](https://koishi.chat/zh-CN/guide/adapter/bot.html#internal-access)。
+
+### OneBot v11 标准 API
+
+- [`onebot.sendPrivateMsg()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#send_private_msg-发送私聊消息)
+- [`onebot.sendGroupMsg()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#send_group_msg-发送群消息)
+- [`onebot.deleteMsg()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#delete_msg-撤回消息)
+- [`onebot.getMsg()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_msg-获取消息)
+- [`onebot.getForwardMsg()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_forward_msg-获取合并转发消息)
+- [`onebot.sendLike()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#send_like-发送好友赞)
+- [`onebot.setGroupKick()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_kick-群组踢人)
+- [`onebot.setGroupBan()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_ban-群组单人禁言)
+- [`onebot.setGroupAnonymousBan()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_anonymous_ban-群组匿名用户禁言)
+- [`onebot.setGroupWholeBan()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_whole_ban-群组全员禁言)
+- [`onebot.setGroupAdmin()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_admin-群组设置管理员)
+- [`onebot.setGroupAnonymous()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_anonymous-群组匿名)
+- [`onebot.setGroupCard()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_card-设置群名片群备注)
+- [`onebot.setGroupName()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_name-设置群名)
+- [`onebot.setGroupLeave()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_leave-退出群组)
+- [`onebot.setGroupSpecialTitle()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_special_title-设置群组专属头衔)
+- [`onebot.setFriendAddRequest()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_friend_add_request-处理加好友请求)
+- [`onebot.setGroupAddRequest()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_group_add_request-处理加群请求邀请)
+- [`onebot.getLoginInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_login_info-获取登录号信息)
+- [`onebot.getStrangerInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_stranger_info-获取陌生人信息)
+- [`onebot.getFriendList()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_friend_list-获取好友列表)
+- [`onebot.getGroupInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_group_info-获取群信息)
+- [`onebot.getGroupList()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_group_list-获取群列表)
+- [`onebot.getGroupMemberInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_group_member_info-获取群成员信息)
+- [`onebot.getGroupMemberList()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_group_member_list-获取群成员列表)
+- [`onebot.getGroupHonorInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_group_honor_info-获取群荣誉信息)
+- [`onebot.getCookies()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_cookies-获取-cookies)
+- [`onebot.getCsrfToken()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_csrf_token-获取-csrf-token)
+- [`onebot.getCredentials()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_credentials-获取-qq-相关接口凭证)
+- [`onebot.getRecord()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_record-获取语音)
+- [`onebot.getImage()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_image-获取图片)
+- [`onebot.canSendImage()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#can_send_image-检查是否可以发送图片)
+- [`onebot.canSendRecord()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#can_send_record-检查是否可以发送语音)
+- [`onebot.getStatus()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_status-获取运行状态)
+- [`onebot.getVersionInfo()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#get_version_info-获取版本信息)
+- [`onebot.setRestart()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#set_restart-重启-onebot-实现)
+- [`onebot.cleanCache()`](https://github.com/botuniverse/onebot-11/blob/master/api/public.md#clean_cache-清理缓存)
+
+### go-cqhttp 扩展 API
+
+- [`onebot.sendGroupForwardMsg()`](https://docs.go-cqhttp.org/api/#发送合并转发-群聊)
+- [`onebot.markMsgAsRead()`](https://docs.go-cqhttp.org/api/#标记消息已读)
+- [`onebot.sendGroupSign()`](https://docs.go-cqhttp.org/api/#群打卡)
+- [`onebot.qidianGetAccountInfo()`](https://docs.go-cqhttp.org/api/#获取企点账号信息)
+- [`onebot.setQqProfile()`](https://docs.go-cqhttp.org/api/#设置登录号资料)
+- [`onebot.getUnidirectionalFriendList()`](https://docs.go-cqhttp.org/api/#获取单向好友列表)
+- [`onebot.deleteFriend()`](https://docs.go-cqhttp.org/api/#删除好友)
+- [`onebot.setGroupPortrait()`](https://docs.go-cqhttp.org/api/#设置群头像)
+- [`onebot.getWordSlices()`](https://docs.go-cqhttp.org/api/#获取中文分词-隐藏-api)
+- [`onebot.ocrImage()`](https://docs.go-cqhttp.org/api/#图片-ocr)
+- [`onebot.getGroupSystemMsg()`](https://docs.go-cqhttp.org/api/#获取群系统消息)
+- [`onebot.uploadPrivateFile()`](https://docs.go-cqhttp.org/api/#上传私聊文件)
+- [`onebot.uploadGroupFile()`](https://docs.go-cqhttp.org/api/#上传群文件)
+- [`onebot.getGroupFileSystemInfo()`](https://docs.go-cqhttp.org/api/#获取群文件系统信息)
+- [`onebot.getGroupRootFiles()`](https://docs.go-cqhttp.org/api/#获取群根目录文件列表)
+- [`onebot.getGroupFilesByFolder()`](https://docs.go-cqhttp.org/api/#获取群子目录文件列表)
+- [`onebot.createGroupFileFolder()`](https://docs.go-cqhttp.org/api/#创建群文件文件夹)
+- [`onebot.deleteGroupFolder()`](https://docs.go-cqhttp.org/api/#删除群文件文件夹)
+- [`onebot.deleteGroupFile()`](https://docs.go-cqhttp.org/api/#删除群文件)
+- [`onebot.getGroupFileUrl()`](https://docs.go-cqhttp.org/api/#获取群文件资源链接)
+- [`onebot.getGroupAtAllRemain()`](https://docs.go-cqhttp.org/api/#获取群-全体成员-剩余次数)
+- [`onebot.getVipInfo()`](https://github.com/Mrs4s/go-cqhttp/blob/master/docs/cqhttp.md?plain=1#L1081)
+- [`onebot.sendGroupNotice()`](https://docs.go-cqhttp.org/api/#发送群公告)
+- [`onebot.getGroupNotice()`](https://docs.go-cqhttp.org/api/#获取群公告)
+- [`onebot.reloadEventFilter()`](https://docs.go-cqhttp.org/api/#重载事件过滤器)
+- [`onebot.downloadFile()`](https://docs.go-cqhttp.org/api/#下载文件到缓存目录)
+- [`onebot.getOnlineClients()`](https://docs.go-cqhttp.org/api/#获取当前账号在线客户端列表)
+- [`onebot.getGroupMsgHistory()`](https://docs.go-cqhttp.org/api/#获取群消息历史记录)
+- [`onebot.setEssenceMsg()`](https://docs.go-cqhttp.org/api/#设置精华消息)
+- [`onebot.deleteEssenceMsg()`](https://docs.go-cqhttp.org/api/#移出精华消息)
+- [`onebot.getEssenceMsgList()`](https://docs.go-cqhttp.org/api/#获取精华消息列表)
+- [`onebot.checkUrlSafely()`](https://docs.go-cqhttp.org/api/#检查链接安全性)
+- [`onebot.getModelShow()`](https://docs.go-cqhttp.org/api/#获取在线机型)
+- [`onebot.setModelShow()`](https://docs.go-cqhttp.org/api/#设置在线机型)
+- [`onebot.delete_unidirectional_friend()`](https://docs.go-cqhttp.org/api/#删除单向好友)
+- [`onebot.send_private_forward_msg()`](https://docs.go-cqhttp.org/api/#发送合并转发-好友)
+
+### 频道 API
+
+- [`onebot.getGuildServiceProfile()`](https://docs.go-cqhttp.org/api/guild.html#获取频道系统内bot的资料)
+- [`onebot.getGuildList()`](https://docs.go-cqhttp.org/api/guild.html#获取频道列表)
+- [`onebot.getGuildMetaByGuest()`](https://docs.go-cqhttp.org/api/guild.html#通过访客获取频道元数据)
+- [`onebot.getGuildChannelList()`](https://docs.go-cqhttp.org/api/guild.html#获取子频道列表)
+- [`onebot.getGuildMembers()`](https://docs.go-cqhttp.org/api/guild.html#获取频道成员列表)
+- [`onebot.sendGuildChannelMsg()`](https://docs.go-cqhttp.org/api/guild.html#发送信息到子频道)
+
+## 许可证
+
+使用 [MIT](./LICENSE) 许可证发布。
+
+```
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```