LiveChatMessages: insert

在聊天室中新增訊息或意見調查。

常見用途

要求

HTTP 要求

POST https://www.googleapis.com/youtube/v3/liveChat/messages

授權

這項要求需要至少擁有下列其中一個範圍的授權 (進一步瞭解驗證和授權)。

範圍
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

參數

下表列出這個查詢支援的參數。這裡列出的所有參數都是查詢參數。

參數
必要參數
part string
part 參數有以下兩種用途。它會識別要設定寫入作業的屬性,以及 API 回應中包含的屬性。將參數值設為 snippet

要求主體

在要求主體中提供 liveChatMessage 資源。 您必須為該資源指定這些屬性的值

  • snippet.liveChatId
  • snippet.type - 請選擇下列其中一個選項:textMessageEventpollEvent
  • 如果類型為 textMessageEvent,請加入 snippet.textMessageDetails.messageText
  • 如果類型為 pollEvent,請加入下列值的 snippet.pollDetails
    • snippet.pollDetails.metadata.options.questionText
    • snippet.pollDetails.metadata.options.optionText 清單。您必須列出至少兩個項目,最多 5 個項目。項目會依序顯示。

回應

如果成功,這個方法會在回應內文中傳回 liveChatMessage 資源

錯誤

下表顯示 API 為回應這個方法時,可能會傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳情 說明
forbidden (403) forbidden 您沒有必要權限,無法建立指定訊息。
forbidden (403) liveChatDisabled 擁有者已停用您指定的聊天室,因此無法將訊息新增至聊天室。
forbidden (403) liveChatEnded 指定的聊天室已結束。
invalidValue (400) messageTextInvalid 訊息文字 (snippet.textMessageDetails.messageText) 無效。
notFound (404) liveChatNotFound API 要求中指定的聊天室不存在。如果聊天室擁有者刪除了即時通訊,就會發生這個錯誤。
required (400) liveChatIdRequired 請務必在 liveChatMessage 資源中加入並指定 snippet.liveChatId 屬性的值。
required (400) messageTextRequired 請務必在 liveChatMessage 資源中加入並指定 snippet.textMessageDetails.messageText 屬性的值。
required (400) typeRequired 請務必在 liveChatMessage 資源中加入並指定 snippet.type 屬性的值。將參數值設為 text
required (400) preconditionCheckFailed 已有置頂的意見調查,
rateLimitExceeded rateLimitExceeded 在特定時間範圍內,使用者發布的聊天室訊息過多。

試試看!

請使用 APIs Explorer 呼叫這個 API,並查看 API 要求和回應。