即时通信 IM 获取直播群在线人数 - 服务端 API

功能说明

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

接口调用说明

适用的群组类型

即时通信 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 简介。

最高调用频率

200次/秒。

请求包示例

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

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

请求包字段说明

应答包体示例

{
   "ActionStatus": "OK",
   "ErrorInfo": "", 
   "ErrorCode": 0, 
   "GroupId":"@TGS#a6I4ZUUGO",
   "OnlineMemberNum":1000 //在线人数
}

应答包字段说明

错误码说明

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

接口调试工具

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