Method: files.create

यह कुकी, मीडिया या रिच कार्ड मैसेज में इस्तेमाल करने के लिए कोई फ़ाइल अपलोड करती है.

एजेंट, फ़ाइल का यूआरएल या बाइनरी और (ज़रूरी नहीं) उससे जुड़े थंबनेल फ़ाइल का यूआरएल देता है.

अहम जानकारी: उपयोगकर्ता की निजता और सुरक्षा के लिए, RCS for Business प्लैटफ़ॉर्म, दिए गए यूआरएल से मीडिया और PDF फ़ाइलें डाउनलोड करता है और उन्हें प्रोसेस करता है. इसके बाद, उन्हें उपयोगकर्ता को भेजता है. इससे यूनीक यूआरएल के ज़रिए एजेंट को ट्रैक करने से रोका जा सकता है. इसलिए, बड़ी संख्या में यूनीक यूआरएल सबमिट न करें. RCS for Business प्लैटफ़ॉर्म पर यह सुविधा काम नहीं करती. भले ही, यूआरएल एक ही फ़ाइल की ओर ले जाते हों या अलग-अलग फ़ाइलों की ओर. एक जैसी फ़ाइलों के लिए, एक ही यूआरएल का इस्तेमाल करें.

कारोबार के लिए आरसीएस की सुविधा देने वाला प्लैटफ़ॉर्म, फ़ाइल को 60 दिनों के लिए कैश मेमोरी में सेव करता है. साथ ही, एक यूनीक नाम देता है. इस नाम का इस्तेमाल, एजेंट के मैसेज भेजते समय फ़ाइल की पहचान करने के लिए किया जा सकता है.

फ़ाइल बाइनरी अपलोड करने के लिए, अपलोड यूआरआई को एचटीटीपी पोस्ट अनुरोध करें. साथ ही, JSON अनुरोध के मुख्य हिस्से से fileUrl फ़ील्ड हटाएं और बाइनरी को पोस्ट अनुरोध के मुख्य हिस्से के तौर पर तय करें. उदाहरण के लिए, बाइनरी फ़ाइल के पूरे पाथ के साथ --upload-file cURL फ़्लैग का इस्तेमाल करें.

एचटीटीपी अनुरोध

  • मीडिया अपलोड करने के अनुरोधों के लिए, अपलोड यूआरआई:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • सिर्फ़ मेटाडेटा के अनुरोधों के लिए मेटाडेटा यूआरआई:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "agentId": string
}
फ़ील्ड
fileUrl

string

ज़रूरी नहीं. फ़ाइल का ऐसा यूआरएल जो सार्वजनिक तौर पर उपलब्ध हो. RCS for Business प्लैटफ़ॉर्म, फ़ाइल फ़ेच करते समय एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से फ़ाइल का MIME टाइप तय करता है. RCS for Business में इमेज, ऑडियो, वीडियो, और PDF फ़ाइलें भेजी जा सकती हैं.

इमेज के लिए इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/gif, image/png.

इस्तेमाल किए जा सकने वाले ऑडियो कॉन्टेंट टाइप: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg.

इस्तेमाल किए जा सकने वाले वीडियो कॉन्टेंट टाइप: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

PDF कॉन्टेंट के लिए इस्तेमाल किए जा सकने वाले टाइप: application/pdf.

ध्यान दें: किसी फ़ाइल के यूआरएल में एक रीडायरेक्ट हो सकता है. रीडायरेक्ट की गई फ़ाइल के यूआरएल ऐसे होने चाहिए जिन्हें कोई भी ऐक्सेस कर सके. CreateAgentMessageRequest में फ़ाइल के यूआरएल के लिए, रीडायरेक्ट करने की सुविधा काम नहीं करती.
thumbnailUrl

string

ज़रूरी नहीं. फ़ाइल से जुड़े थंबनेल का ऐसा यूआरएल जो सार्वजनिक तौर पर उपलब्ध हो. अगर यह फ़ील्ड सेट नहीं किया जाता है, तो RCS for Business प्लैटफ़ॉर्म, फ़ाइल से थंबनेल अपने-आप जनरेट कर देता है. RCS for Business प्लैटफ़ॉर्म, फ़ाइल फ़ेच करते समय एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से फ़ाइल का MIME टाइप तय करता है.

इमेज के लिए इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/gif, image/png.
agentId

string

ज़रूरी है. एजेंट का यूनीक आइडेंटिफ़ायर.

जवाब का मुख्य भाग

यह एक फ़ाइल रिसॉर्स है. इसका नाम यूनीक होता है. एजेंट इसका इस्तेमाल, मैसेज भेजते समय फ़ाइल की पहचान करने के लिए कर सकता है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "name": string
}
फ़ील्ड
name

string

यह फ़ाइल रिसॉर्स के लिए, सर्वर की ओर से असाइन किया गया यूनीक नाम होता है. एजेंट इसका इस्तेमाल, मैसेज भेजते समय फ़ाइल की पहचान करने के लिए कर सकते हैं. इसका फ़ॉर्मैट "files/{uid}" होता है. यहां {uid} एक यूनीक आईडी है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.