Cấm một người dùng cụ thể tham gia 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 cuộc trò chuyện trực tiếp liên quan đến lệnh cấm đó uỷ quyền.
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 cần được uỷ quyền với ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).
Phạm vi |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Tham số
Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả tham số được liệt kê đều là tham số truy vấn.
Tham số | ||
---|---|---|
Tham số bắt buộc | ||
part |
string Tham số part phục vụ hai mục đích trong thao tác 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ị tham số thành snippet . |
Nội dung yêu cầu
Cung cấp tài nguyênliveChatBan trong nội dung yêu cầu. Đối với tài nguyên đó:
-
Bạn phải chỉ định giá trị cho những thuộc tính sau:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
Bạn có thể đặt giá trị cho những 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ênliveChatBan 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ề để phản hồi 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 chi tiết.
Loại lỗi | Chi tiết lỗi | Nội dung 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 đã chỉ định. Lỗi này có thể xảy ra nếu người yêu cầu tìm cách 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ệ. Kiểm tra tài nguyên liveBroadcast được liên kết để đảm bảo rằng 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 được liên kết để đảm bảo rằng bạn đang đặt thuộc tính snippet.liveChatId về đúng giá trị. |
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ố 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ử!
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.