OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Developer and self-hosted

Mattermost

स्थिति: डाउनलोड करने योग्य Plugin (बॉट टोकन + WebSocket इवेंट)। चैनल, निजी चैनल, समूह DM और DM समर्थित हैं। Mattermost एक स्वयं-होस्ट करने योग्य टीम मैसेजिंग प्लेटफ़ॉर्म है (mattermost.com)।

इंस्टॉल करें

npm रजिस्ट्री

bash
openclaw plugins install @openclaw/mattermost

स्थानीय चेकआउट

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

विवरण: Plugins

त्वरित सेटअप

  • सुनिश्चित करें कि Plugin उपलब्ध है

    ऊपर दिए गए कमांड से @openclaw/mattermost इंस्टॉल करें, फिर यदि Gateway पहले से चल रहा है तो उसे पुनः आरंभ करें।

  • Mattermost बॉट बनाएँ

    Mattermost बॉट खाता बनाएँ, बॉट टोकन कॉपी करें और बॉट को उन टीमों और चैनलों में जोड़ें जिन्हें उसे पढ़ना चाहिए।

  • बेस URL कॉपी करें

    Mattermost का बेस URL कॉपी करें (उदाहरण के लिए, https://chat.example.com)। अंत में मौजूद /api/v4 अपने-आप हटा दिया जाता है।

  • OpenClaw कॉन्फ़िगर करें और Gateway प्रारंभ करें

    न्यूनतम कॉन्फ़िगरेशन:

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

    गैर-इंटरैक्टिव विकल्प:

    bash
    openclaw channels add --channel mattermost --bot-token <token> --http-url https://chat.example.com

    • नेटिव स्लैश कमांड

    नेटिव स्लैश कमांड ऑप्ट-इन हैं। सक्षम होने पर, OpenClaw हर उस टीम में oc_* स्लैश कमांड पंजीकृत करता है जिसका बॉट सदस्य है और Gateway HTTP सर्वर पर कॉलबैक POST प्राप्त करता है।

    json5
    {  channels: {    mattermost: {      commands: {        native: true,        nativeSkills: true,        callbackPath: "/api/channels/mattermost/command",        // इसका उपयोग तब करें जब Mattermost सीधे Gateway तक न पहुँच सके (रिवर्स प्रॉक्सी/सार्वजनिक URL)।        callbackUrl: "https://gateway.example.com/api/channels/mattermost/command",      },    },  },}

    पंजीकृत कमांड: /oc_status, /oc_model, /oc_models, /oc_new, /oc_help, /oc_think, /oc_reasoning, /oc_verbose, /oc_queue। nativeSkills: true के साथ, स्किल कमांड भी /oc_<skill> के रूप में पंजीकृत किए जाते हैं।

    व्यवहार संबंधी टिप्पणियाँ
    • native और nativeSkills डिफ़ॉल्ट रूप से "auto" होते हैं, जो Mattermost के लिए अक्षम के रूप में निर्धारित होता है। उन्हें स्पष्ट रूप से true पर सेट करें।
    • callbackPath डिफ़ॉल्ट रूप से /api/channels/mattermost/command होता है।
    • यदि callbackUrl छोड़ा गया है, तो OpenClaw http://<gateway.customBindHost or localhost>:<gateway.port, default 18789><callbackPath> निर्धारित करता है। वाइल्डकार्ड बाइंड होस्ट (0.0.0.0, ::) localhost पर फ़ॉलबैक करते हैं।
    • एकाधिक-खाता सेटअप के लिए, commands को शीर्ष स्तर पर या channels.mattermost.accounts.<id>.commands के अंतर्गत सेट किया जा सकता है (खाता मान शीर्ष-स्तरीय फ़ील्ड को ओवरराइड करते हैं)।
    • अन्य इंटीग्रेशन द्वारा समान ट्रिगर के साथ बनाए गए मौजूदा स्लैश कमांड को बदला नहीं जाता (पंजीकरण उन्हें छोड़ देता है); बॉट द्वारा बनाए गए कमांड को कॉलबैक URL बदलने पर अपडेट किया जाता है या फिर से बनाया जाता है।
    • कमांड कॉलबैक को Mattermost द्वारा लौटाए गए प्रति-कमांड टोकन से सत्यापित किया जाता है, जब OpenClaw oc_* कमांड पंजीकृत करता है।
    • OpenClaw प्रत्येक कॉलबैक स्वीकार करने से पहले मौजूदा Mattermost कमांड पंजीकरण रीफ़्रेश करता है, इसलिए हटाए गए या पुनः जनरेट किए गए स्लैश कमांड के पुराने टोकन Gateway पुनः आरंभ किए बिना स्वीकार होना बंद हो जाते हैं।
    • यदि Mattermost API यह पुष्टि नहीं कर पाता कि कमांड अब भी वर्तमान है, तो कॉलबैक सत्यापन बंद स्थिति में विफल होता है; विफल सत्यापन थोड़ी देर के लिए कैश किए जाते हैं, समवर्ती लुकअप को एक साथ संयोजित किया जाता है और रीप्ले दबाव सीमित रखने के लिए नए लुकअप प्रारंभ होने की दर प्रति कमांड सीमित की जाती है।
    • पंजीकरण विफल होने, स्टार्टअप आंशिक होने या कॉलबैक टोकन का निर्धारित कमांड के पंजीकृत टोकन से मेल न खाने पर स्लैश कॉलबैक बंद स्थिति में विफल होते हैं (एक कमांड के लिए मान्य टोकन किसी दूसरे कमांड के अपस्ट्रीम सत्यापन तक नहीं पहुँच सकता)।
    • स्वीकृत कॉलबैक को अस्थायी "प्रोसेस हो रहा है..." उत्तर से स्वीकार किया जाता है; वास्तविक उत्तर सामान्य संदेश के रूप में आता है।
    पहुँच योग्यता की आवश्यकता

    कॉलबैक एंडपॉइंट Mattermost सर्वर से पहुँच योग्य होना चाहिए।

    • callbackUrl को localhost पर तब तक सेट न करें, जब तक Mattermost उसी होस्ट/नेटवर्क नेमस्पेस में न चल रहा हो जिसमें OpenClaw चल रहा है।
    • callbackUrl को अपने Mattermost बेस URL पर तब तक सेट न करें, जब तक वह URL /api/channels/mattermost/command को OpenClaw पर रिवर्स-प्रॉक्सी न करता हो।
    • एक त्वरित जाँच curl https://<gateway-host>/api/channels/mattermost/command है; GET को OpenClaw से 405 Method Not Allowed लौटाना चाहिए, न कि 404।
    Mattermost आउटबाउंड अनुमति-सूची

    यदि आपके कॉलबैक निजी/tailnet/आंतरिक पतों को लक्षित करते हैं, तो कॉलबैक होस्ट/डोमेन को शामिल करने के लिए Mattermost ServiceSettings.AllowedUntrustedInternalConnections सेट करें।

    पूर्ण URL के बजाय होस्ट/डोमेन प्रविष्टियों का उपयोग करें।

    • सही: gateway.tailnet-name.ts.net
    • गलत: https://gateway.tailnet-name.ts.net

    पर्यावरण चर (डिफ़ॉल्ट खाता)

    यदि आप पर्यावरण चर पसंद करते हैं, तो इन्हें Gateway होस्ट पर सेट करें:

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

    चैट मोड

    Mattermost स्वचालित रूप से DMs का उत्तर देता है। चैनल का व्यवहार chatmode द्वारा नियंत्रित होता है:

    oncall (डिफ़ॉल्ट)

    चैनलों में केवल @mention किए जाने पर उत्तर दें।

    onmessage

    चैनल के प्रत्येक संदेश का उत्तर दें।

    onchar

    जब कोई संदेश ट्रिगर प्रीफ़िक्स से शुरू हो, तब उत्तर दें।

    कॉन्फ़िगरेशन उदाहरण:

    json5
    {  channels: {    mattermost: {      chatmode: "onchar",      oncharPrefixes: [">", "!"], // डिफ़ॉल्ट    },  },}

    टिप्पणियाँ:

    • onchar अब भी स्पष्ट @mentions का उत्तर देता है।
    • channels.mattermost.requireMention का अब भी पालन किया जाता है, लेकिन chatmode को प्राथमिकता दी जाती है। प्रति-चैनल groups.<channelId>.requireMention सेटिंग दोनों पर वरीयता रखती हैं।
    • चैनल थ्रेड में बॉट द्वारा दृश्यमान उत्तर भेजे जाने के बाद, उसी थ्रेड के बाद के संदेशों का उत्तर किसी नए @mention या onchar प्रीफ़िक्स के बिना दिया जाता है, जिससे बहु-चरणीय थ्रेड वार्तालाप जारी रहते हैं। बॉट द्वारा उस थ्रेड में अंतिम उत्तर दिए जाने के बाद भागीदारी 7 दिनों तक याद रखी जाती है और Gateway पुनः आरंभ होने के बाद भी बनी रहती है। जिन थ्रेडों को बॉट ने केवल देखा है, वे अप्रभावित रहते हैं; स्पष्ट उल्लेख फिर से आवश्यक बनाने के लिए नया शीर्ष-स्तरीय संदेश शुरू करें।
    • भागीदारी वाले थ्रेड के अनुवर्ती संदेशों को उल्लेख गेटिंग से बचकर निकलने से रोकने के लिए channels.mattermost.implicitMentions.threadParticipation: false सेट करें। खाता ओवरराइड channels.mattermost.accounts.<id>.implicitMentions का उपयोग करते हैं। Mattermost वर्तमान में replyToBot या quotedBot तथ्य उत्पन्न नहीं करता, इसलिए इन फ़्लैग का यहाँ कोई प्रभाव नहीं पड़ता।

    थ्रेडिंग और सत्र

    यह नियंत्रित करने के लिए channels.mattermost.replyToMode का उपयोग करें कि चैनल और समूह के उत्तर मुख्य चैनल में रहें या ट्रिगर करने वाली पोस्ट के अंतर्गत थ्रेड शुरू करें।

    • off (डिफ़ॉल्ट): केवल तभी थ्रेड में उत्तर दें, जब आने वाली पोस्ट पहले से किसी थ्रेड में हो।
    • first: शीर्ष-स्तरीय चैनल/समूह पोस्ट के लिए, उस पोस्ट के अंतर्गत एक थ्रेड शुरू करें और वार्तालाप को थ्रेड-स्कोप वाले सत्र में रूट करें।
    • all और batched: आज Mattermost के लिए first जैसा ही व्यवहार, क्योंकि Mattermost में थ्रेड रूट बनने के बाद अनुवर्ती खंड और मीडिया उसी थ्रेड में जारी रहते हैं।
    • replyToMode सेट होने पर भी प्रत्यक्ष संदेश डिफ़ॉल्ट रूप से off का उपयोग करते हैं।

    direct, group, या channel चैट के लिए मोड ओवरराइड करने हेतु channels.mattermost.replyToModeByChatType का उपयोग करें। प्रत्यक्ष संदेशों में थ्रेडिंग सक्षम करने के लिए direct सेट करें:

    • off (डिफ़ॉल्ट): प्रत्यक्ष संदेश एक ही निरंतर सत्र में बिना थ्रेड के रहते हैं।
    • first, all, या batched: प्रत्येक शीर्ष-स्तरीय प्रत्यक्ष संदेश एक नए, स्वतंत्र सत्र द्वारा समर्थित Mattermost थ्रेड शुरू करता है।
    json5
    {  channels: {    mattermost: {      replyToMode: "all",      replyToModeByChatType: {        direct: "first",      },    },  },}

    टिप्पणियाँ:

    • थ्रेड-स्कोप वाले सत्र ट्रिगर करने वाली पोस्ट की ID को थ्रेड रूट के रूप में उपयोग करते हैं।
    • first और all वर्तमान में समतुल्य हैं, क्योंकि Mattermost में थ्रेड रूट बनने के बाद अनुवर्ती खंड और मीडिया उसी थ्रेड में जारी रहते हैं।
    • प्रति-चैट-प्रकार ओवरराइड replyToMode पर वरीयता रखते हैं। direct ओवरराइड के बिना, मौजूदा डिप्लॉयमेंट सपाट, बिना थ्रेड वाले DMs बनाए रखते हैं।

    अभिगम नियंत्रण (DMs)

    • डिफ़ॉल्ट: channels.mattermost.dmPolicy = "pairing" (अज्ञात प्रेषकों को पेयरिंग कोड मिलता है)। अन्य मान: allowlist, open, disabled।
    • इसके माध्यम से स्वीकृत करें:
      • openclaw pairing list mattermost
      • openclaw pairing approve mattermost &lt;CODE&gt;
    • सार्वजनिक DMs: channels.mattermost.dmPolicy="open" के साथ channels.mattermost.allowFrom=["*"] (कॉन्फ़िगरेशन स्कीमा वाइल्डकार्ड लागू करता है)।
    • channels.mattermost.allowFrom उपयोगकर्ता IDs (अनुशंसित) और accessGroup:<name> प्रविष्टियाँ स्वीकार करता है। अभिगम समूह देखें।

    चैनल (समूह)

    • डिफ़ॉल्ट: channels.mattermost.groupPolicy = "allowlist" (उल्लेख-गेटेड)।
    • channels.mattermost.groupAllowFrom के साथ प्रेषकों को अनुमति-सूची में रखें (उपयोगकर्ता IDs अनुशंसित)।
    • channels.mattermost.groupAllowFrom, accessGroup:<name> प्रविष्टियाँ स्वीकार करता है। अभिगम समूह देखें।
    • प्रति-चैनल उल्लेख ओवरराइड channels.mattermost.groups.<channelId>.requireMention के अंतर्गत रहते हैं, या डिफ़ॉल्ट के लिए channels.mattermost.groups["*"].requireMention के अंतर्गत।
    • @username मिलान परिवर्तनशील है और केवल channels.mattermost.dangerouslyAllowNameMatching: true होने पर सक्षम होता है।
    • खुले चैनल: channels.mattermost.groupPolicy="open" (उल्लेख-गेटेड)।
    • समाधान क्रम: channels.mattermost.groupPolicy, फिर channels.defaults.groupPolicy, फिर "allowlist"।
    • रनटाइम टिप्पणी: यदि channels.mattermost अनुभाग पूरी तरह अनुपस्थित है, तो रनटाइम समूह जाँच के लिए बंद अवस्था में groupPolicy="allowlist" पर विफल होता है (channels.defaults.groupPolicy सेट होने पर भी) और एक बार की चेतावनी लॉग करता है।

    उदाहरण:

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

    आउटबाउंड डिलीवरी के लक्ष्य

    openclaw message send या cron/webhooks के साथ इन लक्ष्य प्रारूपों का उपयोग करें:

    लक्ष्य यहाँ डिलीवर करता है
    channel:<id> ID द्वारा चैनल
    channel:<name> या #channel-name नाम द्वारा चैनल, बॉट जिन टीमों से संबंधित है उनमें खोजा जाता है
    user:<id> या mattermost:<id> उस उपयोगकर्ता के साथ DM
    @username DM (उपयोगकर्ता नाम Mattermost API के माध्यम से हल किया जाता है)

    आउटबाउंड प्रेषण प्रति संदेश अधिकतम एक अटैचमेंट का समर्थन करते हैं; एकाधिक फ़ाइलों को अलग-अलग प्रेषणों में विभाजित करें।

    DM चैनल पुनः प्रयास

    जब OpenClaw किसी Mattermost DM लक्ष्य को भेजता है और पहले प्रत्यक्ष चैनल का समाधान करना आवश्यक होता है, तो वह डिफ़ॉल्ट रूप से प्रत्यक्ष-चैनल निर्माण की अस्थायी विफलताओं पर पुनः प्रयास करता है।

    Mattermost Plugin के लिए इस व्यवहार को वैश्विक रूप से समायोजित करने हेतु channels.mattermost.dmChannelRetry, या किसी एक खाते के लिए channels.mattermost.accounts.<id>.dmChannelRetry का उपयोग करें। डिफ़ॉल्ट:

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

    टिप्पणियाँ:

    • यह केवल DM चैनल निर्माण (/api/v4/channels/direct) पर लागू होता है, प्रत्येक Mattermost API कॉल पर नहीं।
    • पुनः प्रयास जिटर के साथ एक्सपोनेंशियल बैकऑफ़ का उपयोग करते हैं और दर सीमाओं, 5xx प्रतिक्रियाओं तथा नेटवर्क या टाइमआउट त्रुटियों जैसी अस्थायी विफलताओं पर लागू होते हैं।
    • 429 के अलावा अन्य 4xx क्लाइंट त्रुटियों को स्थायी माना जाता है और उन पर पुनः प्रयास नहीं किया जाता।

    पूर्वावलोकन स्ट्रीमिंग

    Mattermost विचार-प्रक्रिया, टूल गतिविधि और आंशिक उत्तर पाठ को एक ड्राफ़्ट पूर्वावलोकन पोस्ट में स्ट्रीम करता है, जिसे अंतिम उत्तर भेजने के लिए सुरक्षित होने पर उसी स्थान पर अंतिम रूप दिया जाता है। partial मोड में पूर्वावलोकन प्रत्येक खंड के लिए संदेश भेजकर चैनल भरने के बजाय उसी पोस्ट ID पर अपडेट होता है। block मोड में पूर्वावलोकन पूर्ण किए गए पाठ और टूल-गतिविधि ब्लॉक के बीच बदलता रहता है, ताकि पहले के ब्लॉक अगले ब्लॉक द्वारा अधिलेखित होने के बजाय अपनी अलग पोस्ट के रूप में दिखाई देते रहें। मीडिया/त्रुटि वाले अंतिम परिणाम लंबित पूर्वावलोकन संपादनों को रद्द करते हैं और बेकार पूर्वावलोकन पोस्ट को फ़्लश करने के बजाय सामान्य वितरण का उपयोग करते हैं।

    पूर्वावलोकन स्ट्रीमिंग partial मोड में डिफ़ॉल्ट रूप से चालू होती है। channels.mattermost.streaming.mode के माध्यम से कॉन्फ़िगर करें (लेगेसी स्केलर/बूलियन streaming मानों को openclaw doctor --fix द्वारा माइग्रेट किया जाता है):

    json5
    {  channels: {    mattermost: {      streaming: { mode: "partial" }, // off | partial | block | progress    },  },}
    स्ट्रीमिंग मोड
    • partial (डिफ़ॉल्ट): एक पूर्वावलोकन पोस्ट, जिसे उत्तर बढ़ने के साथ संपादित किया जाता है और फिर पूर्ण उत्तर के साथ अंतिम रूप दिया जाता है।
    • block पूर्वावलोकन को पूर्ण किए गए पाठ और टूल-गतिविधि ब्लॉक के बीच बदलता है, ताकि प्रत्येक ब्लॉक उसी स्थान पर अधिलेखित होने के बजाय अपनी अलग पोस्ट के रूप में दिखाई देता रहे। समानांतर और क्रमिक टूल अपडेट वर्तमान टूल-गतिविधि पोस्ट साझा करते हैं।
    • progress निर्माण के दौरान स्थिति पूर्वावलोकन दिखाता है और केवल पूर्ण होने पर अंतिम उत्तर पोस्ट करता है।
    • off पूर्वावलोकन स्ट्रीमिंग को अक्षम करता है। streaming.block.enabled: true के साथ, पूर्ण सहायक ब्लॉक फिर भी एकल समेकित अंतिम पोस्ट के बजाय सामान्य ब्लॉक उत्तरों (अलग-अलग पोस्ट) के रूप में वितरित किए जाते हैं।
    स्ट्रीमिंग व्यवहार संबंधी टिप्पणियाँ
    • यदि स्ट्रीम को उसी स्थान पर अंतिम रूप नहीं दिया जा सकता (उदाहरण के लिए, पोस्ट को स्ट्रीम के बीच में हटा दिया गया हो), तो OpenClaw एक नई अंतिम पोस्ट भेजता है, ताकि उत्तर कभी न खोए।
    • केवल विचार-प्रक्रिया वाले पेलोड को चैनल पोस्ट से दबा दिया जाता है, जिसमें > Thinking ब्लॉककोट के रूप में आने वाला पाठ भी शामिल है। अन्य सतहों पर विचार-प्रक्रिया देखने के लिए /reasoning on सेट करें; Mattermost की अंतिम पोस्ट में केवल उत्तर रहता है।
    • चैनल-मैपिंग मैट्रिक्स के लिए स्ट्रीमिंग देखें।

    प्रतिक्रियाएँ (संदेश टूल)

    • message action=react को channel=mattermost के साथ उपयोग करें।
    • messageId Mattermost पोस्ट ID है।
    • emoji thumbsup या :+1: जैसे नाम स्वीकार करता है (कोलन वैकल्पिक हैं)।
    • प्रतिक्रिया हटाने के लिए remove=true (बूलियन) सेट करें।
    • प्रतिक्रिया जोड़ने/हटाने की घटनाएँ रूट किए गए एजेंट सत्र में सिस्टम घटनाओं के रूप में अग्रेषित की जाती हैं और उन पर संदेशों जैसी ही DM/समूह नीति जाँच लागू होती हैं।

    उदाहरण:

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

    कॉन्फ़िगरेशन:

    • channels.mattermost.actions.reactions: प्रतिक्रिया कार्रवाइयों को सक्षम/अक्षम करें (डिफ़ॉल्ट true)।
    • प्रति-खाता ओवरराइड: channels.mattermost.accounts.<id>.actions.reactions।

    इंटरैक्टिव बटन (संदेश टूल)

    क्लिक किए जा सकने वाले बटनों के साथ संदेश भेजें। जब कोई उपयोगकर्ता किसी बटन पर क्लिक करता है, तो एजेंट चयन प्राप्त करता है और प्रतिक्रिया दे सकता है।

    बटन सिमेंटिक presentation पेलोड से आते हैं (सामान्य एजेंट उत्तरों और message action=send में)। OpenClaw मान बटनों को Mattermost इंटरैक्टिव बटनों के रूप में रेंडर करता है, URL बटनों को संदेश पाठ में दृश्यमान रखता है और चयन मेनू को पठनीय पाठ में बदल देता है।

    text
    message action=send channel=mattermost target=channel:<channelId> presentation={"blocks":[{"type":"buttons","buttons":[{"label":"Yes","value":"yes"},{"label":"No","value":"no"}]}]}

    प्रस्तुति बटन फ़ील्ड:

    labelstringrequired

    प्रदर्शित लेबल (उपनाम: text)।

    valuestring

    क्लिक करने पर वापस भेजा गया मान, जिसे कार्रवाई ID के रूप में उपयोग किया जाता है (उपनाम: callback_data, callbackData)। यदि url सेट नहीं है, तो क्लिक करने योग्य बटन के लिए आवश्यक है।

    urlstring

    लिंक बटन; इंटरैक्टिव बटन के बजाय संदेश के मुख्य भाग में label: url पाठ के रूप में रेंडर किया जाता है।

    style"primary" | "secondary" | "success" | "danger"

    बटन शैली। Mattermost उन मानों पर डिफ़ॉल्ट शैली लागू करता है जिनका वह समर्थन नहीं करता।

    एजेंट सिस्टम प्रॉम्प्ट में बटन समर्थन घोषित करने के लिए, चैनल क्षमताओं में inlineButtons जोड़ें:

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

    जब कोई उपयोगकर्ता किसी बटन पर क्लिक करता है:

  • पहुँच जाँच

    क्लिक करने वाले को संदेश प्रेषक जैसी ही DM/समूह नीति जाँच पास करनी होगी; अनधिकृत क्लिक को एक अस्थायी सूचना मिलती है और उसे अनदेखा कर दिया जाता है।

  • बटनों को पुष्टि से बदलना

    सभी बटनों को एक पुष्टि पंक्ति से बदल दिया जाता है (उदा., "✓ Yes selected by @user")।

  • एजेंट को चयन प्राप्त होता है

    एजेंट चयन को एक इनबाउंड संदेश (साथ में एक सिस्टम घटना) के रूप में प्राप्त करता है और प्रतिक्रिया देता है।

    • कार्यान्वयन संबंधी टिप्पणियाँ
    • बटन कॉलबैक HMAC-SHA256 सत्यापन का उपयोग करते हैं (स्वचालित, किसी कॉन्फ़िगरेशन की आवश्यकता नहीं)।
    • क्लिक करने पर पूरे अटैचमेंट ब्लॉक को बदल दिया जाता है, इसलिए सभी बटन एक साथ हटा दिए जाते हैं - आंशिक निष्कासन संभव नहीं है।
    • हाइफ़न या अंडरस्कोर वाली कार्रवाई ID को स्वचालित रूप से सैनिटाइज़ किया जाता है (Mattermost रूटिंग सीमा)।
    • ऐसे क्लिक, जिनका action_id मूल पोस्ट की किसी कार्रवाई से मेल नहीं खाता, 403 ("Unknown action") के साथ अस्वीकार कर दिए जाते हैं।
    कॉन्फ़िगरेशन और पहुँच-योग्यता
    • channels.mattermost.capabilities: क्षमता स्ट्रिंगों की सरणी। एजेंट सिस्टम प्रॉम्प्ट में बटन टूल का विवरण सक्षम करने के लिए "inlineButtons" जोड़ें।
    • channels.mattermost.interactions.callbackBaseUrl: बटन कॉलबैक के लिए वैकल्पिक बाहरी आधार URL (उदाहरण के लिए https://gateway.example.com)। इसका उपयोग तब करें जब Mattermost Gateway तक उसके बाइंड होस्ट पर सीधे नहीं पहुँच सकता।
    • बहु-खाता सेटअप में, आप यही फ़ील्ड channels.mattermost.accounts.<id>.interactions.callbackBaseUrl के अंतर्गत भी सेट कर सकते हैं।
    • यदि interactions.callbackBaseUrl को छोड़ दिया जाता है, तो OpenClaw gateway.customBindHost + gateway.port (डिफ़ॉल्ट 18789) से कॉलबैक URL व्युत्पन्न करता है, फिर http://localhost:<port> पर फ़ॉलबैक करता है। कॉलबैक पथ /mattermost/interactions/<accountId> है।
    • पहुँच-योग्यता नियम: बटन कॉलबैक URL Mattermost सर्वर से पहुँच योग्य होना चाहिए। localhost केवल तब काम करता है जब Mattermost और OpenClaw एक ही होस्ट/नेटवर्क नेमस्पेस पर चलते हैं।
    • channels.mattermost.interactions.allowedSourceIps: बटन कॉलबैक के लिए स्रोत-IP अनुमतिसूची। इसके बिना, केवल लूपबैक स्रोत (127.0.0.1, ::1) स्वीकार किए जाते हैं, इसलिए दूरस्थ Mattermost सर्वर को यहाँ अनुमतिसूची में जोड़ना आवश्यक है, अन्यथा उसके क्लिक 403 के साथ अस्वीकार कर दिए जाते हैं। रिवर्स प्रॉक्सी के पीछे, gateway.trustedProxies भी सेट करें, ताकि वास्तविक क्लाइंट IP अग्रेषित हेडर से व्युत्पन्न किया जाए।
    • यदि आपका कॉलबैक लक्ष्य निजी/टेलनेट/आंतरिक है, तो उसके होस्ट/डोमेन को Mattermost ServiceSettings.AllowedUntrustedInternalConnections में जोड़ें।

    प्रत्यक्ष API एकीकरण (बाहरी स्क्रिप्ट)

    बाहरी स्क्रिप्ट और Webhook एजेंट के message टूल से होकर जाने के बजाय Mattermost REST API के माध्यम से सीधे बटन पोस्ट कर सकते हैं। OpenClaw के message टूल को प्राथमिकता दें। प्रत्यक्ष एकीकरण के लिए, @openclaw/mattermost/api.js से buildButtonAttachments इंपोर्ट करें; यदि रॉ JSON पोस्ट कर रहे हैं, तो इन नियमों का पालन करें:

    पेलोड संरचना:

    json5
    {  channel_id: "<channelId>",  message: "कोई विकल्प चुनें:",  props: {    attachments: [      {        actions: [          {            id: "mybutton01", // केवल अक्षरांकीय - नीचे देखें            type: "button", // आवश्यक, अन्यथा क्लिक चुपचाप अनदेखे कर दिए जाते हैं            name: "स्वीकृत करें", // प्रदर्शित लेबल            style: "primary", // वैकल्पिक: "default", "primary", "danger"            integration: {              url: "https://gateway.example.com/mattermost/interactions/default",              context: {                action_id: "mybutton01", // बटन id से मेल खाना आवश्यक है                action: "approve",                // ... कोई भी कस्टम फ़ील्ड ...                _token: "<hmac>", // नीचे HMAC अनुभाग देखें              },            },          },        ],      },    ],  },}

    HMAC टोकन निर्माण

    Gateway HMAC-SHA256 के साथ बटन क्लिक सत्यापित करता है। बाहरी स्क्रिप्ट को ऐसे टोकन बनाने होंगे जो Gateway के सत्यापन तर्क से मेल खाते हों:

  • बॉट टोकन से सीक्रेट व्युत्पन्न करें

    HMAC-SHA256(key="openclaw-mattermost-interactions", data=botToken), हेक्स-एन्कोडेड।

  • कॉन्टेक्स्ट ऑब्जेक्ट बनाएँ

    _token को छोड़कर अन्य सभी फ़ील्ड के साथ कॉन्टेक्स्ट ऑब्जेक्ट बनाएँ।

  • क्रमबद्ध कुंजियों के साथ सीरियलाइज़ करें

    पुनरावर्ती रूप से क्रमबद्ध कुंजियों और बिना रिक्त स्थान के सीरियलाइज़ करें (Gateway नेस्टेड ऑब्जेक्ट को भी कैनोनिकलाइज़ करता है और संक्षिप्त JSON बनाता है)।

  • पेलोड पर हस्ताक्षर करें

    HMAC-SHA256(key=secret, data=serializedContext)

  • टोकन जोड़ें

    परिणामी हेक्स डाइजेस्ट को कॉन्टेक्स्ट में _token के रूप में जोड़ें।

    • Python उदाहरण:

    python
     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}
    सामान्य HMAC समस्याएँ
    • Python का json.dumps डिफ़ॉल्ट रूप से रिक्त स्थान जोड़ता है ({"key": "val"})। JavaScript के संक्षिप्त आउटपुट ({"key":"val"}) से मिलान करने के लिए separators=(",", ":") का उपयोग करें।
    • संदर्भ के सभी फ़ील्ड (_token को छोड़कर) हमेशा साइन करें। Gateway _token को हटाता है, फिर शेष सभी चीज़ों को साइन करता है। केवल कुछ फ़ील्ड साइन करने से सत्यापन बिना किसी सूचना के विफल हो जाता है।
    • sort_keys=True का उपयोग करें—Gateway साइन करने से पहले कुंजियों को क्रमबद्ध करता है और Mattermost पेलोड संग्रहीत करते समय संदर्भ फ़ील्ड का क्रम बदल सकता है।
    • सीक्रेट को रैंडम बाइट्स के बजाय बॉट टोकन से प्राप्त करें (नियतात्मक रूप से)। बटन बनाने वाली प्रक्रिया और सत्यापन करने वाले Gateway, दोनों में सीक्रेट समान होना चाहिए।

    डायरेक्टरी अडैप्टर

    Mattermost Plugin में एक डायरेक्टरी अडैप्टर शामिल है, जो Mattermost API के माध्यम से चैनल और उपयोगकर्ता नामों को हल करता है। यह openclaw message send और cron/webhook डिलीवरी में #channel-name और @username लक्ष्यों को सक्षम करता है।

    किसी कॉन्फ़िगरेशन की आवश्यकता नहीं है—अडैप्टर खाता कॉन्फ़िगरेशन से बॉट टोकन का उपयोग करता है।

    एकाधिक खाते

    Mattermost channels.mattermost.accounts के अंतर्गत एकाधिक खातों का समर्थन करता है:

    json5
    {  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" },      },    },  },}

    खाता मान शीर्ष-स्तरीय फ़ील्ड को ओवरराइड करते हैं; जब कोई खाता निर्दिष्ट नहीं होता, तब channels.mattermost.defaultAccount यह चुनता है कि किस खाते का उपयोग किया जाए।

    समस्या निवारण

    चैनलों में कोई उत्तर नहीं

    सुनिश्चित करें कि बॉट चैनल में है और उसका उल्लेख करें (oncall), किसी ट्रिगर प्रीफ़िक्स (onchar) का उपयोग करें या chatmode: "onmessage" सेट करें।

    प्रमाणीकरण या एकाधिक-खाता त्रुटियाँ
    • बॉट टोकन, बेस URL और खाता सक्षम है या नहीं, इसकी जाँच करें।
    • एकाधिक-खाता समस्याएँ: एनवायरनमेंट वेरिएबल केवल default खाते पर लागू होते हैं।
    • निजी/LAN Mattermost होस्ट के लिए network.dangerouslyAllowPrivateNetwork: true आवश्यक है (SSRF सुरक्षा डिफ़ॉल्ट रूप से निजी IP को अवरुद्ध करती है)।
    नेटिव स्लैश कमांड विफल होते हैं
    • Unauthorized: invalid command token.: OpenClaw ने कॉलबैक टोकन स्वीकार नहीं किया। सामान्य कारण:
      • स्लैश कमांड पंजीकरण विफल हुआ या स्टार्टअप के समय केवल आंशिक रूप से पूरा हुआ
      • कॉलबैक गलत Gateway/खाते तक पहुँच रहा है
      • Mattermost में अब भी पुराने कमांड हैं, जो पिछले कॉलबैक लक्ष्य की ओर संकेत करते हैं
      • स्लैश कमांड को फिर से सक्रिय किए बिना Gateway पुनः आरंभ हुआ
    • यदि नेटिव स्लैश कमांड काम करना बंद कर दें, तो लॉग में mattermost: failed to register slash commands या mattermost: native slash commands enabled but no commands could be registered की जाँच करें।
    • यदि callbackUrl छोड़ा गया है और लॉग चेतावनी देते हैं कि कॉलबैक http://localhost:18789/... जैसे लूपबैक URL में हल हुआ है, तो संभवतः वह URL केवल तभी पहुँच योग्य है जब Mattermost, OpenClaw वाले समान होस्ट/नेटवर्क नेमस्पेस पर चल रहा हो। इसके बजाय स्पष्ट रूप से बाहरी रूप से पहुँच योग्य commands.callbackUrl सेट करें।
    बटन संबंधी समस्याएँ
    • बटन सफ़ेद बॉक्स के रूप में दिखाई देते हैं या बिल्कुल दिखाई नहीं देते: बटन डेटा विकृत है। प्रत्येक प्रेज़ेंटेशन बटन के लिए एक label और एक value आवश्यक है (इनमें से कोई भी न होने वाले बटन हटा दिए जाते हैं)।
    • बटन रेंडर होते हैं, लेकिन क्लिक करने पर कुछ नहीं होता: सत्यापित करें कि Gateway तक Mattermost सर्वर से पहुँचा जा सकता है, Mattermost सर्वर का IP channels.mattermost.interactions.allowedSourceIps में शामिल है (इसके बिना केवल लूपबैक स्वीकार किया जाता है) और निजी लक्ष्यों के लिए ServiceSettings.AllowedUntrustedInternalConnections में कॉलबैक होस्ट शामिल है।
    • क्लिक करने पर बटन 404 लौटाते हैं: बटन के id में संभवतः हाइफ़न या अंडरस्कोर हैं। Mattermost का ऐक्शन राउटर गैर-अक्षरांकीय ID पर काम करना बंद कर देता है। केवल [a-zA-Z0-9] का उपयोग करें।
    • Gateway लॉग में rejected callback source: क्लिक interactions.allowedSourceIps के बाहर के IP से आया। Mattermost सर्वर या अपने इनग्रेस को अनुमति-सूची में जोड़ें और रिवर्स प्रॉक्सी के पीछे gateway.trustedProxies सेट करें।
    • Gateway लॉग में invalid _token: HMAC मिलान नहीं हुआ। जाँचें कि आपने संदर्भ के सभी फ़ील्ड (केवल कुछ फ़ील्ड नहीं) साइन किए हैं, क्रमबद्ध कुंजियों का उपयोग किया है और संक्षिप्त JSON (रिक्त स्थान के बिना) का उपयोग किया है। ऊपर दिया गया HMAC अनुभाग देखें।
    • Gateway लॉग में missing _token in context: _token फ़ील्ड बटन के संदर्भ में नहीं है। इंटीग्रेशन पेलोड बनाते समय सुनिश्चित करें कि इसे शामिल किया गया है।
    • Gateway Unknown action के साथ क्लिक अस्वीकार करता है: context.action_id पोस्ट पर मौजूद किसी ऐक्शन id से मेल नहीं खाता। दोनों को समान सैनिटाइज़ किए गए मान पर सेट करें।
    • एजेंट बटन प्रस्तुत नहीं करता: Mattermost चैनल कॉन्फ़िगरेशन में capabilities: ["inlineButtons"] जोड़ें।

    संबंधित

    Was this useful?
    On this page

    On this page