群组全员禁言_视频直播(LIVE)-阿里云帮助中心

使用说明

调用本接口前，您必须已经调用CreateLiveMessageGroup创建互动消息群组。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	BanLiveMessageGroup	系统规定参数。取值：BanLiveMessageGroup。
AppId	String	是	demo	应用ID。
GroupId	String	是	grouptest	群组ID。
ExceptUsers	Array of String	否	["uid3"]	当开启全员禁言时不被禁言的用户，多个用半角逗号（,）隔开。说明最多不超过30个。
DataCenter	String	否	cn-shanghai	数据中心，需要与CreateLiveMessageApp中的数据中心一致。说明当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。

返回数据

名称	类型	示例值	描述
RequestId	String	84AF36BF-0B39-1F8A-A416-FAC7C484****	请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=BanLiveMessageGroup
&AppId=demo
&GroupId=grouptest
&ExceptUsers=["[\"uid3\"]"]
&DataCenter=cn-shanghai
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<BanLiveMessageGroupResponse>
    <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>
</BanLiveMessageGroupResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "84AF36BF-0B39-1F8A-A416-FAC7C484****"
}

错误码

HttpCode	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

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