在聊天室中新增訊息或民意調查。
常見用途
要求
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
- 如果 type 為
pollEvent
,請加入snippet.pollDetails
,並使用下列值:snippet.pollDetails.metadata.options.questionText
snippet.pollDetails.metadata.options.optionText
清單。您必須列出至少兩項,最多五項。項目會依照列出的順序依序顯示。
回應
如果成功的話,這個方法會在回應內文中傳回 liveChatMessage 資源。
錯誤
下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming API - Errors」。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
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 要求和回應。