TIMGroupGetOnlineMemberCount
功能介绍
获取指定群在线人数
7.3及其以后的版本支持所有群类型
该接口有频限检测，SDK 限制调用频率为60秒1次
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| params | GetOnlineMemberCountParams | 是 | 获取指定群在线人数的参数 |
返回模板
Promise<commonResult<GetOnlineMemberCountResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: GetOnlineMemberCountResult | undefined;
json_params?: GetOnlineMemberCountResult | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | GetOnlineMemberCountResult ｜ undefined | 根据具具体接口返回 |
| json_params | GetOnlineMemberCountResult ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetOnlineMemberCountParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let param : GetOnlineMemberCountParams = {
groupId: groupId, //必填
data: '' //选填
}
const {code} = await timRenderInstance.TIMGroupGetOnlineMemberCount(param)
if(code == 0){
//成功
}