调用BatchGetOnlineUsers查询用户是否在线。

使用说明

该接口支持批量查询，每次最多可以查询20个用户是否在线。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 BatchGetOnlineUsers

系统规定参数。取值：BatchGetOnlineUsers。
AppId String 是 a494caec-***-695ef345db77

互动消息应用ID。
GroupId String 是 23wcaec-***695ef

消息组ID。
UserIds String 是 de1**a0,hu**9

用户UserId列表。多个UserId之间用逗号英文逗号（,）分隔。最多配置20个UserId。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-****-CB92E68F4CD8

Id of the request
Result Object

返回结果
OnlineUsers Array of onlineUsers

对象数组
UserId String de1**a0

用户UserId。
JoinTime Long 12**45

加入消息组的UTC时间戳。单位：毫秒
Online Boolean true

是否在线， 取值：

  • true：在线。
  • false：不在线。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=BatchGetOnlineUsers
&AppId=a494caec-***-695ef345db77
&GroupId=23wcaec-***695ef
&UserIds=de1**a0,hu**9
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<BatchGetOnlineUsersResponse>
    <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
    <Result>
        <OnlineUsers>
            <UserId>de1**a0</UserId>
            <Online>true</Online>
        </OnlineUsers>
    </Result>
</BatchGetOnlineUsersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16A96B9A-****-CB92E68F4CD8",
  "Result" : {
    "OnlineUsers" : [ {
      "UserId" : "de1**a0",
      "Online" : true
    } ]
  }
}

错误码

访问错误中心查看更多错误码。