禁止特定使用者參與聊天室。頻道擁有者或與遭停權直播聊天室相關的聊天室管理員必須授權 API 要求。
常見用途
要求
HTTP 要求
POST https://www.googleapis.com/youtube/v3/liveChat/bans
授權
這項要求需要至少具備下列其中一個範圍的授權。如要進一步瞭解驗證和授權,請參閱「實作 OAuth 2.0 驗證」。
範圍 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string part 參數在這項作業中具有兩個用途。它會指出寫入作業會設定的屬性,以及 API 回應傳回的屬性。將參數值設為 snippet 。 |
要求主體
請在要求主體中提供 liveChatBan 資源。針對該資源:
-
您必須為下列屬性指定值:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
您可以為這些屬性設定值:
snippet.banDurationSeconds
回應
如果成功的話,這個方法會在回應內文中傳回 liveChatBan 資源。
錯誤
下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming API - Errors」。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
insufficientPermissions |
你沒有必要的權限,無法將使用者從指定的即時通訊中封鎖。 |
forbidden (403) |
liveChatBanInsertionNotAllowed |
無法建立指定的禁止內容。如果要求嘗試封鎖聊天室擁有者或其他版主,就可能發生此錯誤。 |
invalidValue (400) |
invalidChannelId |
找不到指定的管道 ID。 |
invalidValue (400) |
invalidLiveChatId |
要求中指定的 snippet.liveChatId 值無效。檢查相關聯的 liveBroadcast 資源,確認您有正確的值。 |
notFound (404) |
liveChatNotFound |
找不到指定的即時通訊。檢查相關聯的 liveBroadcast 資源,確認您已將 snippet.liveChatId 屬性設為正確的值。 |
notFound (404) |
liveChatUserNotFound |
找不到你要停權的聊天室使用者。 |
required (400) |
bannedUserChannelIdRequired |
在要求主體中提交的 liveChatBan 資源必須指定 snippet.bannedUserDetails.channelId 屬性的值。 |
required (400) |
liveChatIdRequired |
在要求主體中提交的 liveChatBan 資源必須指定 snippet.liveChatId 屬性的值。 |
試試看!
使用 APIs Explorer 呼叫此 API,並查看 API 要求和回應。