Method: files.create

上傳用於媒體或複合式資訊卡訊息的檔案。

代理程式會提供檔案的網址或二進位檔案，以及 (選擇性) 對應縮圖檔案的網址。RBM 平台會快取該檔案 30 天並且傳回不重複的名稱，可讓您在傳送代理程式訊息時用來識別檔案。

如要上傳檔案二進位檔，請將 HTTP POST 要求傳送至上傳 URI，然後省略 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,
  "agentId": string
}
欄位
fileUrl

string

選用設定。檔案的公開網址。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

string

選用設定。檔案對應的縮圖公開網址。如果不設定這個欄位，RBM 平台會從檔案自動產生縮圖。RBM 平台在擷取檔案時，會從 HTTP 標頭 content-type 欄位判斷檔案的 MIME 類型。

支援的圖片內容類型：image/jpeg、image/jpg、image/gif、image/png。
contentDescription

string

選用設定。檔案內容的文字說明。螢幕閱讀器會根據說明，協助身心障礙使用者瞭解檔案所含內容。
agentId

string

必要欄位。代理程式的專屬 ID。

回應主體

名稱不重複的檔案資源，可讓代理程式在傳送訊息時識別檔案。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "name": string
}
欄位
name

string

伺服器指派給檔案資源的專屬名稱，代理程式可在傳送訊息時用於識別檔案。格式為「files/{uid}」，其中 {uid} 是專屬 ID。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。