Skip to main content

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 NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"userIDs": ["2621568666", "2621568663"]
}
Field NameRequiredTypeDescription
userIDsRequiredarrayArray 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

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful
dataobjectGeneral data object, structure described below
userIDstringUser ID
statusintOnline status: 1 for online, 0 for offline
singlePlatformTokenarrayArray of tokens for each platform on which the user is online
singlePlatformToken.platformIDintPlatform type for user login, with values from 1 to 9
singlePlatformToken.totalintTotal number of online instances on the platform
singlePlatformToken.tokenarrayArray of tokens for the online instances

Failure Response Example

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

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information