上載用於媒體或複合式資訊卡訊息的檔案。
代理程式會提供檔案網址或二進位檔,以及相對縮圖檔案的網址 (選填)。RBM 平台會將檔案快取 30 天,並傳回不重複的名稱,讓您在傳送代理程式訊息時識別該檔案。
如要上傳檔案二進位檔,請向上傳 URI 發出 HTTP POST 要求,從 JSON 要求主體中省略 fileUrl
欄位,然後將二進位檔指定為 POST 要求主體。例如,使用 --upload-file
cURL 標記搭配二進位檔案的完整檔案路徑。
HTTP 要求
- 媒體上傳要求的 URI:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- 中繼資料 URI (僅限中繼資料要求):
POST https://rcsbusinessmessaging.googleapis.com/v1/files
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "fileUrl": string, "thumbnailUrl": string, "contentDescription": string } |
欄位 | |
---|---|
fileUrl |
選填欄位,檔案的公開網址。擷取檔案時,RBM 平台會從 HTTP 標頭的 content-type 欄位中決定檔案的 MIME 類型。 支援的圖片內容類型:image/jpeg、image/jpg、image/gif、image/png。 支援的影片內容類型:video/h263、video/m4v、video/mp4、video/mpeg、video/mpeg4、video/webm。 |
thumbnailUrl |
選填欄位,與檔案對應的縮圖可公開存取的網址。如果未設定這個欄位,RBM 平台會自動從檔案產生縮圖。擷取檔案時,RBM 平台會從 HTTP 標頭的 content-type 欄位中決定檔案的 MIME 類型。 支援的圖片內容類型:image/jpeg、image/jpg、image/gif、image/png。 |
contentDescription |
選填欄位,檔案內容的文字說明。螢幕閱讀器會使用這個說明來協助身心障礙使用者瞭解檔案所含的內容。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
檔案具有專屬名稱,可讓代理程式在傳送訊息時識別該檔案。
JSON 表示法 |
---|
{ "name": string } |
欄位 | |
---|---|
name |
檔案指定的伺服器專屬名稱,代理程式可以在傳送訊息時識別檔案。格式為「files/{uid}」,其中 {uid} 是專屬 ID。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/rcsbusinessmessaging
詳情請參閱 OAuth 2.0 總覽。