BanComment - 禁言

调用BanComment接口,实现对房间内某特定用户实施禁言操作。

调试

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

调试

授权信息

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

请求参数

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

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

7m***q
RoomIdstring

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

AE35****T95F
UserIdstring

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

as****hs
BanCommentUserstring

被禁言的用户ID。

er****h
BanCommentTimeLong

禁言时长,单位:秒。

  • 如果不填写该字段,默认禁言30秒。

  • 传0表示永久禁言。

  • 最大值不得超过24小时,如果超过,会被限制为24小时。

30

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

获取禁言操作调用结果,true代表禁言成功,false代表禁言失败。

true

示例

请求示例

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

正常返回示例

JSON格式

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

XML格式

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

错误码

Http code错误码错误信息描述
400Forbidden.Chat.NoPermissionToOperateThe user has no permission to operate.您没有权限进行此项操作。

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

该接口仅限拥有禁言权限的用户调用,否则报错Forbidden.Comment.NoPermissionToOperate。

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