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