get_users_online_token_detail
Brief Description
- This interface retrieves the token array list of the platforms on which the user is currently online.
Request Method
post
Request URL
{API_ADDRESS}/user/get_users_online_token_detail
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Administrator token |
Request Parameter Example
{
"userIDs": [
"2621568666",
"2621568663"
]
}
Field Name | Optional | Type | Description |
---|---|---|---|
userIDs | Required | array | Array of user IDs to query |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": [
{
"userID": "2621568666",
"status": "online",
"singlePlatformToken": [
{
"platform": "Web",
"total": 1,
"token": [
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiIyNjIxNTY4NjY2IiwiUGxhdGZvcm1JRCI6NSwiZXhwIjoxNjk1OTAyOTI1LCJuYmYiOjE2ODgxMjY2MjUsImlhdCI6MTY4ODEyNjkyNX0.ulWW0Fr9n0__1pT9qxWJw9ym8zwosveYYPyyLaUVkU4"
]
}
]
}
]
}
Explanation for Successful Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 means success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error information, empty if no error |
data | object | General data object, see structure below |
userID | string | User ID |
status | string | Online status, online/offline |
singlePlatformToken | array | Token collection for a single platform online |
singlePlatformToken.platform | string | Online platform, 1->IOS, 2->Android, 3->Windows, 4->OSX, 5->Web, 5->MiniWeb, 7->Linux, 8->AndroidPad, 9->IPad |
singlePlatformToken.total | string | Total online count |
singlePlatformToken.token | array | Array of tokens |
Failed Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Explanation for Failed Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, see global error code document |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error information |