स्लैक में अपना खुद का कस्टम स्लैश कमांड बनाएं

स्लैक एक उपकरण है जो टीमों को संवाद करने और सहयोग करने की अनुमति देता है। इसकी प्रमुख विशेषताओं में से एक स्लैश कमांड का उपयोग है। ये आदेश प्लेटफ़ॉर्म के भीतर विशिष्ट क्रियाओं या एकीकरण को ट्रिगर करते हैं।

जबकि स्लैक आपको कई अंतर्निहित स्लैश कमांड प्रदान करता है, आप स्लैक के एपीआई का उपयोग करके कस्टम कमांड बना सकते हैं। जब कोई उपयोगकर्ता इसे ट्रिगर करता है तो आप एक निश्चित कार्य करने के लिए कस्टम कमांड को कॉन्फ़िगर कर सकते हैं।

स्लैक में कस्टम स्लैश कमांड क्यों बनाएं?

स्लैक के अंतर्निहित स्लैश आदेश आपकी टीम या संगठन की विशिष्ट आवश्यकताओं को पूरा नहीं कर सकते हैं। कस्टम स्लैश कमांड बनाकर, आप अपनी टीम के लिए अधिक वैयक्तिकृत अनुभव बना सकते हैं। यह बदले में टीम की व्यस्तता को बढ़ाता है।

स्लैक ऐप सेट करना

पालन ​​करने के लिए, आपको इसके साथ सहज होना चाहिए स्लैक का मूल उपयोग. ब्राउज़र में अपने स्लैक खाते में साइन इन करें और एक नया वर्कस्पेस बनाएं। अपनी टीम के कार्यक्षेत्र में अपने ऐप्स का उपयोग करने से पहले आप इस कार्यस्थान का परीक्षण करने के लिए उपयोग करेंगे।

एक और टैब खोलें और नेविगेट करें सुस्त एपीआई वेबसाइट.

पर क्लिक करें एक ऐप बनाएं बटन। दिखाई देने वाले अगले पृष्ठ पर, ऐप बनाने का विकल्प चुनें शुरूुआत से.

ऐप को नाम दें और कार्यक्षेत्र का चयन करें जिसमें ऐप काम करेगा।

क्लिक करें ऐप बनाएं बटन। यह आपको उस पृष्ठ पर पुनर्निर्देशित करेगा जिसमें आपके ऐप के बारे में बुनियादी जानकारी है।

सुविधाएँ अनुभाग में, नेविगेट करें OAuth और अनुमतियाँ सुविधा, फिर नीचे स्क्रॉल करें बॉट टोकन स्कोप. एक जोड़ना चैट: लिखो आपके ऐप के लिए दायरा। यह दायरा आपके ऐप को कार्यक्षेत्र में संदेश भेजने की अनुमति देगा।

तक स्क्रॉल करें आपके कार्यक्षेत्र के लिए OAuth टोकन अनुभाग, और पर क्लिक करें कार्यक्षेत्र में स्थापित करें बटन।

दिखाई देने वाले अगले पृष्ठ पर, पर क्लिक करें अनुमति देना बटन। यह आपके कार्यक्षेत्र में ऐप को इंस्टॉल कर देगा।

स्लैक एपीआई का उपयोग करके कस्टम स्लैश कमांड बनाना

स्लैक ऐप को सेट करने के बाद, आपको उस कार्य के लिए एक कस्टम कमांड बनाना होगा जिसे आप पूरा करना चाहते हैं। उदाहरण के लिए, एक स्लैश कमांड जो उपयोक्ता को चुटकुला देता है। पर नेविगेट करें स्लैश कमांड विशेषता। पर क्लिक करें नया कमांड बनाएं बटन।

भरें आज्ञा, अनुरोध यूआरएल, और संक्षिप्त वर्णन आप जिस कमांड को बनाना चाहते हैं। जब उपयोगकर्ता कमांड को ट्रिगर करता है, तो अनुरोध URL वह समापन बिंदु होता है, जिस पर Slack एक POST अनुरोध भेजता है। प्लेसहोल्डर के रूप में लोकलहोस्ट URL का उपयोग करें; आप इस यूआरएल को बाद में बदल देंगे।

पर क्लिक करें बचाना. जब आप सहेजते हैं, तो Slack आपके ऐप के लिए स्वचालित रूप से कमांड स्कोप जोड़ देता है। यह दायरा आपके ऐप को शॉर्टकट और स्लैश कमांड जोड़ने की अनुमति देता है जिसका उपयोग आपके कार्यक्षेत्र के लोग कर सकते हैं। कार्यक्षेत्रों को बदलने के लिए आपको ऐप को फिर से इंस्टॉल करना होगा। पर क्लिक करें अपने ऐप को फिर से इंस्टॉल करें बटन।

अगले पृष्ठ पर दिखाई देने वाले पृष्ठ पर, अपने कार्यस्थान पर एप्लिकेशन को पुनः इंस्टॉल करने की अनुमति दें क्लिक करें।

स्लैश कमांड के व्यवहार को कॉन्फ़िगर करना

किसी भी पायथन आईडीई को लॉन्च करें। एक नया आभासी वातावरण बनाएँ. एक नई पायथन फ़ाइल और एक नई .env फ़ाइल बनाएँ। टर्मिनल पर, आवश्यक लाइब्रेरी स्थापित करने के लिए निम्न कमांड चलाएँ।

पिप इंस्टाल पाइथन-डोटेनव फ्लास्क स्लैक-बोल्ट का अनुरोध करता है

python-dotenv पुस्तकालय आपको .env फ़ाइल में पर्यावरण चर लोड करने की अनुमति देगा। अनुरोध पुस्तकालय आपको HTTP अनुरोध करने देता है और फ्लास्क आने वाले HTTP अनुरोधों को संभालता है और प्रतिक्रियाएँ लौटाता है। सुस्त बोल्ट आने वाले सुस्त अनुरोधों को संभालता है।

.env फ़ाइल खोलें और दो पर्यावरण चर बनाएँ। उन्हे नाम दो BOT_TOKEN और SIGNING_SECRET क्रमश। स्लैक एपीआई वेबसाइट पर नेविगेट करें। आपके ऐप के तहत मूल जानकारी साइनिंग सीक्रेट को कॉपी करें और BOT_TOKEN वैरिएबल को इनिशियलाइज़ करने के लिए इसका इस्तेमाल करें। OAuth और अनुमतियां सुविधा पर नेविगेट करें और बॉट उपयोगकर्ता OAuth टोकन कॉपी करें। SIGNING_SECRET वेरिएबल को इनिशियलाइज़ करने के लिए इसका इस्तेमाल करें।

बॉट टोकन एक विशिष्ट पहचानकर्ता है जो एपीआई कॉल करते समय आपके ऐप को स्लैक के एपीआई के साथ प्रमाणित करता है। साइनिंग सीक्रेट यह सत्यापित करता है कि आपके ऐप पर आने वाले अनुरोध स्लैक से आ रहे हैं।

पूर्ण स्रोत कोड a में उपलब्ध है गिटहब रिपॉजिटरी.

आवश्यक पुस्तकालयों और मॉड्यूलों को आयात करें।

आयात ओएस
से pathlib आयात पथ
से dotenv आयात load_dotenv
आयात अनुरोध
से फ्लास्क आयात कुप्पी, अनुरोध, jsonify
से slack_bolt आयात अनुप्रयोग
से slack_bolt.adapter.flask आयात SlackRequestHandler

फ्लास्क एप्लिकेशन का एक नया उदाहरण बनाएं।

ऐप = फ्लास्क (__name__)

का उपयोग करके .env फ़ाइल से पर्यावरण चर लोड करें load_dotenv () समारोह।

env_path = पथ ('.') / '.env'
load_dotenv (dotenv_path=env_path)

का उपयोग करके स्लैक ऐप का एक नया उदाहरण बनाएं अनुप्रयोग वर्ग slack_bolt पुस्तकालय से।

slack_app = ऐप (
 टोकन = ओएस पर्यावरण ['BOT_TOKEN'],
 signing_secret=os.environ['SIGNING_SECRET']
)

एक रूट हैंडलर फ़ंक्शन बनाएँ जो आने वाले अनुरोधों को संभालता है /slack/command समापन बिंदु। जब समापन बिंदु एक प्राप्त करता है डाक अनुरोध, यह अनुरोध निकाय डेटा को पार्स करता है। यह तब जाँचता है कि कमांड है या नहीं /joke. यदि ऐसा है, तो यह कॉल करता है get_joke () कार्य करता है और कमांड के परिणाम के साथ स्लैक को JSON प्रतिक्रिया देता है।

@app.route("/slack/command", मेथड्स=["POST"])
डीईएफ़आज्ञा():
# पार्स बॉडी डेटा का अनुरोध करें
 डेटा = अनुरोध.फॉर्म
# स्लैश कमांड के आधार पर उपयुक्त फ़ंक्शन को कॉल करें
अगर आंकड़े["आज्ञा"] == "/चुटकुला":
 संदेश = get_joke ()
अन्य:
 संदेश = च"अमान्य आदेश: {आंकड़े['आज्ञा']}"
# स्लैक को प्रतिक्रिया दें
वापस करना jsonify({"मूलपाठ": संदेश})

एक ऐसा फ़ंक्शन बनाएं जो GET अनुरोध भेजता है icanhazdadjoke एपीआई जेएसओएन प्रारूप में एक यादृच्छिक मजाक पुनर्प्राप्त करने के लिए। यह फिर मजाक को एक स्ट्रिंग के रूप में लौटाता है।

डीईएफ़get_joke():
 यूआरएल = " https://icanhazdadjoke.com/"
 हेडर = {"स्वीकार करना": "एप्लिकेशन/जेसन"}
 प्रतिक्रिया = अनुरोध प्राप्त करें (यूआरएल, हेडर = हेडर, टाइमआउट =5)
 मजाक = प्रतिक्रिया.जेसन () ["चुटकुला"]
वापस करना चुटकुला

एक का एक नया उदाहरण बनाएँ SlackRequestHandler ऑब्जेक्ट जो स्लैक से आने वाले अनुरोधों को संभालेगा।

हैंडलर = SlackRequestHandler (slack_app)

जांचें कि क्या स्क्रिप्ट सीधे चल रही है और यदि यह चल रही है, तो पोर्ट 5000 पर फ्लास्क एप्लिकेशन शुरू करें।

अगर __नाम__ == "__मुख्य__":
# फ्लास्क ऐप को पोर्ट 5000 पर शुरू करें
 ऐप.रन (पोर्ट =5000, डिबग =सत्य)

लोकलहोस्ट पर चल रहे सर्वर को शुरू करने के लिए प्रोग्राम चलाएँ।

कार्यक्रम के लिए स्लैक के साथ संवाद करने के लिए, आपको एक यूआरएल की आवश्यकता है जिसे वह इंटरनेट पर एक्सेस कर सके। डाउनलोड करें और चलाएं ngrok. ngrok सॉफ़्टवेयर आपको एक सुरक्षित सार्वजनिक URL बनाने की अनुमति देता है जो आपके कंप्यूटर पर चल रहे वेब सर्वर पर ट्रैफ़िक को टनल करता है।

सार्वजनिक URL प्राप्त करने के लिए निम्न कमांड चलाएँ:

एनग्रोक http 5000

नीचे दी गई छवि सफेद रंग में हाइलाइट किए गए सार्वजनिक URL को ngrok पर दिखाती है।

URL को कॉपी करें और Slack API वेबसाइट पर जाएँ। पर क्लिक करें स्लैश कमांड विशेषता। / मजाक आदेश संपादित करें और अनुरोध URL प्लेसहोल्डर को अपने सार्वजनिक URL से बदलें। अपने समापन बिंदु को इंगित करने के लिए URL के अंत में /slack/events जोड़ें।

अपने वर्कस्पेस पर जाएं, फिर टाइप करें और/जोक कमांड भेजें। आपको जवाब में एक चुटकुला देखना चाहिए:

अन्य स्लैक सुविधाओं से परिचित हों

स्लेक कमांड के अलावा स्लैक में बहुत सी विशेषताएं हैं। इन सुविधाओं से खुद को परिचित कराने से आप यह समझ पाएंगे कि ये कैसे काम करते हैं।

फिर आप उन्हें अपने कार्यक्षेत्र की आवश्यकताओं के अनुसार अनुकूलित करने के तरीकों की तलाश कर सकते हैं। इससे आपकी टीम की उत्पादकता बढ़ेगी।