动态与公告

产品动态

公告

产品简介

产品概述

基本概念

应用场景

功能介绍

账号系统

用户资料与关系链

消息管理

群组相关

公众号系统

音视频通话 Call

使用限制

购买指南

计费概述

价格说明

购买指引

续费指引

停服说明

退费说明

开发指引

Demo 专区

开通服务

体验 Demo

快速跑通

下载中心

SDK & Demo 源码

更新日志

聊天互动（含 UI）

TUIKit 组件介绍

快速开始

全功能接入

单功能接入

AI 集成

构建基础界面

更多特性

定义外观

国际化界面语言

推送服务（Push）

服务概述

名词解释

开通服务

快速跑通

厂商通道

数据统计

排查工具

客户端 API

服务端 API

推送回调

高级功能

更新日志

错误码

常见问题

智能客服

功能概述

快速入门

集成指引

管理员操作手册

客服操作手册

更多实践

直播间搭建

AI 聊天机器人方案

超大娱乐协作社群

Discord 实现指南

游戏内集成 Chat 指南

类 WhatsApp Channel 搭建方案

发送红包

Chat 应对防火墙限制相关

无 UI 集成

快速开始

集成 SDK

初始化

登录登出

消息相关

会话相关

群组相关

社群话题

用户管理

离线推送

云端搜索

本地搜索

公众号

客户端 API

JavaScript

Android

iOS & macOS

Swift

Flutter

Electron

Unity

React Native

C 接口

C++

服务端 API

生成 UserSig

REST API

第三方回调

控制台指南

新版控制台介绍

创建并升级应用

基本配置

功能配置

账号管理

群组管理

公众号管理

回调配置

用量统计

资源包查看指南

实时监控

开发辅助工具

访问管理

高级功能

常见问题

uni-app 常见问题

购买相关问题

SDK 相关问题

账号鉴权相关问题

用户资料与关系链相关问题

消息相关问题

群组相关问题

直播群相关问题

昵称头像相关问题

协议与认证

服务等级协议

安全合规认证

IM 政策

隐私政策

数据隐私和安全协议

平滑迁移方案

平滑迁移完整版

平滑迁移简化版

错误码

联系我们

直播群成员在线状态回调

PDF

聚焦模式

字号

最后更新时间： 2025-10-28 10:25:17

功能说明
App 后台可以通过该回调实时查看直播群的上下线状态，例如记录日志，或者同步到其他系统。
注意事项
此功能需 专业版、专业版plus或企业版，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。在控制台开启后，直播群成员将保存最新入群并且在线的1000人，客户端可以拉取该列表。在控制台关闭后，客户端无法拉取该1000人列表，只能拉取到最新进群的30人列表。
要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 Chat 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介：安全考虑 文档。
可能触发该回调的场景
App 用户进入直播群之后，未正常退群，系统内部会每过20s进行检查，当发现该用户已经超过30s没有上报心跳后，就触发 Offline 回调
App 用户进入直播群之后，未正常退群，因没有心跳上报触发Offline回调后，重新上线引发 Online 回调。
App 用户首次进入直播群（一个用户多个 App 终端进入一个直播群，仅回调第一次，其中 App 终端包括 Web 端），引发 Online 回调。
App 用户最后一次主动退出直播群 (一个用户多个 App 终端在直播群时候，最后一个终端退出时候触发回调，其中 App 终端包括 Web 端)，触发 Offline 回调。
回调发生时机
用户进入直播群之后，因网络中断等原因导致心跳请求超时触发 Offline 事件；当超时20s重新上线时触发 Online 事件。若同一个用户使用多台设备登录，并且多台设备同时加入到同一个直播间时，只有当所有设备同时掉线才会触发 Offline 事件，当任一设备恢复上线时触发 Online 事件（多台设备恢复时仅触发一次 Online 事件）。
接口说明
请求 URL 示例
以下示例中 App 配置的回调 URL 为 https://www.example.com。
示例：
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json
请求参数说明
参数
说明
https
请求协议为 HTTPS，请求方式为 POST
www.example.com
回调 URL
SdkAppid
创建应用时在即时通信 Chat 控制台分配的 SDKAppID
CallbackCommand
固定为 Group.CallbackOnMemberStateChange
contenttype
固定值为 JSON
请求包示例
{
    "CallbackCommand": "Group.CallbackOnMemberStateChange", // 回调命令
    "GroupId": "@TGS#2J4SZEAEL", // 群组 ID
    "EventType": "Offline", // 事件类型：Offline - 掉线、Online - 重新上线
    //事件原因:HeartbeatInterrupt 心跳中断、HeartbeatRecover 心跳恢复、Join 首次进群、Quit 最后一次退群
    "EventCause": "HeartbeatInterrupt",
    "MemberList": [ // 离开群的成员列表
        {
            "Member_Account": "jared"
        },
        {
            "Member_Account": "tommy"
        }
    ],
    "EventTime":"1670574414123"//毫秒级别，事件触发时间戳
}
请求包字段说明
字段
类型
说明
CallbackCommand
String
回调命令
GroupId
String
产生群消息的群组 ID
EventType
String
事件类型：Offline - 掉线、Online - 重新上线
EventCause
String
事件产生原因：HeartbeatInterrupt 心跳中断、 HeartbeatRecover 心跳恢复、Join 首次进群、Quit 最后一次退群
MemberList
Array
产生事件的成员列表
应答包示例
App 后台同步数据后，返回应答包。
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 忽略应答结果
}
应答包字段说明
字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
必填
错误码，0表示允许忽略应答结果
ErrorInfo
String
必填
错误信息
参考
第三方回调简介
新成员入群之后回调
群成员离开之后回调

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

即时通信 IM

直播群成员在线状态回调

功能说明

注意事项

可能触发该回调的场景

回调发生时机

接口说明

请求 URL 示例

请求参数说明

请求包示例

请求包字段说明

应答包示例

应答包字段说明

参考

帮助和支持

参数	说明
https	请求协议为 HTTPS，请求方式为 POST
www.example.com	回调 URL
SdkAppid	创建应用时在即时通信 Chat 控制台分配的 SDKAppID
CallbackCommand	固定为 Group.CallbackOnMemberStateChange
contenttype	固定值为 JSON

字段	类型	说明
CallbackCommand	String	回调命令
GroupId	String	产生群消息的群组 ID
EventType	String	事件类型：Offline - 掉线、Online - 重新上线
EventCause	String	事件产生原因：HeartbeatInterrupt 心跳中断、 HeartbeatRecover 心跳恢复、Join 首次进群、Quit 最后一次退群
MemberList	Array	产生事件的成员列表

字段	类型	属性	说明
ActionStatus	String	必填	请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode	Integer	必填	错误码，0表示允许忽略应答结果
ErrorInfo	String	必填	错误信息