Method: spaces.messages.create

在 Google 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 錯誤。