मीडिया या रिच कार्ड मैसेज में इस्तेमाल करने के लिए फ़ाइल अपलोड करता है.
एजेंट, फ़ाइल का यूआरएल या बाइनरी देता है और (वैकल्पिक तौर पर) उससे जुड़ी थंबनेल फ़ाइल का यूआरएल भी उपलब्ध कराता है. आरबीएम प्लैटफ़ॉर्म, फ़ाइल को 30 दिनों के लिए कैश मेमोरी में सेव रखता है. साथ ही, एक खास नाम देता है, जिसका इस्तेमाल एजेंट मैसेज भेजते समय फ़ाइल की पहचान करने के लिए किया जा सकता है.
फ़ाइल बाइनरी को अपलोड करने के लिए, अपलोड यूआरआई पर एचटीटीपी POST अनुरोध करें, JSON अनुरोध के मुख्य हिस्से में fileUrl
फ़ील्ड को छोड़ दें और बाइनरी को POST अनुरोध के मुख्य हिस्से के तौर पर बताएं. उदाहरण के लिए, बाइनरी फ़ाइल के पूरी तरह क्वालिफ़ाइड फ़ाइल पाथ के साथ --upload-file
cURL फ़्लैग का इस्तेमाल करें.
एचटीटीपी अनुरोध
- मीडिया अपलोड करने के अनुरोधों के लिए, यूआरआई अपलोड करें:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- सिर्फ़ मेटाडेटा से जुड़े अनुरोधों के लिए, मेटाडेटा यूआरआई:
POST https://rcsbusinessmessaging.googleapis.com/v1/files
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "fileUrl": string, "thumbnailUrl": string, "contentDescription": string, "agentId": string } |
फ़ील्ड | |
---|---|
fileUrl |
ज़रूरी नहीं. फ़ाइल का सार्वजनिक तौर पर उपलब्ध यूआरएल. आरबीएम प्लैटफ़ॉर्म, फ़ाइल फ़ेच करते समय एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से, फ़ाइल का MIME टाइप तय करता है. इमेज के लिए इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/gif, image/png. इस्तेमाल किए जा सकने वाले वीडियो कॉन्टेंट के टाइप: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. |
thumbnailUrl |
ज़रूरी नहीं. फ़ाइल से जुड़े थंबनेल का यूआरएल, जो सार्वजनिक तौर पर उपलब्ध है. अगर यह फ़ील्ड सेट नहीं है, तो आरबीएम प्लैटफ़ॉर्म अपने-आप फ़ाइल से थंबनेल जनरेट करता है. आरबीएम प्लैटफ़ॉर्म, फ़ाइल फ़ेच करते समय एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से, फ़ाइल का MIME टाइप तय करता है. इमेज के लिए इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/gif, image/png. |
contentDescription |
ज़रूरी नहीं. फ़ाइल के कॉन्टेंट के बारे में जानकारी देने वाला टेक्स्ट. स्क्रीन रीडर इस जानकारी का इस्तेमाल, दिव्यांग उपयोगकर्ताओं को यह समझने में मदद करने के लिए करते हैं कि फ़ाइल में क्या है. |
agentId |
ज़रूरी है. एजेंट का यूनीक आइडेंटिफ़ायर. |
जवाब का मुख्य भाग
एक खास नाम वाला फ़ाइल रिसॉर्स. इसका इस्तेमाल करके एजेंट, मैसेज भेजते समय फ़ाइल की पहचान कर सकता है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "name": string } |
फ़ील्ड | |
---|---|
name |
फ़ाइल संसाधन का सर्वर से असाइन किया गया यूनीक नाम. इसका इस्तेमाल करके कोई एजेंट, मैसेज भेजते समय फ़ाइल की पहचान कर सकता है. इसका फ़ॉर्मैट "files/{uid}" है, जिसमें {uid} एक यूनीक आईडी है. |
अनुमति देने के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/rcsbusinessmessaging
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.