LiveChatMessages: insert

在聊天室中新增訊息或投票活動。

配額影響：呼叫這個方法會產生 20 個單位的配額費用。

常見用途

要求

HTTP 要求

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

授權

這項要求必須具備下列至少一個範圍的授權。如要進一步瞭解驗證和授權，請參閱「導入 OAuth 2.0 驗證」。

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

參數

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

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

要求主體

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

  • snippet.liveChatId
  • snippet.type - 選擇下列其中一個選項：textMessageEvent 或 pollEvent
  • 如果類型為 textMessageEvent，請加入 snippet.textMessageDetails.messageText
  • 如果類型為 pollEvent，請加入 snippet.pollDetails 物件，結構如下：
    • snippet.pollDetails.metadata.questionText (字串)：意見調查的主要問題。
    • snippet.pollDetails.metadata.options (陣列)：選項物件清單。
    • 規定：最少須包含 2 個項目，最多 4 個。
    • 排序：項目會按照列出的順序依序顯示。
    • 陣列中的每個物件都必須包含：
      • optionText (字串)：顯示特定投票選項的文字。

回應

如果成功，這個方法會在回應主體中傳回 liveChatMessage 資源。

錯誤

下表列出 API 在呼叫這個方法時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming 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 要求和回應。