查询群组用户列表_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListLiveMessageGroupUsers	系统规定参数。取值：ListLiveMessageGroupUsers。
AppId	String	是	demo	需要查询的直播互动应用ID。
GroupId	String	是	grouptest	需要查询的群组的GroupID。
PageSize	Integer	是	10	一次显示的用户数量，取值范围[10，50]。
SortType	Integer	是	1	排序方式，按用户加入群组时间先后进行排序。取值： 1：正序 2：逆序
NextPageToken	Long	否	1	查询页的起始位置，若为空则默认为首页。
DataCenter	String	否	cn-shanghai	数据中心，需要与CreateLiveMessageApp中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。

返回数据

名称	类型	示例值	描述
RequestId	String	A1D75BEA-1329-116F-B29C-76F3F200****	请求ID。
GroupId	String	grouptest	需要查询的群组的GroupID。
NextPageToken	Long	0	下一页的起始位置，若没有下一页则为0。
Hasmore	Boolean	false	是否有下一页。
UserList	Array of Users		对象数组。
UserId	String	uid1	查询的用户ID。
UserInfo	String	info1	用户扩展信息。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListLiveMessageGroupUsers
&AppId=demo
&GroupId=grouptest
&PageSize=10
&SortType=1
&NextPageToken=1
&DataCenter=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

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

<ListLiveMessageGroupUsersResponse>
    <RequestId>A1D75BEA-1329-116F-B29C-76F3F200****</RequestId>
    <GroupId>grouptest</GroupId>
    <NextPageToken>0</NextPageToken>
    <Hasmore>false</Hasmore>
    <UserList>
        <UserId>uid1</UserId>
        <UserInfo>info1</UserInfo>
    </UserList>
</ListLiveMessageGroupUsersResponse>

JSON格式

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

{
  "RequestId" : "A1D75BEA-1329-116F-B29C-76F3F200****",
  "GroupId" : "grouptest",
  "NextPageToken" : 0,
  "Hasmore" : false,
  "UserList" : [ {
    "UserId" : "uid1",
    "UserInfo" : "info1"
  } ]
}

错误码

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

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