Mattermost

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Cài đặt

openclaw plugins install @openclaw/mattermost

openclaw plugins install ./path/to/local/mattermost-plugin

​

Thiết lập nhanh

{
  channels: {
    mattermost: {
      enabled: true,
      botToken: "mm-token",
      baseUrl: "https://chat.example.com",
      dmPolicy: "pairing",
    },
  },
}

​

Lệnh slash gốc

{
  channels: {
    mattermost: {
      commands: {
        native: true,
        nativeSkills: true,
        callbackPath: "/api/channels/mattermost/command",
        // Use when Mattermost cannot reach the gateway directly (reverse proxy/public URL).
        callbackUrl: "https://gateway.example.com/api/channels/mattermost/command",
      },
    },
  },
}

​

Biến môi trường (tài khoản mặc định)

• MATTERMOST_BOT_TOKEN=...
• MATTERMOST_URL=https://chat.example.com

​

Chế độ trò chuyện

{
  channels: {
    mattermost: {
      chatmode: "onchar",
      oncharPrefixes: [">", "!"],
    },
  },
}

• onchar vẫn phản hồi các @mention rõ ràng.
• channels.mattermost.requireMention vẫn được tôn trọng cho cấu hình cũ, nhưng ưu tiên dùng chatmode.

​

Luồng và phiên

• off (mặc định): chỉ phản hồi trong luồng khi bài đăng đến đã nằm trong một luồng.
• first: với bài đăng kênh/nhóm cấp cao nhất, bắt đầu một luồng dưới bài đăng đó và định tuyến cuộc trò chuyện tới phiên theo phạm vi luồng.
• all: hiện nay có cùng hành vi như first đối với Mattermost.
• Tin nhắn trực tiếp bỏ qua thiết lập này và vẫn không dùng luồng.

{
  channels: {
    mattermost: {
      replyToMode: "all",
    },
  },
}

• Phiên theo phạm vi luồng dùng id bài đăng kích hoạt làm gốc luồng.
• first và all hiện tương đương vì khi Mattermost đã có gốc luồng, các đoạn tiếp theo và phương tiện tiếp tục trong cùng luồng đó.

​

Kiểm soát truy cập (DM)

• Mặc định: channels.mattermost.dmPolicy = "pairing" (người gửi không xác định nhận mã ghép đôi).
• Phê duyệt qua:
  • openclaw pairing list mattermost
  • openclaw pairing approve mattermost <CODE>
• DM công khai: channels.mattermost.dmPolicy="open" cộng với channels.mattermost.allowFrom=["*"].
• channels.mattermost.allowFrom chấp nhận các mục accessGroup:<name>. Xem Nhóm truy cập.

​

Kênh (nhóm)

• Mặc định: channels.mattermost.groupPolicy = "allowlist" (được kiểm soát bằng mention).
• Cho phép người gửi bằng channels.mattermost.groupAllowFrom (khuyến nghị dùng ID người dùng).
• channels.mattermost.groupAllowFrom chấp nhận các mục accessGroup:<name>. Xem Nhóm truy cập.
• Ghi đè mention theo từng kênh nằm dưới channels.mattermost.groups.<channelId>.requireMention hoặc channels.mattermost.groups["*"].requireMention cho mặc định.
• Khớp @username là có thể thay đổi và chỉ được bật khi channels.mattermost.dangerouslyAllowNameMatching: true.
• Kênh mở: channels.mattermost.groupPolicy="open" (được kiểm soát bằng mention).
• Ghi chú runtime: nếu channels.mattermost hoàn toàn bị thiếu, runtime quay về groupPolicy="allowlist" cho kiểm tra nhóm (ngay cả khi channels.defaults.groupPolicy được đặt).

{
  channels: {
    mattermost: {
      groupPolicy: "open",
      groups: {
        "*": { requireMention: true },
        "team-channel-id": { requireMention: false },
      },
    },
  },
}

​

Đích cho gửi đi

• channel:<id> cho một kênh
• user:<id> cho DM
• @username cho DM (được phân giải qua API Mattermost)

​

Thử lại kênh DM

{
  channels: {
    mattermost: {
      dmChannelRetry: {
        maxRetries: 3,
        initialDelayMs: 1000,
        maxDelayMs: 10000,
        timeoutMs: 30000,
      },
    },
  },
}

• Điều này chỉ áp dụng cho việc tạo kênh DM (/api/v4/channels/direct), không phải mọi lệnh gọi API Mattermost.
• Thử lại áp dụng cho các lỗi tạm thời như giới hạn tốc độ, phản hồi 5xx, và lỗi mạng hoặc hết thời gian chờ.
• Lỗi máy khách 4xx ngoài 429 được coi là vĩnh viễn và không được thử lại.

​

Truyền phát bản xem trước

{
  channels: {
    mattermost: {
      streaming: "partial", // off | partial | block | progress
    },
  },
}

​

Phản ứng (công cụ tin nhắn)

• Dùng message action=react với channel=mattermost.
• messageId là id bài đăng Mattermost.
• emoji chấp nhận các tên như thumbsup hoặc :+1: (dấu hai chấm là tùy chọn).
• Đặt remove=true (boolean) để xóa một phản ứng.
• Sự kiện thêm/xóa phản ứng được chuyển tiếp dưới dạng sự kiện hệ thống tới phiên tác nhân được định tuyến.

message action=react channel=mattermost target=channel:<channelId> messageId=<postId> emoji=thumbsup
message action=react channel=mattermost target=channel:<channelId> messageId=<postId> emoji=thumbsup remove=true

• channels.mattermost.actions.reactions: bật/tắt hành động phản ứng (mặc định true).
• Ghi đè theo tài khoản: channels.mattermost.accounts.<id>.actions.reactions.

​

Nút tương tác (công cụ tin nhắn)

{
  channels: {
    mattermost: {
      capabilities: ["inlineButtons"],
    },
  },
}

message action=send channel=mattermost target=channel:<channelId> buttons=[[{"text":"Yes","callback_data":"yes"},{"text":"No","callback_data":"no"}]]

​

Tích hợp API trực tiếp (script bên ngoài)

{
  channel_id: "<channelId>",
  message: "Choose an option:",
  props: {
    attachments: [
      {
        actions: [
          {
            id: "mybutton01", // alphanumeric only - see below
            type: "button", // required, or clicks are silently ignored
            name: "Approve", // display label
            style: "primary", // optional: "default", "primary", "danger"
            integration: {
              url: "https://gateway.example.com/mattermost/interactions/default",
              context: {
                action_id: "mybutton01", // must match button id (for name lookup)
                action: "approve",
                // ... any custom fields ...
                _token: "<hmac>", // see HMAC section below
              },
            },
          },
        ],
      },
    ],
  },
}

import hmac, hashlib, json

secret = hmac.new(
    b"openclaw-mattermost-interactions",
    bot_token.encode(), hashlib.sha256
).hexdigest()

ctx = {"action_id": "mybutton01", "action": "approve"}
payload = json.dumps(ctx, sort_keys=True, separators=(",", ":"))
token = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()

context = {**ctx, "_token": token}

​

Bộ chuyển đổi thư mục

​

Nhiều tài khoản

{
  channels: {
    mattermost: {
      accounts: {
        default: { name: "Primary", botToken: "mm-token", baseUrl: "https://chat.example.com" },
        alerts: { name: "Alerts", botToken: "mm-token-2", baseUrl: "https://alerts.example.com" },
      },
    },
  },
}

​

Khắc phục sự cố

​

Liên quan

• Định tuyến kênh - định tuyến phiên cho tin nhắn
• Tổng quan về kênh - tất cả kênh được hỗ trợ
• Nhóm - hành vi trò chuyện nhóm và kiểm soát bằng nhắc đến
• Ghép cặp - xác thực tin nhắn trực tiếp và luồng ghép cặp
• Bảo mật - mô hình truy cập và gia cố bảo mật