App 管理员可以根据群组 ID 获取直播群在线成员列表。该功能需旗舰版,并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该 API 返回最近进群的成员列表(最多返回30人)。
群组类型 ID | 是否支持此 REST API |
---|---|
Private | 不支持,同新版本中的 Work(好友工作群) |
Public | 不支持 |
ChatRoom | 不支持,同新版本中的 Meeting(临时会议群) |
AVChatRoom | 支持 |
Community(社群) | 不支持 |
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统。
注意:
- 此功能需 旗舰版套餐,并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
- 其他套餐版本调用该 API 返回最近进群的成员列表(最多返回30人)。
- 在线成员列表总体更新粒度为10s。
- 当直播群中超过1000人时,接口仅返回最新进群并且在线的1000人。
- 当群人数大于等于300或群内有 Web 端用户的时候,出现群成员上下线或者进退群的时候,由于当前10s周期内已经统计了用户在线状态的原因,会在下一个10s周期才会统计到剔除状态用户变更的在线人数,所以会出现调用接口10s - 20s才会更新的现象。
- 当群人数小于300人且群内没有 Web 端用户的时候,用户进退群会触发即时更新在线人数。
https://xxxxxx/v4/group_open_avchatroom_http_svc/get_members?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介。
参数 | 说明 |
---|---|
xxxxxx | SDKAppID 所在国家/地区对应的专属域名:console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com adminapiusa.im.qcloud.com |
v4/group_open_avchatroom_http_svc/get_members | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | 必须为 App 管理员帐号,更多详情请参见 App 管理员 |
usersig | App 管理员帐号生成的签名,具体操作请参见 生成 UserSig |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为json |
200次/秒。
用来获取 AVChatRoom 群的在线人数接口,在线人数粒度为10s。
{
"GroupId":"@TGS#a6I4ZUUGO",
"Timestamp": 0
}
只获取标记为 1000 类型的群成员:
{
"GroupId":"@TGS#a6I4ZUUGO",
"Mark": 1000,
"Timestamp": 0
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
GroupId | String | 必填 | 操作的群 ID |
Timestamp | Integer | 必填 | 首次请求传0。当直播群中人数小于500人时,后台返回所有成员,并且返回 NextTimestamp 为0;当直播群中人数大于500人时,后台返回非0的 NextTimestamp,将该数字作为下一次请求的 Timestamp 拉取剩余人数。 |
{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"MemberList": [
{
"JoinTime": 1657773110,
"Member_Account": "teacher2",
"NickName": "教师t02",
"Avatar": "http://www.example.com/teacher2.jpg"
}
],
"NextTimestamp": 0
}
字段 | 类型 | 说明 |
---|---|---|
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
MemberList | Object | 该群组的在线账号,Member_Account 为用户的 UserID,JoinTime 为该成员进群时间 |
NextTimestamp | Integer | 分页拉取标志,非0表示还有更多成员未返回,需要将该数字设置到请求参数 Timestamp 中拉取更多成员;0表示已经返回所有成员 |
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
---|---|
10001 | 用户未登录错误,请检查 admin 账号和 usersig 是否正确 |
10002 | 系统错误,请再次尝试或联系技术客服 |
10003 | 请求命令非法,请再次尝试或联系技术客服 |
10004 | 参数非法。请根据应答包中的 ErrorInfo 字段,检查必填字段是否填充,或者字段的填充是否满足协议要求 |
10007 | 权限不足,非 AVChatRoom 群类型不支持获取在线人数 |
10010 | 群组不存在,或者曾经存在过,但是目前已经被解散 |
10015 | 群组 ID 非法,请检查群组 ID 是否填写正确 |
本页内容是否解决了您的问题?