get_users_online_token_detail
Description
- Retrieves a list of tokens for the platforms on which specified users are currently online.
Request Method
POST
Request URL
{API_ADDRESS}/user/get_users_online_token_detail
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": ["2621568666", "2621568663"]
}
Field Name | Required | Type | Description |
---|---|---|---|
userIDs | Required | array | Array of user IDs to query |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": [
{
"userID": "2621568666",
"status": 1,
"singlePlatformToken": [
{
"platformID": 4,
"total": 1,
"token": [
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyNjIxNTY4NjY2IiwiUGxhdGZvcm1JRCI6NSwiZXhwIjoxNjk1OTAyOTI1LCJuYmYiOjE2ODgxMjY2MjUsImlhdCI6MTY4ODEyNjkyNX0.ulWW0Fr9n0__1pT9qxWJw9ym8zwosveYYPyyLaUVkU4"
]
}
]
}
]
}
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 |
singlePlatformToken | array | Array of tokens for each platform on which the user is online |
singlePlatformToken.platformID | int | Platform type for user login, with values from 1 to 9 |
singlePlatformToken.total | int | Total number of online instances on the platform |
singlePlatformToken.token | array | Array of tokens for the online instances |
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 |