- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- इसे आज़माएं!
Google Chat स्पेस में कोई मैसेज बनाता है. उदाहरण के लिए, मैसेज भेजना लेख पढ़ें.
इन तरह के authentication का इस्तेमाल किया जा सकता है:
- अनुमति के दायरे के साथ ऐप्लिकेशन की पुष्टि करना:
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_FORCE_NOTIFY |
मैसेज पाने वालों को सूचना दें. इससे, उपयोगकर्ताओं के स्पेस की सूचना सेटिंग और Chat की 'परेशान न करें' सेटिंग को अनदेखा किया जाता है. इस विकल्प से, डिवाइस-लेवल पर 'परेशान न करें' मोड की सेटिंग बायपास नहीं होती हैं. इसके लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है. |
NOTIFICATION_TYPE_SILENT |
ईमेल पाने वाले लोगों को सूचना न दें और ईमेल को 'पढ़ा नहीं गया' के तौर पर मार्क न करें. यह सुविधा, बातचीत को म्यूट करने या Chat पर 'परेशान न करें' मोड चालू करने जैसी है. इसके लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है. |