इस सेक्शन में बताया गया है कि Google Chat ऐप्लिकेशन, Chat एपीआई को कैसे कॉल कर सकता है. इससे Chat ऐप्लिकेशन कई तरह के काम कर सकते हैं. जैसे, स्पेस बनाना, उसमें लोगों को जोड़ना, और Chat ऐप्लिकेशन के साथ इंटरैक्शन के इवेंट की सूचना मिले बिना, मैसेज पोस्ट करना.
पुष्टि करना
Chat API को एसिंक्रोनस रूप से कॉल करने के लिए, पुष्टि करने की ज़रूरत होती है. Chat API के हर तरीके के लिए, उपयोगकर्ता की पुष्टि करना (उपयोगकर्ता की ओर से कार्रवाइयां करने या डेटा ऐक्सेस करने के लिए) या ऐप्लिकेशन से पुष्टि करने (Chat ऐप्लिकेशन के तौर पर डेटा ऐक्सेस करने या कार्रवाइयां करने के लिए) की ज़रूरत होती है. कुछ तरीके, उपयोगकर्ता की पुष्टि करने और ऐप्लिकेशन की पुष्टि करने, दोनों की सुविधा देते हैं.
Chat में पुष्टि करने के बारे में ज़्यादा जानने के लिए, पुष्टि करने से जुड़ी खास जानकारी लेख पढ़ें.
एपीआई के संसाधन और तरीके
REST के संसाधन और तरीके, चैट स्पेस, स्पेस के सदस्यों, मैसेज, मैसेज पर प्रतिक्रियाएं, और मैसेज अटैचमेंट का एसिंक्रोनस ऐक्सेस देते हैं.
- स्पेसेज़
स्पेसेज़ ऐसी जगहें हैं जहां लोग और ऐप्लिकेशन, फ़ाइलों के साथ बातचीत कर सकते हैं और उन्हें शेयर कर सकते हैं. स्पेस कई तरह के होते हैं. डायरेक्ट मैसेज (DM) दो उपयोगकर्ताओं या एक उपयोगकर्ता और Chat ऐप्लिकेशन के बीच 1:1 बातचीत होते हैं. ग्रुप चैट, तीन या उससे ज़्यादा उपयोगकर्ताओं और चैट ऐप्लिकेशन के बीच होने वाली बातचीत होती है. नाम वाले स्पेस वे स्थायी जगहें हैं जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम करते हैं.
spacesरिसॉर्स स्पेस के बारे में बताता है.स्पेसेज़ में इन तरीकों का इस्तेमाल किया जा सकता है:
- स्पेस बनाएं, ऐसी जगह जहां लोग और ऐप्लिकेशन, फ़ाइलों से बातचीत कर सकें और उन्हें शेयर कर सकें.
- स्पेस सेट अप करें और उसमें लोगों और चैट ऐप्लिकेशन को जोड़ें.
- किसी स्पेस के बारे में जानकारी देखने के लिए, स्पेस पाएं.
- स्पेस की पेज नंबर वाली और फ़िल्टर की जा सकने वाली सूची देखने के लिए, स्पेस की सूची बनाएं.
- किसी स्पेस की विशेषताओं, जैसे कि उपयोगकर्ता को दिखने वाला डिसप्ले नेम, ब्यौरा, और दिशा-निर्देश बदलने के लिए, स्पेस को अपडेट करें.
- ज़रूरत न होने पर, स्पेस को मिटाएं.
- दो उपयोगकर्ताओं के बीच DM या कॉल करने वाले Chat ऐप्लिकेशन के बीच DM भेजने के लिए डायरेक्ट मैसेज (DM) ढूंढें.
- सदस्य
सदस्य ऐसे उपयोगकर्ता और चैट ऐप्लिकेशन होते हैं जो स्पेस में शामिल हुए हैं या जिन्हें स्पेस में शामिल होने का न्योता भेजा गया है.
spaces.membersसंसाधन किसी सदस्य के बारे में बताता है.सदस्य इन तरीकों का इस्तेमाल कर सकते हैं:
- स्पेस में उपयोगकर्ता या ऐप्लिकेशन को जोड़ने के लिए, सदस्यता बनाएं.
- पैसे चुकाकर ली जाने वाली सदस्यता के बारे में जानकारी पाने के लिए, सदस्यता लें.
- किसी स्पेस में, क्रम से लगाई गई और फ़िल्टर की जा सकने वाली सदस्यताओं की सूची देखने के लिए, सदस्यताओं की सूची बनाएं.
- किसी सदस्यता से जुड़े एट्रिब्यूट बदलने के लिए, सदस्यता अपडेट करना. जैसे, स्पेस के सदस्य को स्पेस मैनेजर बनाना या स्पेस मैनेजर को स्पेस का सदस्य बनाना.
- किसी स्पेस से उपयोगकर्ता या ऐप्लिकेशन को हटाने के लिए, सदस्यता मिटाना.
- मैसेज
मैसेज में स्पेस में पोस्ट किए गए टेक्स्ट और कार्ड की जानकारी शामिल होती है. Messages में फ़ाइलें अटैच की जा सकती हैं. लोग मैसेज पर इमोजी जोड़कर, उन पर प्रतिक्रिया दे सकते हैं.
spaces.messagesरिसॉर्स एक मैसेज दिखाता है.Messages में इन तरीकों का इस्तेमाल किया जा सकता है:
- टेक्स्ट या कार्ड मैसेज पोस्ट करने के लिए, मैसेज बनाएं. आपके पास मैसेज थ्रेड को शुरू करने या उसका जवाब देने का भी विकल्प है.
- किसी मैसेज के बारे में जानकारी पाने के लिए, मैसेज पाएं. जैसे, मैसेज कब भेजा गया था या उसमें क्या लिखा है.
- किसी स्पेस में, क्रम से लगाई गई और फ़िल्टर की जा सकने वाली सूची देखने के लिए, मैसेज की सूची बनाएं.
- मैसेज अपडेट करें, जैसे कि मैसेज के एट्रिब्यूट बदलने के लिए. किसी कार्ड मैसेज या टेक्स्ट मैसेज में एक कार्ड भी जोड़ा जा सकता है.
- ज़रूरत न होने पर मैसेज को मिटाएं.
- प्रतिक्रियाएं
प्रतिक्रियाएं से पता चलता है कि किसी मैसेज पर प्रतिक्रिया देने के लिए, लोग किस इमोजी का इस्तेमाल करते हैं. जैसे, 👍, 📣, और कदम.
spaces.messages.reactionsके संसाधन से किसी प्रतिक्रिया का पता चलता है.प्रतिक्रियाओं के साथ इन तरीकों का इस्तेमाल किया जा सकता है:
- किसी मैसेज में इमोजी जोड़ने के लिए, प्रतिक्रिया तैयार करें.
- किसी मैसेज की प्रतिक्रियाओं की ऐसी सूची देखना जिसके लिए फ़िल्टर का इस्तेमाल किया जा सकता है. इस सूची में, प्रतिक्रियाओं की सूची बनाएं.
- मैसेज से कोई इमोजी हटाने के लिए, प्रतिक्रिया मिटाएं.
- मीडिया और अटैचमेंट
मीडिया, Google Chat पर अपलोड की गई फ़ाइल को दिखाता है, जैसे कि इमेज, वीडियो, और दस्तावेज़.
mediaरिसॉर्स, मैसेज से अटैच किए गए मीडिया को दिखाता है.अटैचमेंट, मैसेज से अटैच की गई मीडिया (फ़ाइलें) के इंस्टेंस होते हैं.
spaces.messages.attachmentsरिसॉर्स एक अटैचमेंट के बारे में बताता है. अटैचमेंट में किसी मैसेज के साथ अटैच किया गया मीडिया और उससे जुड़ा मेटाडेटा शामिल होता है.मीडिया और अटैचमेंट में इन तरीकों का इस्तेमाल किया जा सकता है:
- मीडिया को Google Chat में अपलोड करने और फिर उसे मैसेज में अटैच करने के लिए, मीडिया को अटैचमेंट के तौर पर अपलोड करें.
- Google Chat से बाइनरी फ़ाइल के तौर पर डाउनलोड करने के लिए, मीडिया को अटैचमेंट के तौर पर डाउनलोड करें.
- किसी मैसेज अटैचमेंट का मेटाडेटा वापस पाने के लिए, अटैचमेंट पाएं.
- स्पेस के इवेंट
स्पेस में किए जाने वाले इवेंट, स्पेस या इसके चाइल्ड संसाधनों में होने वाले बदलावों को दिखाते हैं. इनमें सदस्य, मैसेज, और प्रतिक्रियाएं भी शामिल हैं.
spaces.spaceEventसंसाधन किसी स्पेस इवेंट को दिखाता है.स्पेस के इवेंट में, इन तरीकों का इस्तेमाल किया जा सकता है:
- किसी स्पेस में होने वाले इवेंट की जानकारी देने के लिए, स्पेस इवेंट पाएं.
- किसी स्पेस में होने वाले इवेंट की सूची पाने के लिए, स्पेस के इवेंट की सूची बनाएं.
- उपयोगकर्ता की समीक्षा की स्थिति (डेवलपर के लिए झलक)
उपयोगकर्ता के पढ़े जाने की स्थिति, सिंगलटन संसाधन होते हैं. इनसे Google Chat स्पेस या किसी मैसेज थ्रेड में, किसी खास उपयोगकर्ता के आखिरी बार पढ़े गए मैसेज की जानकारी मिलती है.
users.spacesका रिसॉर्स, स्पेस में उपयोगकर्ता के पढ़े जाने की स्थिति के बारे में बताता है.users.spaces.threadsरिसॉर्स, मैसेज थ्रेड में उपयोगकर्ता के पढ़े गए की स्थिति को दिखाता है.उपयोगकर्ता के रीड की स्थिति में इन तरीकों का इस्तेमाल किया जा सकता है:
- किसी स्पेस में उपयोगकर्ता की 'पढ़ा गया' स्थिति के बारे में जानकारी देने के लिए, स्पेस की 'पढ़ा गया' स्थिति पाएं.
- स्पेस में उपयोगकर्ता के पढ़े जाने की स्थिति को अपडेट करने के लिए, स्पेस के पढ़े जाने की स्थिति अपडेट करें.
- किसी थ्रेड में उपयोगकर्ता के 'पढ़ा गया' स्टेटस के बारे में जानकारी देने के लिए, थ्रेड रीड स्टेट पाएं.