实时音视频
实时音视频
文档指南
请输入
实时音视频
快速入门
场景方案
开发指南
Token 鉴权
音频管理
视频管理
屏幕共享
SDK 升级指南
客户端 API 参考
服务端 API 参考
房间管理
转推直播
输入在线媒体流
WTN 流（原公共流）
实时数据监控
历史数据查询
业务标识管理
实时消息通信
历史版本（文档停止维护）
2023-08-01
2023-06-01
转推直播
2022-06-01
2020-12-01
转推直播
输入在线媒体流
获取数据指标
常见问题
集成相关
质量相关
AI 音视频互动方案
开发指南
配置 ASR/LLM/TTS 服务
API 参考
硬件对话智能体
用户指南
服务端 API
智能体
实时信令
互动白板
客户端 API 参考
服务端 API 参考
- 文档首页
实时音视频即时通讯 IM（文档隐藏发布-停止维护）服务端 API 参考服务端 OpenAPI用户相关用户状态查询用户在线状态 QueryOnlineStatus
复制全文
下载 pdf查询用户在线状态 QueryOnlineStatus
文档反馈
问问助手你可以使用此接口查询用户的在线状态。
使用说明
接口行为
你可以通过QueryOnlineStatus接口，指定 AppId 和 UserId，查询指定用户的在线状态。
调用接口
注意事项
QPS 不得超过 100。
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=QueryOnlineStatus&Version=2020-12-01
请求参数
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryOnlineStatus | 接口名称。当前 API 的名称为 QueryOnlineStatus。 |
Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
AppId | Integer | 是 | 000000 | 应用的唯一标志 |
UserIds | Array of Long | 是 | [10001] | 查询用户的 UserId。一次最多查询 100 个成员。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
AppId | Integer | 123 | 应用的唯一标志 |
QueryOnlineResults | JSON Map | - |
QueryOnlineResults
参数 | 类型 | 示例值 | 描述 |
ClientVersion | Long | 100 | 客户端版本号 |
ConnId | String | ConnID_1 | 连接的唯一标识 |
DeviceId | Long | 10001 | 设备 ID |
Platform | String | Android | 设备平台，目前支持 Android、iOS和 Web。 |
UserId | Long | 10001 | 用户的 UserId |
请求示例
POST https://rtc.volcengineapi.com?Action=QueryOnlineStatus&Version=2020-12-01
{
"AppId":000000,
"UserIds":[10001]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "QueryOnlineStatus",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-beijing"
},
"Result": {
"AppId": 123,
"QueryOnlineResults": {
"10001": [
{
"ConnId": "ConnID_1",
"UserId": 10001,
"DeviceId": 10001,
"ClientVersion": 1,
"Platform": "Android"
}
]
}
}
}
错误码
最近更新时间：2026.07.16 20:09:29
这个页面对您有帮助吗？
有用
有用
无用
无用