- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- 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 |
ज़रूरी नहीं. किसी मैसेज के लिए, कस्टम आईडी. इससे Chat ऐप्लिकेशन, मैसेज के संसाधन नाम (मैसेज के इस फ़ील्ड की वैल्यू के लिए, ये ज़रूरी शर्तें पूरी होनी चाहिए:
ज़्यादा जानकारी के लिए, किसी मैसेज को नाम देना देखें. |
createMessageNotificationOptions |
ज़रूरी नहीं. इससे यह कंट्रोल किया जाता है कि मैसेज पोस्ट होने पर, सूचना कैसे दिखेगी. ज़्यादा जानने के लिए, सूचनाएं भेजना या बिना सूचना वाले मैसेज भेजना देखें. |
अनुरोध का मुख्य हिस्सा
अनुरोध के मुख्य भाग में Message का उदाहरण है.
जवाब का मुख्य हिस्सा
अगर अनुरोध सही से काम करता है, तो जवाब के मुख्य हिस्से में Message का नया उदाहरण शामिल होता है.
अनुमति पाने के लिंक
इसके लिए, अनुमति पाने के इन लिंक में से किसी एक लिंक की ज़रूरत होती है:
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 के 'परेशान न करें' मोड को चालू करने जैसा होता है. इसके लिए, ऐप्लिकेशन की मदद से पुष्टि करना ज़रूरी है. |