- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- इसे आज़माएं!
Google Chat के किसी स्पेस में मैसेज बनाता है. उदाहरण के लिए, मैसेज भेजना देखें.
पुष्टि के इन तरीकों का इस्तेमाल किया जा सकता है:
- ऐप्लिकेशन की पुष्टि करने के लिए, अनुमति पाने का लिंक:
https://www.googleapis.com/auth/chat.bot
- उपयोगकर्ता की पुष्टि, इनमें से किसी एक अनुमति के दायरे में होनी चाहिए:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(सिर्फ़ इंपोर्ट मोड वाले स्पेस)
Chat, मैसेज भेजने वाले व्यक्ति को अलग-अलग तरीके से एट्रिब्यूट करता है. यह इस बात पर निर्भर करता है कि आपने अपने अनुरोध में किस तरह की पुष्टि का इस्तेमाल किया है.
यहां दी गई इमेज में दिखाया गया है कि ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करने पर, Chat किसी मैसेज को कैसे एट्रिब्यूट करता है. Chat, मैसेज भेजने वाले के तौर पर Chat ऐप्लिकेशन को दिखाता है. मैसेज के कॉन्टेंट में टेक्स्ट (text), कार्ड (cardsV2), और ऐक्सेसरी विजेट (accessoryWidgets) शामिल हो सकते हैं.
यहां दी गई इमेज में दिखाया गया है कि उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल करने पर, Chat किसी मैसेज को कैसे एट्रिब्यूट करता है. Chat, उपयोगकर्ता को मैसेज भेजने वाले के तौर पर दिखाता है. साथ ही, मैसेज के साथ Chat ऐप्लिकेशन का नाम दिखाकर, उसे मैसेज का एट्रिब्यूशन देता है. मैसेज के कॉन्टेंट में सिर्फ़ टेक्स्ट (text) शामिल हो सकता है.
मैसेज का साइज़ 32,000 बाइट से ज़्यादा नहीं होना चाहिए. इसमें मैसेज का कॉन्टेंट भी शामिल है.
वेबहुक अनुरोधों के लिए, जवाब में पूरा मैसेज शामिल नहीं होता. जवाब में, अनुरोध में दी गई जानकारी के अलावा, सिर्फ़ name और thread.name फ़ील्ड की जानकारी भरी जाती है.
एचटीटीपी अनुरोध
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
parent |
ज़रूरी है. उस स्पेस के संसाधन का नाम जिसमें मैसेज बनाना है. फ़ॉर्मैट: |
क्वेरी पैरामीटर
| पैरामीटर | |
|---|---|
threadKey |
ज़रूरी नहीं. अब इस्तेमाल नहीं किया जा सकता: इसके बजाय, |
requestId |
ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आईडी. हमारा सुझाव है कि आप रैंडम यूयूआईडी का इस्तेमाल करें. अनुरोध आईडी की जानकारी देने से, अनुरोध को आइडेंपोटेंट बनाया जाता है. इससे यह पक्का होता है कि एक ही अनुरोध आईडी वाले कई अनुरोधों के लिए, सिर्फ़ एक मैसेज बनाया जाए. एक ही अनुरोध आईडी वाले बाद के अनुरोध, मौजूदा मैसेज दिखाते हैं और मैसेज को अपडेट नहीं करते. भले ही, अनुरोध की गई जानकारी मौजूदा स्थिति से अलग हो. इस फ़ील्ड का असरदार तरीके से इस्तेमाल करने के लिए:
|
messageReplyOption |
ज़रूरी नहीं. इससे पता चलता है कि कोई मैसेज, थ्रेड शुरू करता है या किसी थ्रेड का जवाब देता है. यह सुविधा सिर्फ़ नाम वाले स्पेस में काम करती है. उपयोगकर्ता के इंटरैक्शन का जवाब देते समय, इस फ़ील्ड को अनदेखा कर दिया जाता है. किसी थ्रेड में मौजूद मैसेज का जवाब देने पर, वह जवाब उसी थ्रेड में दिखता है. ऐसा न करने पर, जवाब को एक नई थ्रेड के तौर पर बनाया जाता है. |
messageId |
ज़रूरी नहीं. मैसेज के लिए कस्टम आईडी. इससे चैट ऐप्लिकेशन, मैसेज के संसाधन के नाम (मैसेज इस फ़ील्ड की वैल्यू, इन ज़रूरी शर्तों के मुताबिक होनी चाहिए:
ज़्यादा जानकारी के लिए, मैसेज को नाम देना लेख पढ़ें. |
createMessageNotificationOptions |
ज़रूरी नहीं. मैसेज पोस्ट होने पर, सूचना के व्यवहार को कंट्रोल करता है. ज़्यादा जानने के लिए, सूचनाएं भेजने के लिए मजबूर करना या साइलेंट मैसेज भेजना लेख पढ़ें. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में Message का उदाहरण है.
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Message का नया इंस्टेंस शामिल किया जाता है.
अनुमति पाने के लिंक
इनमें से किसी एक OAuth स्कोप की ज़रूरत हाेती है:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.
MessageReplyOption
इससे पता चलता है कि किसी मैसेज का जवाब कैसे दिया जाए. आने वाले समय में, इसमें और राज्यों को जोड़ा जा सकता है.
| Enums | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
डिफ़ॉल्ट. इससे नई थ्रेड शुरू होती है. इस विकल्प का इस्तेमाल करने पर, शामिल किए गए किसी भी thread ID या को अनदेखा कर दिया जाता है. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
यह thread ID या से तय किए गए थ्रेड के जवाब के तौर पर मैसेज बनाता है. अगर ऐसा नहीं होता है, तो मैसेज एक नई थ्रेड शुरू कर देता है. |
REPLY_MESSAGE_OR_FAIL |
यह thread ID या से तय किए गए थ्रेड के जवाब के तौर पर मैसेज बनाता है. अगर किसी नए threadKey का इस्तेमाल किया जाता है, तो एक नई थ्रेड बन जाती है. अगर मैसेज नहीं बन पाता है, तो NOT_FOUND गड़बड़ी का मैसेज दिखता है. |
CreateMessageNotificationOptions
मैसेज पोस्ट होने पर, सूचना पाने के तरीके के विकल्प.
| JSON के काेड में दिखाना |
|---|
{
"notificationType": enum ( |
| फ़ील्ड | |
|---|---|
notificationType |
मैसेज के लिए सूचना का टाइप. |
NotificationType
मैसेज के लिए, सूचना के टाइप के विकल्प.
| Enums | |
|---|---|
NOTIFICATION_TYPE_NONE |
डिफ़ॉल्ट ऐक्शन और सेटिंग. सूचना का व्यवहार वैसा ही होता है जैसा कि Chat के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, कोई व्यक्ति मैसेज भेजता है: मैसेज भेजने वाले व्यक्ति को कोई सूचना नहीं भेजी जाती. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
मैसेज बनाने वाले उपयोगकर्ता को एक सूचना (पुश नोटिफ़िकेशन, ईमेल से मिली सूचना वगैरह) भेजी जाती है. उदाहरण के लिए, वह उपयोगकर्ता जिसकी पुष्टि का इस्तेमाल करके मैसेज बनाया गया था. साथ ही, मैसेज को 'नहीं पढ़ा गया' के तौर पर मार्क किया जाता है. इससे स्पेस के लिए, उपयोगकर्ता की मौजूदा सूचना सेटिंग नहीं बदलेगी. उदाहरण के लिए, अगर किसी उपयोगकर्ता ने किसी स्पेस के लिए सूचनाएं न पाने का विकल्प चुना है, तो यह विकल्प सेट होने पर भी उसे सूचना नहीं मिलेगी. इसके लिए, उपयोगकर्ता की पुष्टि ज़रूरी है. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
ईमेल पाने वाले लोगों को सूचना देना ज़रूरी है. इससे उपयोगकर्ताओं की स्पेस की सूचना सेटिंग और Chat की 'परेशान न करें' सेटिंग बायपास हो जाती हैं. यह विकल्प, डिवाइस-लेवल पर सेट की गई 'परेशान न करें' सेटिंग को बायपास नहीं करता. इसके लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है. |
NOTIFICATION_TYPE_SILENT |
ईमेल पाने वाले लोगों को सूचना न दें और ईमेल को 'नहीं पढ़ा गया' के तौर पर मार्क न करें. यह सुविधा, बातचीत को म्यूट करने या Chat में 'परेशान न करें' मोड चालू करने की तरह ही काम करती है. इसके लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है. |