SDK 文档

服务端 API

有奖调研

获取直播群在线人数

最近更新时间:2021-11-25 17:27:30

功能说明

App 管理员可以根据群组 ID 获取直播群在线人数。

接口调用说明

适用的群组类型

群组类型 ID 是否支持此 REST API
Private 不支持,同新版本中的 Work(好友工作群)
Public 不支持
ChatRoom 不支持,同新版本中的 Meeting(临时会议群)
AVChatRoom 支持
Community 不支持

即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统

注意:

  • 在线人数总体更新粒度为10s。
  • 当群人数大于等于300或群内有 Web 端用户的时候,出现群成员上下线或者进退群的时候,由于当前10s周期内已经统计了用户在线状态的原因,会在下一个10s周期才会统计到剔除状态用户变更的在线人数,所以会出现调用接口10s - 20s才会更新的现象。
  • 当群人数小于300人且群内没有 Web 端用户的时候,用户进退群会触发即时更新在线人数。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/get_online_member_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/group_open_http_svc/get_online_member_num 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数,取值范围0 - 4294967295

最高调用频率

200次/秒。

请求包示例

用来获取 AVChatRoom 群的在线人数接口,在线人数粒度为10s。建议业务侧过10s查询一次群组在线人数然后下发到群里同步所有用户。

{
    "GroupId":"@TGS#a6I4ZUUGO"
}

请求包字段说明

字段 类型 属性 说明
GroupId String 必填 操作的群 ID

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "", 
    "ErrorCode": 0, 
    "OnlineMemberNum":1000 //在线人数
}

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 错误信息
OnlineMemberNum Integer 该群组的在线人数

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
10002 系统错误,请再次尝试或联系技术客服
10003 请求命令非法,请再次尝试或联系技术客服
10004 参数非法。请根据应答包中的 ErrorInfo 字段,检查必填字段是否填充,或者字段的填充是否满足协议要求
10007 权限不足,非 AVChatRoom 群类型不支持获取在线人数
10010 群组不存在,或者曾经存在过,但是目前已经被解散
10015 群组 ID 非法,请检查群组 ID 是否填写正确

接口调试工具

通过 REST API 在线调试工具 调试本接口。

目录