فایلی را برای استفاده در رسانه یا پیام های کارت غنی آپلود می کند.
عامل URL یا باینری فایل و (به صورت اختیاری) URL فایل تصویر کوچک مربوطه را ارائه می کند. پلت فرم RBM فایل را به مدت 30 روز در حافظه پنهان نگه می دارد و یک نام منحصر به فرد را برمی گرداند که می توانید برای شناسایی فایل هنگام ارسال پیام های نماینده استفاده کنید.
برای آپلود یک فایل باینری، یک درخواست HTTP POST به URI آپلود کنید، فیلد fileUrl
را از بدنه درخواست JSON حذف کنید و باینری را به عنوان بدنه درخواست POST مشخص کنید. برای مثال، از پرچم --upload-file
cURL با مسیر فایل کاملا واجد شرایط فایل باینری استفاده کنید.
درخواست HTTP
- URI آپلود، برای درخواست های آپلود رسانه:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- URI فراداده، برای درخواستهای فقط فراداده:
POST https://rcsbusinessmessaging.googleapis.com/v1/files
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "contentDescription": string, "agentId": string } |
زمینه های | |
---|---|
fileUrl | اختیاری. URL فایل در دسترس عموم. هنگام واکشی فایل، پلتفرم RBM نوع MIME فایل را از قسمت نوع محتوا در هدرهای HTTP تعیین می کند. انواع محتوای تصویر پشتیبانی شده: image/jpeg، image/jpg، image/gif، image/png. انواع محتوای ویدیویی پشتیبانی شده: video/h263، video/m4v، video/mp4، video/mpeg، video/mpeg4، video/webm. |
thumbnailUrl | اختیاری. URL تصویر کوچک مربوط به فایل به صورت عمومی در دسترس است. اگر این فیلد تنظیم نشده باشد، پلت فرم RBM به طور خودکار یک تصویر کوچک از فایل ایجاد می کند. هنگام واکشی فایل، پلتفرم RBM نوع MIME فایل را از قسمت نوع محتوا در هدرهای HTTP تعیین می کند. انواع محتوای تصویر پشتیبانی شده: image/jpeg، image/jpg، image/gif، image/png. |
contentDescription | اختیاری. توضیحات متنی محتوای فایل صفحهخوانها از این توضیحات برای کمک به کاربران معلول برای درک محتوای فایل استفاده میکنند. |
agentId | ضروری. شناسه منحصر به فرد عامل. |
بدن پاسخگو
یک منبع فایل با یک نام منحصر به فرد که یک نماینده می تواند برای شناسایی فایل هنگام ارسال پیام استفاده کند.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "name": string } |
زمینه های | |
---|---|
name | نام منحصر به فرد منبع فایل اختصاص داده شده به سرور، که یک عامل می تواند برای شناسایی فایل هنگام ارسال پیام استفاده کند. قالب "files/{uid}" است، که در آن {uid} یک شناسه منحصر به فرد است. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/rcsbusinessmessaging
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.