调用ListLiveMessageGroupUsers查询群组用户列表。
接口说明
调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。
对于超级大群(超过 2000 人的群组),不再提供成员列表查询。并且群成员进出群组通知之间会至少间隔 5s,通知中不显示全部进出用户列表,但显示精确群人数。群组一旦升级为超级大群,群成员列表会马上清空,无法再恢复为普通群组,直到所有群成员退出群组(群组关闭),重新开启时才会恢复为普通群组。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:ListLiveMessageGroupUsers |
list |
*Rtc
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
需要查询的直播互动应用 ID。 |
demo |
| GroupId |
string |
是 |
需要查询的群组的 GroupID。 |
grouptest |
| PageSize |
integer |
是 |
一次显示的用户数量,取值范围**[10,50]**。 |
10 |
| SortType |
integer |
是 |
排序方式,按用户加入群组时间先后进行排序。取值:
枚举值:
|
1 |
| NextPageToken |
integer |
否 |
查询页的起始位置,若为空则默认为首页。 |
1 |
| DataCenter |
string |
否 |
数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 |
cn-shanghai |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
A1D75BEA-1329-116F-B29C-76F3F200**** |
| GroupId |
string |
需要查询的群组的 GroupID。 |
grouptest |
| NextPageToken |
integer |
下一页的起始位置,若没有下一页则为 0。 |
0 |
| Hasmore |
boolean |
是否有下一页。 |
false |
| UserList |
array<object> |
对象数组。 |
|
|
object |
数组详情。 |
||
| UserId |
string |
查询的用户 ID。 |
uid1 |
| UserInfo |
string |
用户扩展信息。 |
info1 |
示例
正常返回示例
JSON格式
{
"RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
"GroupId": "grouptest",
"NextPageToken": 0,
"Hasmore": false,
"UserList": [
{
"UserId": "uid1",
"UserInfo": "info1"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 420 | SuperLargeGroup | %s. | 当群成员超过2000人时,群组升级为超级大群,不再支持查询用户列表 |
| 400 | InputInvalid | %s. | 输入参数不合法 |
| 500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
| 403 | NoAuth | %s. | 没有权限 |
| 404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。