tencent cloud

功能说明

App 管理员可以根据群组 ID 获取直播群在线成员列表。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该 API 返回最近进群的成员列表（最多返回30人）。

接口调用说明

适用的群组类型

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

注意：

• 此功能需 旗舰版套餐，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
• 其他套餐版本调用该 API 返回最近进群的成员列表（最多返回30人）。
• 在线成员列表总体更新粒度为10s。
• 当直播群中超过1000人时，接口仅返回最新进群并且在线的1000人。
• 当群人数大于等于300或群内有 Web 端用户的时候，出现群成员上下线或者进退群的时候，由于当前10s周期内已经统计了用户在线状态的原因，会在下一个10s周期才会统计到剔除状态用户变更的在线人数，所以会出现调用接口10s - 20s才会更新的现象。
• 当群人数小于300人且群内没有 Web 端用户的时候，用户进退群会触发即时更新在线人数。

请求 URL 示例

https://xxxxxx/v4/group_open_avchatroom_http_svc/get_members?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

用来获取 AVChatRoom 群的在线人数接口，在线人数粒度为10s。

{
    "GroupId":"@TGS#a6I4ZUUGO",
    "Timestamp": 0
}

只获取标记为 1000 类型的群成员：

{
    "GroupId":"@TGS#a6I4ZUUGO",
    "Mark": 1000,
    "Timestamp": 0
}

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "MemberList": [
        {
            "JoinTime": 1657773110,
            "Member_Account": "teacher2",
            "NickName": "教师t02",
            "Avatar": "http://www.example.com/teacher2.jpg"
        }
    ],
    "NextTimestamp": 0
}

应答包字段说明

错误码说明

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