用户禁言
更新时间:2025-05-07
接口描述
禁止用户发言,用户说话无法被其他用户听见。
- 需要注意该接口动作是临时动作,用户重新加入房间后,之前的禁言操作会失效。
请求(Request)
请求URI
JSON
1PUT /v1/clientuser/ban HTTP/1.1
请求头域
除公共头域外,无其它特殊头域。
请求体
参数名 | 类型 | 是否必需 | 描述 |
---|---|---|---|
appId | String | 是 | 应用ID |
roomName | String | 是 | 房间名 |
clientUserId | Long | 是 | 用户ID |
streams | List[String] | 否 | 具体需要禁的流 如果需要封禁视频,则添加video 如果需要封禁音频,则添加audio 如果音视频都封禁,则不需要设置stream参数 |
响应(Response)
响应头域
除公共头域外,无其它特殊头域。
响应体
无
示例
请求示例
JSON
1PUT /v1/clientuser/ban HTTP/1.1
2host: rtc.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
6{
7 "appId": "testapp",
8 "roomName": "6543211234",
9 "clientUserId": 123,
10 "streams": [
11 "video"
12 ]
13}
响应示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache