get_users_online_status
Brief Description
- Retrieve the online status and token of a specified user across various devices.
Request Method
post
Request URL
{API_ADDRESS}/user/get_users_online_status
Header
Header Name | Sample Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Mandatory | string | operationID for global link tracing |
token | eyJhbxxxx3Xs | Mandatory | string | Admin token |
Request Parameter Example
{
"userIDs": [
"2890713225"
]
}
Field Name | Optional | Type | Description |
---|---|---|---|
userIDs | Mandatory | array | List of user IDs to query |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": [
{
"userID": "2890713225",
"status": "online",
"detailPlatformStatus": [
{
"platform": "Windows",
"status": "online",
"connID": "bbb7c4da159b1ec6beb81c9e4129b075",
"isBackground": false,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyODkwNzEzMjI1IiwiUGxhdGZvcm1JRCI6MywiZXhwIjoxNzA0Njk1NzI0LCJuYmYiOjE2OTY5MTk0MjQsImlhdCI6MTY5NjkxOTcyNH0.-TBNT0YKn_8YH9oO8A8SYEpNzOg1-EQD8O23R0MsVLE"
},
{
"platform": "Android",
"status": "online",
"connID": "f18b67b5f57f01604b9f7c338238f43d",
"isBackground": false,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyODkwNzEzMjI1IiwiUGxhdGZvcm1JRCI6MiwiZXhwIjoxNzA0NTA5ODg4LCJuYmYiOjE2OTY3MzM1ODgsImlhdCI6MTY5NjczMzg4OH0.uii4Sf05z7VIGCDXUEtqq7cwdXakWkJJrCwYUigvc3I"
}
]
}
]
}
Successful Response Parameters Explanation
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error message, empty if no error |
data | array | Generic data array, see structure below |
userID | string | User ID |
status | string | Online status, online: "online", offline: "offline" |
detailPlatformStatus | array | Detailed online status for each platform |
detailPlatformStatus.platform | string | Platform ID, e.g., 1: IOS, 2: Android, 3: Windows, etc. |
detailPlatformStatus.status | string | Online status, online: "online", offline: "offline" |
detailPlatformStatus.connID | string | Connection ID |
detailPlatformStatus.isBackground | boolean | Whether the app is in the background |
detailPlatformStatus.token | string | Token information |
Failed Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failed Response Parameters Explanation
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to global error code document for details |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |