指定房间封禁用户
在指定的音视频房间内封禁用户。一旦封禁,用户在设置的封禁时间内无法加入该房间。
注意
被封禁用户如正在房间内,则会被自动踢出房间。
请求方法
POST:http(s)://api.rong-api.com/v2/rtc/rooms/{room_id}/block-users
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名。
路径参数
HTTP 请求路径包含以下参数:
路径参数 | 类型 | 是否必传 | 说明 |
---|---|---|---|
room_id | String | 必传 | 房间 ID,传入待封禁的用户所在房间的 ID |
正文参数
HTTP 请求正文中包含具有以下结构的 JSON 对象:
正文参数 | 类型 | 是否必传 | 说明 |
---|---|---|---|
user_ids | String[] | 必传 | 待封禁用户的 ID 集合 |
minute | Number | 必传 | 封禁时长,单位为分钟。最小是 1,最大为 43200 |
请求示例
POST /v2/rtc/rooms/room001/block-users HTTP/1.1
Host: api.rong-api.com
RC-App-Key: xxxxxxxxxx
RC-Timestamp: 1408710653491
RC-Nonce: 14314
RC-Signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"user_ids": [
"user_1",
"user_2"
],
"minute": 10, //单位(分钟)
}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
code
:HTTP 响应正文中的业务码,10000
为处理成功。