上傳檔案,以便在媒體或互動式資訊卡訊息中使用。
代理程式會提供檔案的網址或二進位檔,以及 (選用) 對應縮圖檔案的網址。
重要事項:為保護使用者隱私和安全,RCS 企業通訊平台會先從提供的網址下載並處理媒體和 PDF 檔案,再傳送給使用者。這樣可避免代理商透過專屬網址追蹤使用者。因此,請勿提交大量專屬網址。無論網址指向相同或不同檔案,RCS 企業即時通訊平台都不支援這類做法。相同檔案使用相同網址。
RCS Business Messaging 平台會將檔案快取 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 |
(選用步驟) 檔案的公開網址。RCS 企業通訊平台在擷取檔案時,會根據 HTTP 標頭中的 content-type 欄位判斷檔案的 MIME 類型。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。 注意:檔案網址只能有一個重新導向。重新導向的檔案網址必須可公開存取。CreateAgentMessageRequest 中的檔案網址不支援重新導向。 |
thumbnailUrl |
(選用步驟) 檔案對應縮圖的公開網址。如未設定這個欄位,RCS 企業通訊平台會自動從檔案產生縮圖。RCS 企業通訊平台在擷取檔案時,會根據 HTTP 標頭中的 content-type 欄位判斷檔案的 MIME 類型。 支援的圖片內容類型:image/jpeg、image/jpg、image/gif、image/png。 |
agentId |
必要欄位。代理程式的專屬 ID。 |
回應主體
檔案資源,具有專屬名稱,代理程式傳送訊息時可使用此名稱識別檔案。
如果成功,回應主體會含有以下結構的資料:
| JSON 表示法 |
|---|
{ "name": string } |
| 欄位 | |
|---|---|
name |
伺服器為檔案資源指派的專屬名稱,專員傳送訊息時可使用這個名稱識別檔案。格式為「files/{uid}」,其中 {uid} 是專屬 ID。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/rcsbusinessmessaging
詳情請參閱OAuth 2.0 Overview。