查询用户禁言状态信息_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveMessageGroupBand	系统规定参数。取值：DescribeLiveMessageGroupBand。
AppId	String	是	demo	应用ID。
GroupId	String	是	grouptest	群组ID。
DataCenter	String	否	cn-shanghai	数据中心，需要与CreateLiveMessageApp中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。

返回数据

名称	类型	示例值	描述
RequestId	String	021D1FE7-2E87-16AC-9364-4E7EA47C****	请求ID。
GroupId	String	grouptest	群组ID。
BannedUserList	Array of String	["uid1","uid2"]	非全员禁言时，被禁言的用户。
UnbannedUserList	Array of String	["uid3"]	全员禁言时，不被禁言的用户。
IsbannedAll	Boolean	false	是否全员禁言。

示例

请求示例

http(s)://live.aliyuncs.com?Action=DescribeLiveMessageGroupBand
&AppId=demo
&GroupId=grouptest
&DataCenter=cn-shanghai
&公共请求参数

正常返回示例

XML格式

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

<DescribeLiveMessageGroupBandResponse>
    <RequestId>021D1FE7-2E87-16AC-9364-4E7EA47C****</RequestId>
    <GroupId>grouptest</GroupId>
    <BannedUserList>["uid1","uid2"]</BannedUserList>
    <UnbannedUserList>["uid3"]</UnbannedUserList>
    <IsbannedAll>false</IsbannedAll>
</DescribeLiveMessageGroupBandResponse>

JSON格式

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

{
  "RequestId" : "021D1FE7-2E87-16AC-9364-4E7EA47C****",
  "GroupId" : "grouptest",
  "BannedUserList" : [ "[\"uid1\",\"uid2\"]" ],
  "UnbannedUserList" : [ "[\"uid3\"]" ],
  "IsbannedAll" : false
}

错误码

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

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