元事件
大约 1 分钟
元事件
Onebot12
Onebot 实现内部自发产生的一类事件,例如心跳等,与 OneBot 本身的运行状态有关,与实现对应的机器人平台无关。
本项目实现了以下的元事件。
标准
连接对于正向 WebSocket 和反向 WebSocket 通信方式,在连接建立后会推送给应用端 的第一个事件;HTTP 和 HTTP Webhook 通信方式不会产生连接事件。
字段名 | 数据类型 | 说明 |
---|---|---|
detail_type | string | connect |
version | resp[get_version] | OneBot 实现端版本信息,与 get_version 动作响应数据一致 |
{
"id": "b6e65187-5ac0-489c-b431-53078e9d2bbb",
"time": 1632847927.599013,
"type": "meta",
"detail_type": "connect",
"sub_type": "",
"version": {
"impl": "ComWechat",
"version": "1.2.0",
"onebot_version": "12"
}
}
标准
心跳当 enabled 配置为 true 时,每隔 interval 产生一个心跳事件。
配置
间隔 interval
对应 .env
配置中的 heartbeat_interval
,单位是ms
字段名 | 数据类型 | 说明 |
---|---|---|
detail_type | string | heartbeat |
interval | int64 | 到下次心跳的间隔,单位:毫秒 |
{
"id": "b6e65187-5ac0-489c-b431-53078e9d2bbb",
"time": 1632847927.599013,
"type": "meta",
"detail_type": "heartbeat",
"sub_type": "",
"interval": 5000
}
标准
状态更新连接方式为正向ws或反向ws时,在发送connect
事件后会发送status
事件,表示连接状态。
字段名 | 数据类型 | 说明 |
---|---|---|
detail_type | string | status_update |
status_update | resp[get_status] | 与get_status 动作响应数据一致 |
{
"id": "b6e65187-5ac0-489c-b431-53078e9d2bbb",
"time": 1632847927.599013,
"type": "meta",
"detail_type": "status_update",
"sub_type": "",
"status": {
"good": true,
"bots": [
{
"self": {
"platform": "qq",
"user_id": "1234567"
},
"online": true,
}
]
}
}