get_users_online_status

Description

• Retrieves the online status and token information for each platform of specified users.

Request Method

• POST

Request URL

• {API_ADDRESS}/user/get_users_online_status

Header

Header Name	Example Value	Required	Type	Description
operationID	1646445464564	Required	string	Used for global traceability, suggested as a unique timestamp per request
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameters Example

{
  "userIDs": ["2890713225"]
}

Field Name	Required	Type	Description
userIDs	Required	array	List of user IDs to query

Success Response Example

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

Success Response Parameter Description

Parameter	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty if successful
errDlt	string	Detailed error information, empty if successful
data	object	General data object, structure described below
userID	string	User ID
status	int	Online status: 1 for online, 0 for offline
detailPlatformStatus	array	Detailed online status for each platform, includes detailed info if status is 1, otherwise an empty array.
detailPlatformStatus.platformID	int	Platform type for user login, with values from 1 to 9
detailPlatformStatus.connID	string	Connection ID
detailPlatformStatus.isBackground	boolean	Indicates if the app is running in the background
detailPlatformStatus.token	string	Token information

Failure Response Example

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

Failure Response Parameter Description

Parameter	Type	Description
errCode	int	Error code; refer to global error code documentation
errMsg	string	Brief error message
errDlt	string	Detailed error information