Skip to content

event.md

Latest commit

 

History

History
974 lines (816 loc) · 36.1 KB

event.md

File metadata and controls

974 lines (816 loc) · 36.1 KB

事件订阅说明

接口

bot.on(eventName, callback);

例

bot.on('mute', ({ operator }) => console.log(`我被${operator.memberName}禁言啦！`));

事件名称一览表

Tips: node-mirai 的 事件名称 (eventName) 和 mirai-api-http 的 事件类型 (type) 并不一致。

通常情况下，node-mirai 中的事件名称是 mirai-api-http 中的事件类型去掉 Bot 和 Event 后的小驼峰命名形式。在监听事件时，请以 node-mirai 的事件名称为准。例如：

/* 监听群成员主动离群事件 (MemberLeaveEventQuit => memberLeaveQuit) */

// 正确写法：监听 memberLeaveQuit
bot.on("memberLeaveQuit", () => console.log("Someone has left the group."));

// 错误写法：监听 MemberLeaveEventQuit
bot.on("MemberLeaveEventQuit", () => console.log("Someone has left the group."));

下表列出了 mirai-api-http 事件类型与 node-mirai 事件名称的对应关系：

mirai-api-http 事件类型 对应 node-mirai 事件名称
BotOnlineEvent online
BotOfflineEventActive offlineActive
BotOfflineEventForce offlineForce
BotOfflineEventDropped offlineDropped
BotReloginEvent relogin
BotGroupPermissionChangeEvent groupPermissionChange
BotMuteEvent mute
BotUnmuteEvent unmute
BotLeaveEventActive leaveActive
BotLeaveEventKick leaveKick
BotJoinGroupEvent joinGroup
BotInvitedJoinGroupRequestEvent invitedJoinGroupRequest
GroupNameChangeEvent groupNameChange
GroupEntranceAnnouncementChangeEvent groupEntranceAnnouncementChange
GroupMuteAllEvent groupMuteAll
GroupAllowAnonymousChatEvent groupAllowAnonymousChat
GroupAllowConfessTalkEvent groupAllowConfessTalk
GroupAllowMemberInviteEvent groupAllowMemberInvite
GroupRecallEvent groupRecall
FriendRecallEvent friendRecall
MemberJoinEvent memberJoin
MemberLeaveEventKick memberLeaveKick
MemberLeaveEventQuit memberLeaveQuit
MemberCardChangeEvent memberCardChange
MemberSpecialTitleChangeEvent memberSpecialTitleChange
MemberPermissionChangeEvent memberPermissionChange
MemberMuteEvent memberMute
MemberUnmuteEvent memberUnmute
MemberJoinRequestEvent memberJoinRequest
NewFriendRequestEvent newFriendRequest

另请参阅 events.json.

所有事件及 callback 参数

此列表来自 mirai-http-api/docs/EventType

Bot登录成功

eventName: online

callback parameter:

{
    "type": "BotOnlineEvent",
    "qq": 123456
}
名字 类型 说明
qq Long 登录成功的Bot的QQ号

Bot主动离线

eventName: offlineActive

callback parameter:

{
    "type": "BotOfflineEventActive",
    "qq": 123456
}
名字 类型 说明
qq Long 主动离线的Bot的QQ号

Bot被挤下线

eventName: offlineForce

callback parameter:

{
    "type": "BotOfflineEventForce",
    "qq": 123456
}
名字 类型 说明
qq Long 被挤下线的Bot的QQ号

Bot被服务器断开或因网络问题而掉线

eventName: offlineDropped

callback parameter:

{
    "type": "BotOfflineEventDropped",
    "qq": 123456
}
名字 类型 说明
qq Long 被服务器断开或因网络问题而掉线的Bot的QQ号

Bot主动重新登录

eventName: relogin

callback parameter:

{
    "type": "BotReloginEvent",
    "qq": 123456
}
名字 类型 说明
qq Long 主动重新登录的Bot的QQ号

Bot在群里的权限被改变. 操作人一定是群主

eventName: groupPermissionChange

callback parameter:

{
    "type": "BotGroupPermissionChangeEvent",
    "origin": "MEMBER",
    "new": "ADMINISTRATOR",
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "ADMINISTRATOR"
    }
}
名字 类型 说明
origin String Bot的原权限，OWNER、ADMINISTRATOR或MEMBER
new String Bot的新权限，OWNER、ADMINISTRATOR或MEMBER
group Object 权限改变所在的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER

Bot被禁言

eventName: mute

callback parameter:

{
    "type": "BotMuteEvent",
    "durationSeconds": 600,
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
durationSeconds Int 禁言时长，单位为秒
operator Object 操作的管理员或群主信息
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator.group Object Bot被禁言所在群的信息
operator.group.id Long 群号
operator.group.name String 群名
operator.group.permission String Bot在群中的权限，OWNER或ADMINISTRATOR

Bot被取消禁言

eventName: unmute

callback parameter:

{
    "type": "BotUnmuteEvent",
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
operator Object 操作的管理员或群主信息
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator.group Object Bot被取消禁言所在群的信息
operator.group.id Long 群号
operator.group.name String 群名
operator.group.permission String Bot在群中的权限，OWNER或ADMINISTRATOR

Bot加入了一个新群

eventName: joinGroup

callback parameter:

{
    "type": "BotJoinGroupEvent",
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    }
}
名字 类型 说明
group Object Bot新加入群的信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER（新加入群通常是Member）

某个群名改变

eventName: groupNameChange

callback parameter:

{
    "type": "GroupNameChangeEvent",
    "origin": "miral technology",
    "new": "MIRAI TECHNOLOGY",
    "group": {
        "id": 123456789,
        "name": "MIRAI TECHNOLOGY",
        "permission": "MEMBER"
    },
    "isByBot": false
}
名字 类型 说明
origin String 原群名
new String 新群名
group Object 群名改名的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
isByBot Boolean 是否Bot进行该操作

某群入群公告改变

eventName: groupEntranceAnnouncementChange

callback parameter:

{
    "type": "GroupEntranceAnnouncementChangeEvent",
    "origin": "abc",
    "new": "cba",
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin String 原公告
new String 新公告
group Object 公告改变的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作的管理员或群主信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER或ADMINISTRATOR
operator.group Object 同group

全员禁言

eventName: groupMuteAll

callback parameter:

{
    "type": "GroupMuteAllEvent",
    "origin": false,
    "new": true,
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin Boolean 原本是否处于全员禁言
new Boolean 现在是否处于全员禁言
group Object 全员禁言的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作的管理员或群主信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER或ADMINISTRATOR
operator.group Object 同group

匿名聊天

eventName: groupAllowAnonymousChat

callback parameter:

{
    "type": "GroupAllowAnonymousChatEvent",
    "origin": false,
    "new": true,
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin Boolean 原本匿名聊天是否开启
new Boolean 现在匿名聊天是否开启
group Object 匿名聊天状态改变的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作的管理员或群主信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER或ADMINISTRATOR
operator.group Object 同group

坦白说

eventName: groupAllowConfessTalk

callback parameter:

{
    "type": "GroupAllowConfessTalkEvent",
    "origin": false,
    "new": true,
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    },
    "isByBot": false
}
名字 类型 说明
origin Boolean 原本坦白说是否开启
new Boolean 现在坦白说是否开启
group Object 坦白说状态改变的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
isByBot Boolean 是否Bot进行该操作

允许群员邀请好友加群

eventName: groupAllowMemberInvite

callback parameter:

{
    "type": "GroupAllowMemberInviteEvent",
    "origin": false,
    "new": true,
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin Boolean 原本是否允许群员邀请好友加群
new Boolean 现在是否允许群员邀请好友加群
group Object 允许群员邀请好友加群状态改变的群信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作的管理员或群主信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER或ADMINISTRATOR
operator.group Object 同group

新人入群的事件

eventName: memberJoin

callback parameter:

{
    "type": "MemberJoinEvent",
    "member": {
        "id": 123456789,
        "memberName": "我是新人",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
member Object 新人信息
member.id Long 新人的QQ号
member.memberName String 新人的群名片
member.permission String 新人在群中的权限，OWNER、ADMINISTRATOR或MEMBER（新入群通常是MEMBER）
member.group Object 新人入群的群信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER

成员被踢出群（该成员不是Bot）

eventName: memberLeaveKick

callback parameter:

{
    "type": "MemberLeaveEventKick",
    "member": {
        "id": 123456789,
        "memberName": "我是被踢的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
member Object 被踢者的信息
member.id Long 被踢者的QQ号
member.memberName String 被踢者的群名片
member.permission String 被踢者在群中的权限，ADMINISTRATOR或MEMBER
member.group Object 被踢者所在的群
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作的管理员或群主信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER或ADMINISTRATOR
operator.group Object 同member.group

成员主动离群（该成员不是Bot）

eventName: memberLeaveQuit

callback parameter:

{
    "type": "MemberLeaveEventQuit",
    "member": {
        "id": 123456789,
        "memberName": "我是被踢的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
member Object 退群群员的信息
member.id Long 退群群员的QQ号
member.memberName String 退群群员的群名片
member.permission String 退群群员在群中的权限，ADMINISTRATOR或MEMBER
member.group Object 退群群员所在的群信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER

群名片改动

eventName: memberCardChange

callback parameter:

{
    "type": "MemberCardChangeEvent",
    "origin": "origin name",
    "new": "我是被改名的",
    "member": {
        "id": 123456789,
        "memberName": "我是被改名的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员，也可能是我自己",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
member Object 名片改动的群员的信息
member.id Long 名片改动的群员的QQ号
member.memberName String 名片改动的群员的群名片
member.permission String 名片改动的群员在群中的权限，OWNER、ADMINISTRATOR或MEMBER
member.group Object 名片改动的群员所在群的信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作者的信息，可能为该群员自己，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator.group Object 同member.group

群头衔改动（只有群主有操作限权）

eventName: memberSpecialTitleChange

callback parameter:

{
    "type": "MemberSpecialTitleChangeEvent",
    "origin": "origin title",
    "new": "new title",
    "member": {
        "id": 123456789,
        "memberName": "我是被改头衔的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin String 原头衔
new String 现头衔
member Object 头衔改动的群员的信息
member.id Long 头衔改动的群员的QQ号
member.memberName String 头衔改动的群员的群名片
member.permission String 头衔改动的群员在群中的权限，OWNER、ADMINISTRATOR或MEMBER
member.group Object 头衔改动的群员所在群的信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER

成员权限改变的事件（该成员不可能是Bot，见BotGroupPermissionChangeEvent）

eventName: memberPermissionChange

callback parameter:

{
    "type": "MemberPermissionChangeEvent",
    "origin": "MEMBER",
    "new": "ADMINISTRATOR",
    "member": {
        "id": 123456789,
        "memberName": "我是被改权限的",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
origin String 原权限
new String 现权限
member Object 权限改动的群员的信息
member.id Long 权限改动的群员的QQ号
member.memberName String 权限改动的群员的群名片
member.permission String 权限改动的群员在群中的权限，ADMINISTRATOR或MEMBER
member.group Object 权限改动的群员所在群的信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER

群成员被禁言事件（该成员不可能是Bot，见BotMuteEvent）

eventName: memberMute

callback parameter:

{
    "type": "MemberMuteEvent",
    "durationSeconds": 600,
    "member": {
        "id": 123456789,
        "memberName": "我是被禁言的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
durationSeconds Long 禁言时长，单位为秒
member Object 被禁言的群员的信息
member.id Long 被禁言的群员的QQ号
member.memberName String 被禁言的群员的群名片
member.permission String 被禁言的群员在群中的权限，ADMINISTRATOR或MEMBER
member.group Object 被禁言的群员所在群的信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作者的信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER、ADMINISTRATOR
operator.group Object 同member.group

群成员被取消禁言事件（该成员不可能是Bot，见BotUnmuteEvent）

eventName: memberUnmute

callback parameter:

{
    "type": "MemberUnmuteEvent",
    "member": {
        "id": 123456789,
        "memberName": "我是被取消禁言的",
        "permission": "MEMBER",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    },
    "operator": {
        "id": 123456789,
        "memberName": "我是管理员",
        "permission": "ADMINISTRATOR",
        "group": {
            "id": 123456789,
            "name": "Miral Technology",
            "permission": "MEMBER"
        }
    }
}
名字 类型 说明
member Object 被取消禁言的群员的信息
member.id Long 被取消禁言的群员的QQ号
member.memberName String 被取消禁言的群员的群名片
member.permission String 被取消禁言的群员在群中的权限，ADMINISTRATOR或MEMBER
member.group Object 被取消禁言的群员所在群的信息
member.group.id Long 群号
member.group.name String 群名
member.group.permission String Bot在群中的权限，OWNER、ADMINISTRATOR或MEMBER
operator Object? 操作者的信息，当null时为Bot操作
operator.id Long 操作者的QQ号
operator.memberName String 操作者的群名片
operator.permission String 操作者在群中的权限，OWNER、ADMINISTRATOR
operator.group Object 同member.group

用户入群申请（Bot需要有管理员权限）

eventName: memberJoinRequest

callback parameter:

{
    "type": "MemberJoinRequestEvent",
    "eventId": 12345678,
    "fromId": 123456,
    "groupId": 654321,
    "groupName": "Group",
    "nick": "Nick Name"
}
名字 类型 说明
eventId Long 事件标识，响应该事件时的标识
fromId Long 申请人QQ号
groupId Long 申请人申请入群的群号
groupName String 申请人申请入群的群名称
nick String 申请人的昵称或群名片

接收 memberJoinRequest 事件后，可以通过 bot.handleMemberJoinRequest(eventId, fromId, groupId, operate, message) 处理用户入群申请。

Bot被邀请入群申请

eventName: invitedJoinGroupRequest

callback parameter:

{
    "type": "BotInvitedJoinGroupRequestEvent",
    "eventId": 12345678,
    "fromId": 123456,
    "groupId": 654321,
    "groupName": "Group",
    "nick": "Nick Name",
    "message": ""
}
名字 类型 说明
eventId Long 事件标识，响应该事件时的标识
fromId Long 邀请人（好友）的QQ号
groupId Long 被邀请进入群的群号
groupName String 被邀请进入群的群名称
nick String 邀请人（好友）的昵称
message String 邀请消息

接收 invitedJoinGroupRequest 事件后，可以通过 bot.handleBotInvitedJoinGroupRequest(eventId, fromId, groupId, operate, message) 处理入群邀请。

Bot主动退出一个群

eventName: leaveActive

callback parameter:

{
    "type": "BotLeaveEventActive",
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    }
}
名字 类型 说明
group Object Bot退出的群的信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，ADMINISTRATOR或MEMBER

Bot被踢出一个群

eventName: leaveKick

callback parameter:

{
    "type": "BotLeaveEventKick",
    "group": {
        "id": 123456789,
        "name": "Miral Technology",
        "permission": "MEMBER"
    }
}
名字 类型 说明
group Object Bot被踢出的群的信息
group.id Long 群号
group.name String 群名
group.permission String Bot在群中的权限，ADMINISTRATOR或MEMBER

Bot接收到添加好友申请

eventName: newFriendRequest

callback parameter:

{
    "type": "NewFriendRequestEvent",
    "eventId": 12345678,
    "fromId": 123456,
    "groupId": 654321,
    "nick": "Nick Name",
    "message": ""
}
名字 类型 说明
eventId Long 事件标识，响应该事件时的标识
fromId Long 申请人QQ号
groupId Long 申请人如果通过某个群添加好友，该项为该群群号；否则为0
nick String 申请人的昵称或群名片
message String 申请消息

接收 newFriendRequest 事件后，可以通过 bot.handleNewFriendRequest(eventId, fromId, groupId, operate, message) 处理添加好友申请。