Method: files.create

העלאת קובץ לשימוש בהודעות עם מדיה או כרטיסים עשירים.

הסוכן מספק את כתובת ה-URL או את הקובץ הבינארי של הקובץ, ואפשרותית גם את כתובת ה-URL של קובץ התמונה הממוזערת התואם.

חשוב: כדי לשמור על פרטיות המשתמשים ועל האבטחה שלהם, פלטפורמת RBM מורידת ומעבדת קובצי מדיה וקובצי PDF מכתובות ה-URL שסופקו לפני שהיא מעבירה אותם למשתמש. כך אפשר למנוע מעקב אחר סוכנים לפי כתובות URL ייחודיות. לכן, אל תשלחו כמות גדולה של כתובות URL ייחודיות. פלטפורמת RBM לא תומכת בכך, גם אם כתובות ה-URL מפנות לאותו קובץ וגם אם הן מפנות לקבצים שונים. להשתמש באותה כתובת URL לקבצים זהים.

פלטפורמת RBM שומרת את הקובץ במטמון למשך 60 יום ומחזירה שם ייחודי שאפשר להשתמש בו כדי לזהות את הקובץ כששולחים הודעות לסוכנים.

כדי להעלות קובץ בינארי, שולחים בקשת POST ב-HTTP למזהה ה-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 משתמשת בתחביר של Transcoding של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "agentId": string
}
שדות
fileUrl

string

זה שינוי אופציונלי. כתובת ה-URL של הקובץ שגלויה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-HTTP בזמן אחזור הקובץ. RBM תומך בתמונות, בקובצי אודיו, בסרטונים ובקובצי 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.
thumbnailUrl

string

זה שינוי אופציונלי. כתובת URL זמינה לכולם של התמונה הממוזערת התואמת לקובץ. אם השדה הזה לא מוגדר, פלטפורמת RBM יוצרת תמונה ממוזערת מהקובץ באופן אוטומטי. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-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.