查询互动消息群组详细信息_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

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

返回数据

名称	类型	示例值	描述
RequestId	String	1815A27D-BAE2-10E6-89FD-D477951C****	请求ID。
GroupId	String	grouptest	群组ID。
CreatorId	String	uid1	创建者ID。
AdminList	Array of String	["uid1","uid2"]	管理员。
Createtime	Long	1698305471	创建时间，用UNIX时间戳表示，单位：秒。
GroupName	String	mytestgroup	群组名。
GroupInfo	String	testgroupinfo	群组扩展信息。
Delete	Boolean	false	是否已删除。
TotalTimes	Long	50	总Session次数。群组存在时才有此参数。
OnlineUserCounts	Long	2	当前在线的群用户数。群组存在时才有此参数。
MsgAmount	Map		消息数分类统计。群组存在时才有此参数。
	Long	{1 : 20, 2 : 30}	消息数。
Deletatime	Long	1698299827	删除时间。群组已被删除时才有此参数。
Deletor	String	uid1	删除者。群组已被删除时才有此参数。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeLiveMessageGroupResponse>
    <RequestId>1815A27D-BAE2-10E6-89FD-D477951C****</RequestId>
    <GroupId>grouptest</GroupId>
    <CreatorId>uid1</CreatorId>
    <AdminList>["uid1","uid2"]</AdminList>
    <Createtime>1698305471</Createtime>
    <GroupName>mytestgroup</GroupName>
    <GroupInfo>testgroupinfo</GroupInfo>
    <Delete>false</Delete>
    <TotalTimes>50</TotalTimes>
    <OnlineUserCounts>2</OnlineUserCounts>
     <MsgAmount>{1:20,2:30}</MsgAmount>
</DescribeLiveMessageGroupResponse>

JSON格式

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

{
  "RequestId" : "1815A27D-BAE2-10E6-89FD-D477951C****",
  "GroupId" : "grouptest",
  "CreatorId" : "uid1",
  "AdminList" : "[\"uid1\",\"uid2\"]",
  "Createtime" : 1698305471,
  "GroupName" : "mytestgroup",
  "GroupInfo" : "testgroupinfo",
  "Delete" : false,
  "TotalTimes" : 50,
  "OnlineUserCounts" : 2,
  "MsgAmount" : "{1:20,2:30}"
}

错误码

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

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