Method: files.create

فایلی را برای استفاده در پیام‌های رسانه‌ای یا کارت‌های غنی بارگذاری می‌کند.

عامل، URL یا فایل باینری و (به صورت اختیاری) URL فایل تصویر بندانگشتی مربوطه را ارائه می‌دهد.

مهم: برای حفظ حریم خصوصی و امنیت کاربر، پلتفرم RCS for Business فایل‌های رسانه‌ای و PDF را قبل از تحویل به کاربر، از URLهای ارائه شده دانلود و پردازش می‌کند. این کار از ردیابی توسط URLهای منحصر به فرد توسط اپراتور جلوگیری می‌کند. بنابراین، حجم زیادی از URLهای منحصر به فرد ارسال نکنید. پلتفرم RCS for Business از این قابلیت پشتیبانی نمی‌کند، چه URLها به فایل‌های یکسان یا متفاوت اشاره داشته باشند. برای فایل‌های یکسان از URL یکسان استفاده کنید.

پلتفرم RCS for Business فایل را به مدت ۶۰ روز در حافظه پنهان (cache) ذخیره می‌کند و یک نام منحصر به فرد برمی‌گرداند که می‌توانید هنگام ارسال پیام‌های مربوط به نمایندگان، از آن برای شناسایی فایل استفاده کنید.

برای آپلود یک فایل باینری، یک درخواست HTTP POST به آدرس آپلود (Upload URI) ارسال کنید، فیلد fileUrl را از بدنه درخواست JSON حذف کنید و فایل باینری را به عنوان بدنه درخواست POST مشخص کنید. برای مثال، از پرچم cURL --upload-file به همراه مسیر کامل فایل باینری استفاده کنید.

درخواست HTTP

  • آپلود URI، برای درخواست‌های آپلود رسانه:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • آدرس URL فراداده، برای درخواست‌های فقط فراداده:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "agentId": string
}
فیلدها
fileUrl

string

اختیاری. آدرس اینترنتی (URL) فایل که به صورت عمومی در دسترس است. پلتفرم RCS for Business هنگام دریافت فایل، نوع MIME فایل را از فیلد نوع محتوا در هدرهای HTTP تعیین می‌کند. 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

اختیاری. آدرس اینترنتی (URL) تصویر بندانگشتی مربوط به فایل که به صورت عمومی در دسترس است. اگر این فیلد تنظیم نشود، پلتفرم RCS for Business به طور خودکار یک تصویر بندانگشتی از فایل ایجاد می‌کند. پلتفرم RCS for Business هنگام دریافت فایل، نوع MIME فایل را از فیلد نوع محتوا در هدرهای HTTP تعیین می‌کند.

انواع محتوای تصویری پشتیبانی‌شده: 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 .