Cấm một người dùng cụ thể tham gia cuộc trò chuyện trực tiếp. Yêu cầu API phải được chủ sở hữu kênh hoặc người kiểm duyệt của cuộc trò chuyện trực tiếp liên kết với lệnh cấm đó phê duyệt.
Các trường hợp sử dụng phổ biến
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Ủy quyền
Yêu cầu này yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).
Phạm vi |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Các tham số
Bảng sau trình bày các tham số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.
Các tham số | ||
---|---|---|
Các thông số bắt buộc | ||
part |
string Tham số part phục vụ hai mục đích trong hoạt động này. Thẻ này xác định các thuộc tính mà thao tác ghi sẽ đặt cũng như các thuộc tính mà phản hồi API trả về. Đặt giá trị thông số thành snippet . |
Nội dung yêu cầu
Cung cấp tài nguyên liveChatBan trong phần nội dung yêu cầu. Đối với tài nguyên đó:
-
Bạn phải chỉ định một giá trị cho các thuộc tính này:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
Bạn có thể đặt giá trị cho các thuộc tính sau:
snippet.banDurationSeconds
Phản hồi
Nếu thành công, phương thức này sẽ trả về một tài nguyên liveChatBan trong nội dung phản hồi.
Lỗi
Bảng sau đây xác định các thông báo lỗi mà API có thể trả về khi một lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm thông tin chi tiết.
Loại lỗi | Thông tin chi tiết về lỗi | Mô tả |
---|---|---|
forbidden (403) |
insufficientPermissions |
Bạn không có các quyền cần thiết để cấm người dùng tham gia cuộc trò chuyện trực tiếp đã chỉ định. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Không thể tạo lệnh cấm được chỉ định. Lỗi này có thể xảy ra nếu yêu cầu cố gắng cấm chủ sở hữu cuộc trò chuyện hoặc một người kiểm duyệt khác. |
invalidValue (400) |
invalidChannelId |
Không tìm thấy mã nhận dạng kênh được chỉ định. |
invalidValue (400) |
invalidLiveChatId |
Giá trị snippet.liveChatId được chỉ định trong yêu cầu không hợp lệ. Hãy kiểm tra tài nguyên liveBroadcast liên kết để đảm bảo bạn có giá trị chính xác. |
notFound (404) |
liveChatNotFound |
Không tìm thấy cuộc trò chuyện trực tiếp đã chỉ định. Kiểm tra tài nguyên liveBroadcast liên kết để đảm bảo rằng bạn đang đặt thuộc tính snippet.liveChatId thành giá trị chính xác. |
notFound (404) |
liveChatUserNotFound |
Không tìm thấy người dùng trò chuyện trực tiếp mà bạn đang cố gắng cấm. |
required (400) |
bannedUserChannelIdRequired |
Tài nguyên liveChatBan được gửi trong nội dung yêu cầu phải chỉ định một giá trị cho thuộc tính snippet.bannedUserDetails.channelId . |
required (400) |
liveChatIdRequired |
Tài nguyên liveChatBan được gửi trong nội dung yêu cầu phải chỉ định một giá trị cho thuộc tính snippet.liveChatId . |
Hãy dùng thử!
Hãy dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.