查询用户在线状态

POST

/user/status/query

grpc 接口：rpc QueryUserStatus(QueryUserStatusReq) returns (QueryUserStatusResp)

在用户连接和断开 MQTT 时，会向 realm/{域ID}/app/{AppID}/user/{用户ID}/online_status topic 中发送：

{
  "users": [
    {
      "userID": "user1",
      "status": "STATUS_ONLINE",
      "devices": [
        {
          "deviceType": 1
        }
      ]
    }
  ]
}

需要注意，当用户结束通话后，收到的通知里面status是STATUS_IDLE，此时需要将用户的状态修改为STATUS_ONLINE，而不是直接使用STATUS_IDLE。

请求参数

Header 参数

Body 参数application/json

示例

{
    "userIDs": [
        "string"
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/user/status/query' \
--header 'Content-Type: application/json' \
--data '{
    "userIDs": [
        "string"
    ]
}'

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "message": "",
    "data": {
        "@type": "type.googleapis.com/hileia_core_security.QueryUserStatusResp",
        "users": [
            {
                "userID": "user1",
                "status": "STATUS_ONLINE",
                "devices": [
                    {
                        "deviceType": 1
                    }
                ]
            },
            {
                "userID": "user2",
                "status": "STATUS_OFFLINE",
                "devices": []
            }
        ]
    }
}

修改于 2023-07-04 09:22:46

获取token

发送消息