Skip to content

Zulip 配置

必填凭证

配置项类型说明
server_urlstringZulip 组织根地址,例如 https://example.zulipchat.com
emailstringBot 的 Zulip API 邮箱
api_keystringBot API Key,Web 中按敏感字段展示

server_url 不包含 /api/v1。旧的 serverUrlapiKeywebsocket 已移除;Zulip 实时协议是 Event Queue 长轮询,不是 WebSocket。

消息与事件队列

配置项默认值说明
receive_modeevent_queueevent_queue 使用官方长轮询;manual 由已有连接投递
default_topicgeneral发送目标只有频道 ID 时的话题
event_queue.event_types内置集合可在 Web 表单动态增减的官方事件类型
event_queue.all_public_streamsfalse是否接收所有可访问公共频道消息
event_queue.retry_initial_delay_ms1000断线初始退避
event_queue.retry_max_delay_ms30000退避上限;重试次数始终无限
yaml
zulip.team-bot:
  server_url: https://example.zulipchat.com
  email: onebots-bot@example.zulipchat.com
  api_key: your-api-key
  default_topic: general
  receive_mode: event_queue
  event_queue:
    event_types:
      - message
      - update_message
      - delete_message
      - reaction
      - subscription
      - realm_user
    all_public_streams: false
    retry_initial_delay_ms: 1000
    retry_max_delay_ms: 30000
  onebot.v11:
    access_token: your-token

manual 模式不注册或轮询 Event Queue。已有消费者应调用 await client.ingest(rawEvent);raw、精确类型、canonical 监听器和协议投影全部成功后才提交去重状态。旧的 event_queue.enabled 不再接受。

身份验证、Event Queue 注册与后续协议出口共用账号启动边界。达到全局 timeout 或取消热重载时,适配器会中止注册与长轮询,并删除已经创建或忽略取消后迟到返回的服务器队列,避免旧启动任务重新把账号标记为就绪。

代理

yaml
  proxy:
    url: socks5://127.0.0.1:1080
    username: optional-user
    password: optional-password

支持 HTTP(S) 与 SOCKS 代理;代理依赖不可用时启动会明确失败,不会静默改为直连。

更多能力与场景 ID 见 Zulip 平台说明