Method: files.create

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

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

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

RBM प्लैटफ़ॉर्म, फ़ाइल को 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

ज़रूरी नहीं. फ़ाइल का सार्वजनिक तौर पर उपलब्ध यूआरएल. RBM प्लैटफ़ॉर्म, फ़ाइल को फ़ेच करते समय एचटीटीपी हेडर में मौजूद content-type फ़ील्ड से फ़ाइल का MIME टाइप तय करता है. आरबीएम में इमेज, ऑडियो, वीडियो, और 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.

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

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

string

ज़रूरी नहीं. फ़ाइल से जुड़े थंबनेल का सार्वजनिक तौर पर उपलब्ध यूआरएल. अगर यह फ़ील्ड सेट नहीं है, तो RBM प्लैटफ़ॉर्म फ़ाइल से अपने-आप थंबनेल जनरेट करता है. RBM प्लैटफ़ॉर्म, फ़ाइल को फ़ेच करते समय एचटीटीपी हेडर में मौजूद content-type फ़ील्ड से फ़ाइल का 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 देखें.