onebots

简体中文

English

简体中文

English

主题

平台配置 ​

平台配置用于设置各平台机器人的认证信息和平台特定参数。

配置格式 ​

平台配置使用 {platform}.{account_id} 格式：

yaml
{platform}.{account_id}:
  # 平台特定配置
  platform_param1: value1
  platform_param2: value2
  
  # 协议配置（可选，覆盖 general）
  {protocol}.{version}:
    protocol_param: value

微信平台 ​

配置项 ​

appid ​

  • 类型: string
  • 必填: ✅
  • 说明: 微信公众号 AppID

appsecret ​

  • 类型: string
  • 必填: ✅
  • 说明: 微信公众号 AppSecret

token ​

  • 类型: string
  • 必填: ✅
  • 说明: 服务器配置的 Token（需与公众平台设置一致）

encoding_aes_key ​

  • 类型: string
  • 必填: ❌
  • 说明: 消息加解密密钥（启用加密模式时必填）

encrypt_mode ​

  • 类型: string
  • 可选值: plain | compatible | safe
  • 默认值: plain
  • 说明: 消息加解密模式
    • plain: 明文模式
    • compatible: 兼容模式
    • safe: 安全模式（加密）

配置示例 ​

yaml
wechat.my_official_account:
  # 微信平台配置
  appid: wx1234567890abcdef
  appsecret: your_app_secret_here
  token: your_token_here
  encoding_aes_key: your_aes_key_here
  encrypt_mode: safe
  
  # 协议配置
  onebot.v11:
    use_http: true
    use_ws: true

获取配置信息 ​

  1. 登录 微信公众平台
  2. 开发 → 基本配置
    • 获取 AppID 和 AppSecret
    • 设置 服务器配置

Webhook 地址 ​

配置服务器 URL 为：

http://your-domain:6727/wechat/{account_id}/webhook

例如：

http://bot.example.com:6727/wechat/my_official_account/webhook

QQ 平台 ​

✅ 已实现

配置项 ​

appId ​

  • 类型: string
  • 必填: ✅
  • 说明: QQ机器人AppID

secret ​

  • 类型: string
  • 必填: ✅
  • 说明: QQ机器人Secret

token ​

  • 类型: string
  • 必填: ✅
  • 说明: QQ机器人Token

mode ​

  • 类型: string
  • 可选值: websocket | webhook
  • 默认值: websocket
  • 说明: 连接模式

sandbox ​

  • 类型: boolean
  • 默认值: false
  • 说明: 是否沙箱环境

removeAt ​

  • 类型: boolean
  • 默认值: true
  • 说明: 是否自动移除@机器人内容

maxRetry ​

  • 类型: number
  • 默认值: 10
  • 说明: 最大重连次数（仅WebSocket模式）

intents ​

  • 类型: string[]
  • 默认值: []
  • 说明: 需要监听的事件（仅WebSocket模式需要）

配置示例 ​

yaml
qq.my_bot:
  # QQ 平台配置
  appId: 'your_app_id'
  token: 'your_token'
  secret: 'your_secret'
  sandbox: false
  intents:
    - 'GROUP_AT_MESSAGE_CREATE'
    - 'C2C_MESSAGE_CREATE'
    - 'PUBLIC_GUILD_MESSAGES'
  
  # 协议配置
  onebot.v11:
    use_http: true
    use_ws: true

详细配置请参考：QQ 适配器配置

Discord 平台 ​

✅ 已实现

配置项 ​

token ​

  • 类型: string
  • 必填: ✅
  • 说明: Discord Bot Token

intents ​

  • 类型: string[]
  • 必填: ❌
  • 说明: Gateway Intents，需要接收的事件类型

partials ​

  • 类型: string[]
  • 必填: ❌
  • 说明: Partials，部分数据支持

presence ​

  • 类型: object
  • 必填: ❌
  • 说明: 机器人状态和活动

配置示例 ​

yaml
discord.your_bot_id:
  # Discord 平台配置
  token: 'your_discord_bot_token'
  intents:
    - Guilds
    - GuildMessages
    - GuildMembers
    - MessageContent
  
  # 协议配置
  onebot.v11:
    use_http: true
    use_ws: true

详细配置请参考：Discord 适配器配置

钉钉平台 ​

✅ 已实现

配置项 ​

app_key（企业内部应用模式） ​

  • 类型: string
  • 必填: ✅*（企业内部应用模式必填）
  • 说明: 钉钉应用 AppKey

app_secret（企业内部应用模式） ​

  • 类型: string
  • 必填: ✅*（企业内部应用模式必填）
  • 说明: 钉钉应用 AppSecret

agent_id ​

  • 类型: string
  • 必填: ❌
  • 说明: 企业内部应用的 AgentId

webhook_url（自定义机器人模式） ​

  • 类型: string
  • 必填: ✅*（自定义机器人模式必填）
  • 说明: 自定义机器人 Webhook URL

encrypt_key ​

  • 类型: string
  • 必填: ❌
  • 说明: 事件加密密钥

token ​

  • 类型: string
  • 必填: ❌
  • 说明: 事件验证 Token

*注：企业内部应用模式和自定义机器人模式二选一。

配置示例 ​

企业内部应用模式 ​

yaml
dingtalk.my_bot:
  # 钉钉平台配置
  app_key: 'your_app_key'
  app_secret: 'your_app_secret'
  agent_id: 'your_agent_id'  # 可选
  
  # 协议配置
  onebot.v11:
    use_http: true
    use_ws: true

自定义机器人模式 ​

yaml
dingtalk.my_bot:
  # 钉钉平台配置
  webhook_url: 'https://oapi.dingtalk.com/robot/send?access_token=YOUR_TOKEN'
  
  # 协议配置
  onebot.v11:
    use_http: true

详细配置请参考：钉钉适配器配置

Kook 平台 ​

✅ 已实现

配置项 ​

token ​

  • 类型: string
  • 必填: ✅
  • 说明: Kook 机器人 Token

mode ​

  • 类型: string
  • 可选值: websocket | webhook
  • 默认值: websocket
  • 说明: 连接模式

verifyToken ​

  • 类型: string
  • 必填: ❌（Webhook 模式需要）
  • 说明: Webhook 验证 Token

encryptKey ​

  • 类型: string
  • 必填: ❌
  • 说明: 消息加密密钥（可选）

配置示例 ​

yaml
kook.zhin:
  # Kook 平台配置
  token: 'your_kook_token'
  mode: 'websocket'
  verifyToken: 'your_verify_token'  # Webhook 模式需要
  encryptKey: 'your_encrypt_key'    # 可选
  
  # 协议配置
  onebot.v11:
    use_http: true
    use_ws: true

详细配置请参考：Kook 适配器配置

多账号配置 ​

可以配置同一平台的多个账号：

yaml
# 微信公众号 1
wechat.mp1:
  appid: wx111111111111
  appsecret: secret1
  token: token1
  onebot.v11:
    use_http: true

# 微信公众号 2
wechat.mp2:
  appid: wx222222222222
  appsecret: secret2
  token: token2
  satori.v1:
    path: /satori

# 微信公众号 3
wechat.mp3:
  appid: wx333333333333
  appsecret: secret3
  token: token3
  milky.v1:
    use_http: true

访问地址会根据 account_id 自动区分：

  • http://localhost:6727/wechat/mp1/onebot/v11/...
  • ws://localhost:6727/wechat/mp2/satori
  • http://localhost:6727/wechat/mp3/milky/v1/...

协议配置覆盖 ​

账号级别的协议配置会覆盖 general 配置：

yaml
general:
  onebot.v11:
    use_http: true
    use_ws: false
    access_token: default_token

wechat.special_account:
  appid: wx123
  appsecret: secret
  token: token
  
  # 覆盖部分配置
  onebot.v11:
    use_ws: true              # 覆盖：启用 WebSocket
    access_token: special_token  # 覆盖：使用特殊 token
    # use_http 继承 general 配置（true）

完整示例 ​

yaml
# 全局配置
port: 6727
log_level: info
timeout: 30

# 协议默认配置
general:
  onebot.v11:
    use_http: true
    use_ws: false
    access_token: global_token
    
  satori.v1:
    path: /satori

# 微信账号 1 - 使用 OneBot V11
wechat.service_account:
  appid: wx_service_123
  appsecret: service_secret
  token: service_token
  encrypt_mode: safe
  encoding_aes_key: service_aes_key
  
  onebot.v11:
    use_http: true
    use_ws: true
    access_token: service_account_token

# 微信账号 2 - 使用 Satori
wechat.subscription_account:
  appid: wx_sub_456
  appsecret: sub_secret
  token: sub_token
  
  satori.v1:
    token: satori_token
    
# 微信账号 3 - 同时提供多个协议
wechat.multi_protocol:
  appid: wx_multi_789
  appsecret: multi_secret
  token: multi_token
  
  onebot.v11:
    use_http: true
    
  onebot.v12:
    use_http: true
    
  satori.v1:
    path: /satori

注意事项 ​

账号 ID 命名 ​

  • 只能包含字母、数字、下划线、中划线
  • 建议使用有意义的名称，如 main_bot、test_account
  • 不同平台可以使用相同的账号 ID（会自动区分）

安全建议 ​

  • 不要在配置文件中硬编码敏感信息
  • 使用环境变量或密钥管理服务
  • 定期更换 token 和密钥
  • 启用访问令牌（access_token）鉴权

配置文件管理 ​

yaml
# 使用环境变量（推荐）
wechat.prod:
  appid: ${WECHAT_APPID}
  appsecret: ${WECHAT_SECRET}
  token: ${WECHAT_TOKEN}

相关链接 ​