调用KickRoomUser接口,实现对房间内某特定用户实施踢出房间操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用唯一标识,由6位小写字母、数字组成。 | 7m***q |
RoomId | string | 是 | 房间的唯一标识,在调用CreateRoom时返回。 | AE35****T95F |
UserId | string | 是 | 操作人的用户ID,用于表示谁执行了踢人操作。 | as****hs |
KickUser | string | 是 | 被踢出房间的用户ID。 | er****h |
BlockTime | Long | 否 | 踢出房间时长,有效时间内不能再次进入房间,单位:秒。
| 300 |
返回参数
示例
请求示例
http(s)://[Endpoint]/?Action=KickRoomUser
&AppId=7m***q
&RoomId=AE35****T95F
&UserId=as****hs
&KickUser=er****h
&BlockTime=300
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E"
}
XML
格式
<KickRoomUserResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
</KickRoomUserResponse>
错误码
访问错误中心查看更多错误码。