获取指定用户在线状态

简要描述

• 获取指定用户各终端在线状态和 token。

请求方式

• post

请求 URL

• {API_ADDRESS}/user/get_users_online_status

Header

header 名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议使用时间戳，在每个请求中独立
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "userIDs": ["2890713225"]
}

字段名	选填	类型	说明
userIDs	必填	array	需要查询的用户 ID 列表

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": [
    {
      "userID": "2890713225",
      "status": 1,
      "detailPlatformStatus": [
        {
          "platformID": 2,
          "connID": "bbb7c4da159b1ec6beb81c9e4129b075",
          "isBackground": false,
          "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyODkwNzEzMjI1IiwiUGxhdGZvcm1JRCI6MywiZXhwIjoxNzA0Njk1NzI0LCJuYmYiOjE2OTY5MTk0MjQsImlhdCI6MTY5NjkxOTcyNH0.-TBNT0YKn_8YH9oO8A8SYEpNzOg1-EQD8O23R0MsVLE"
        },
        {
          "platformID": 3,
          "connID": "f18b67b5f57f01604b9f7c338238f43d",
          "isBackground": false,
          "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyODkwNzEzMjI1IiwiUGxhdGZvcm1JRCI6MiwiZXhwIjoxNzA0NTA5ODg4LCJuYmYiOjE2OTY3MzM1ODgsImlhdCI6MTY5NjczMzg4OH0.uii4Sf05z7VIGCDXUEtqq7cwdXakWkJJrCwYUigvc3I"
        }
      ]
    }
  ]
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简要信息，为空
errDlt	errDlt	错误详细信息，为空
data	object	通用数据对象，具体结构见下方
userID	string	用户 ID
status	int	在线状态，在线：1，离线：0
detailPlatformStatus	array	详细的各个终端的在线情况，仅当 status 为 1 时包含在线终端的详细信息，否则为空数组。
detailPlatformStatus.platformID	int	用户登录时的终端类型，取值为1-9
detailPlatformStatus.connID	string	连接 ID
detailPlatformStatus.isBackground	boolean	app 是否处于后台
detailPlatformStatus.token	string	token 信息

失败返回示例

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息