BanAllComment - 全员禁言

调用BanAllComment接口,禁言房间内所有用户。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间的唯一标识,在调用CreateRoom时返回。

AE35****T95F
UserIdstring

操作人的用户ID,用于表示谁执行了全员禁言操作。

as****hs

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultboolean

获取全员禁言的调用结果。

true

示例

请求示例

http(s)://[Endpoint]/?Action=BanAllComment
&AppId=7m***q
&RoomId=AE35****T95F
&UserId=as****hs
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": true
}

XML格式

<BanAllCommentResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>true</Result>
</BanAllCommentResponse>

错误码

Http code错误码错误信息
400Forbidden.Comment.NoPermissionToOperateThe user has no permission to operate

访问错误中心查看更多错误码。

检查用户是否有权限禁言全员,若无权限则报错误Forbidden.Comment.NoPermissionToOperate。

阿里云首页 低代码音视频工厂 相关技术圈