Method: files.create

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

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

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

פלטפורמת RCS for Business שומרת את הקובץ במטמון למשך 60 ימים ומחזירה שם ייחודי שבו אפשר להשתמש כדי לזהות את הקובץ כששולחים הודעות לנציג.

כדי להעלות קובץ בינארי, שולחים בקשת 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,
  "agentId": string
}
שדות
fileUrl

string

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

הערה: כתובת URL של קובץ יכולה לכלול הפניה אוטומטית אחת. כתובות URL של קבצים שמופנים מחדש חייבות להיות נגישות לכולם. אין תמיכה בהפניות אוטומטיות לכתובות URL של קבצים ב-CreateAgentMessageRequest.
thumbnailUrl

string

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