Method: spaces.messages.create

在 Google Chat 聊天室中建立訊息。如需範例,請參閱「建立訊息」。

呼叫這個方法需要驗證,並支援下列驗證類型:

  • 對於簡訊,系統支援使用者驗證或應用程式驗證。
  • 卡片訊息僅支援應用程式驗證。(只有 Chat 應用程式可以建立資訊卡訊息)。

HTTP 要求

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

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

路徑參數

參數
parent

string

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

格式︰spaces/{space}

查詢參數

參數
threadKey
(deprecated)

string

選用設定。已淘汰:請改用 thread.thread_key。執行緒 ID。長度上限為 4,000 個半形字元。如要開始或新增至討論串,請建立訊息並指定 threadKeythread.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 IDthreadKey
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD 以回覆 thread IDthreadKey 指定的討論串的形式建立訊息。如果失敗,訊息會改為發起新的討論串。
REPLY_MESSAGE_OR_FAIL 以回覆 thread IDthreadKey 指定的討論串的形式建立訊息。使用新的 threadKey 時,系統會建立新的執行緒。如果訊息建立失敗,系統會改為傳回 NOT_FOUND 錯誤。