查询用户在线状态 - HiAR文档中心

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 参数

trace

string

可选

示例值:

{% mock 'string' , 'abcdefghijklmnopqrstuvwxyz1234567890' , 10 , 10 %}

appid

string

可选

示例值:

X-HIAR-OPENAPI-APPID

string

可选

示例值:

X-HIAR-OPENAPI-Nonce

string

可选

示例值:

X-HIAR-OPENAPI-DATE

string

可选

示例值:

X-HIAR-OPENAPI-SIGNATURE

string

可选

示例值:

Body 参数application/json

userIDs

array[string]

需要查询用户列表

必需

示例

{
  "userIDs": [
    "string"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object | null

必需

@type

string

必需

users

array [object {3}]

用户在线状态列表

必需

示例

{
  "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": []
      }
    ]
  }
}