Method: files.create

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

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

כדי להעלות קובץ בינארי, יש לשלוח בקשת HTTP POST ל-URI להעלאה, להשמיט את השדה fileUrl מגוף בקשת ה-JSON ולציין את הקובץ הבינארי כגוף של בקשת ה-POST. לדוגמה, משתמשים בסימון cURL --upload-file עם נתיב הקובץ המלא של הקובץ הבינארי.

בקשת HTTP

  • יש להעלות URI, עבור בקשות להעלאת מדיה:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI של מטא-נתונים, לבקשות למטא-נתונים בלבד:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

גוף הבקשה

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

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

string

אפשרות. כתובת ה-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

string

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

סוגי התוכן הנתמכים של תמונות: image/jpeg, image/jpg, image/gif, image/png
contentDescription

string

אפשרות. טקסט תיאור של תוכן הקובץ. קוראי מסך משתמשים בתיאור הזה כדי לעזור למשתמשים עם מוגבלויות להבין מה הקובץ מכיל.
agentId

string

חובה. המזהה הייחודי של הנציג.

גוף התגובה

משאב עם שם ייחודי שסוכן יכול להשתמש בו כדי לזהות את הקובץ בזמן שליחת הודעות.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "name": string
}
שדות
name

string

השם הייחודי של משאב הקובץ שהוקצה על ידי השרת. סוכן יכול להשתמש בו כדי לזהות את הקובץ בזמן שליחת הודעות. הפורמט הוא "files/{uid}", כאשר {uid} הוא מזהה ייחודי.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.