Method: spaces.messages.create

在 Google Chat 聊天室中建立訊息。如需範例，請參閱「傳送訊息」一文。

create() 方法需要使用者驗證或應用程式驗證。Chat 會根據您在要求中使用的驗證類型，決定訊息傳送者的方式。

下圖說明使用應用程式驗證時，Chat 如何為訊息加上屬性。Chat 會將 Chat 應用程式顯示為訊息傳送者。訊息內容可包含文字 (text)、資訊卡 (cardsV2) 和配件小工具 (accessoryWidgets)。

訊息以應用程式驗證方式傳送

下圖顯示使用者驗證功能時，Chat 如何歸屬訊息。Chat 會將使用者顯示為訊息傳送者，並顯示 Chat 應用程式的名稱，以便將訊息歸屬給該應用程式。訊息內容只能包含文字 (text)。

使用者驗證後傳送的郵件

郵件大小 (包括郵件內容) 的上限為 32,000 個位元組。

對於 webhook 要求，回應不會包含完整訊息。除了要求中的資訊之外，回應只會填入 name 和 thread.name 欄位。

HTTP 要求

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。建立訊息的聊天室資源名稱。

格式：spaces/{space}

查詢參數

參數
threadKey
(deprecated)

string

選用設定。已淘汰：請改用 thread.thread_key。執行緒的 ID。最多支援 4000 個半形字元。如要開始或新增至討論串，請建立訊息並指定 threadKey 或 thread.name。如需使用說明，請參閱「發起或回覆訊息串」。
requestId

string

選用設定。此訊息的專屬要求 ID。指定現有的要求 ID 後，系統將傳回使用該 ID 建立的訊息，而不會建立新訊息。
messageReplyOption

enum (MessageReplyOption)

選用設定。指定訊息是發起討論串還是回覆討論串。僅支援在已命名的聊天室中使用。

回應使用者互動時，系統會忽略這個欄位。如果是討論串內的互動，回覆會建立在同一討論串中。否則系統會建立新的討論串。
messageId

string

選用設定。訊息的自訂 ID。讓 Chat 應用程式能夠取得、更新或刪除訊息，而無須將系統指派的 ID 儲存在訊息的資源名稱 (在訊息的 name 欄位中顯示)。

這個欄位的值必須符合下列規定：

  • 開頭為 client-。例如，client-custom-name 是有效的自訂 ID，但 custom-name 則不是。
  • 長度上限為 63 個半形字元，且只能使用小寫英文字母、數字和連字號。
  • 在單一空間中不得重複。Chat 應用程式無法為不同的訊息使用相同的自訂 ID。

詳情請參閱「命名訊息」。

要求主體

要求主體包含 Message 的例項。

回應主體

如果成功，回應主體會包含新建立的 Message 例項。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

詳情請參閱授權指南。

MessageReplyOption

指定回覆訊息的方式。日後可能會新增更多州別。

列舉
MESSAGE_REPLY_OPTION_UNSPECIFIED 預設。啟動新執行緒。使用這個選項會忽略任何包含的 thread ID 或 threadKey。
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD 建立訊息，用於回覆 thread ID 或 threadKey 指定的會話串。如果失敗，則訊息會改為啟動新的執行緒。
REPLY_MESSAGE_OR_FAIL 建立訊息，用於回覆 thread ID 或 threadKey 指定的會話串。如果使用新的 threadKey，系統就會建立新的執行緒。如果訊息建立作業失敗，系統會改為傳回 NOT_FOUND 錯誤。