根据一个或多个用户uid查询用户是否在线
接口说明
使用说明
该接口支持批量查询,每次最多可以查询 20 个用户是否在线。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:BatchGetOnlineUsers |
get |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AppId |
string |
是 |
互动消息应用 ID。 |
a494caec-***-695ef345db77 |
GroupId |
string |
是 |
消息组 ID。 |
23wcaec-***695ef |
UserIds |
string |
是 |
用户 UserId 列表。多个 UserId 之间用半角逗号(,)分隔。最多配置 20 个 UserId。 |
de1**a0,hu**9 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回参数。 |
||
RequestId |
string |
请求 ID。 |
16A96B9A-****-CB92E68F4CD8 |
Result |
object |
返回结果 |
|
OnlineUsers |
array |
对象数组 |
|
object |
|||
JoinTime |
integer |
加入消息组的 UTC 时间戳。单位:毫秒 |
12**45 |
Online |
boolean |
是否在线, 取值:
|
true |
UserId |
string |
用户 UserId。 |
de1**a0 |
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"OnlineUsers": [
{
"JoinTime": 0,
"Online": true,
"UserId": "de1**a0"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。