Method: files.create

上傳檔案，以便在媒體或互動式資訊卡訊息中使用。

代理程式會提供檔案的網址或二進位檔，以及 (選用) 對應縮圖檔案的網址。

重要事項：為保障使用者的隱私權和安全，RBM 平台會先從提供的網址下載及處理媒體和 PDF 檔案，再交付給使用者。這會導致代理程式無法追蹤專屬網址。因此，請勿提交大量專屬網址。無論網址指向相同或不同檔案，RBM 平台都不支援這項操作。針對相同的檔案使用相同的網址。

RBM 平台會將檔案快取 60 天，並傳回專屬名稱，方便您在傳送服務機器人訊息時識別檔案。

如要上傳檔案二進位檔，請對上傳 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,
  "agentId": string
}
欄位
fileUrl

string

選用設定。檔案的公開網址。擷取檔案時，RBM 平台會根據 HTTP 標頭中的 content-type 欄位，判斷檔案的 MIME 類型。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

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

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

string

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

回應主體

檔案資源，具有不重複的名稱，可讓服務專員在傳送訊息時識別檔案。

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

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

string

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 Overview。