ListLiveMessageGroupUsers分页
查询群组用户列表
服务地址:
华东2(上海)
输入参数
只看必填
AppId需要查询的直播互动应用ID
GroupId需要查询的群组的GroupID
SortType排序方式
DataCenter数据中心
分页参数
PageSize一次显示的用户数量
NextPageToken查询页的起始位置
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。
  • 对于超级大群(超过 2000 人的群组),不再提供成员列表查询。并且群成员进出群组通知之间会至少间隔 5s,通知中不显示全部进出用户列表,但显示精确群人数。群组一旦升级为超级大群,群成员列表会马上清空,无法再恢复为普通群组,直到所有群成员退出群组(群组关闭),重新开启时才会恢复为普通群组。

QPS 限制

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

请求参数

字段名称字段详情
AppIdstring

需要查询的直播互动应用 ID。

示例值:demo
GroupIdstring

需要查询的群组的 GroupID。

示例值:grouptest参考取值来源:
    ListMessageGroup
PageSizeinteger<int32>

一次显示的用户数量,取值范围**[10,50]**。

示例值:10取值 <= 30
SortTypeinteger<int32>

排序方式,按用户加入群组时间先后进行排序。取值:展开详情

示例值:1枚举值:12取值 <= 2
NextPageTokeninteger<int64>

查询页的起始位置,若为空则默认为首页。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
DataCenterstring

数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。

示例值:cn-shanghai

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:A1D75BEA-1329-116F-B29C-76F3F200****
GroupIdstring

需要查询的群组的 GroupID。

示例值:grouptest
NextPageTokeninteger<int64>

下一页的起始位置,若没有下一页则为 0。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:0
Hasmoreboolean

是否有下一页。

示例值:false
UserListarray<object>

对象数组。

变更历史
变更时间变更内容概要操作
2025-03-26
新增错误码420