Skip to main content

subscribe_users_status

Description

  • Modify (subscribe or unsubscribe) the online status subscription relationship for a specified user.

Request Method

  • POST

Request URL

  • {API_ADDRESS}/user/subscribe_users_status
Header NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"userID": "9168684795",
"userIDs": ["7475779354", "6317136453", "8450535746"],
"genre": 1
}
Field NameRequiredTypeDescription
userIDRequiredstringSpecified user ID
userIDsRequiredarrayList of user IDs
genreRequiredint1 to subscribe, 2 to unsubscribe

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"statusList": [
{
"userID": "7475779354",
"status": 0,
"platformIDs": null
},
{
"userID": "6317136453",
"status": 0,
"platformIDs": null
},
{
"userID": "8450535746",
"status": 1,
"platformIDs": [2]
}
]
}
}

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
statusListarrayList of status results
statusList.userIDstringUser account
statusList.statusintOnline status: 0 for offline, 1 for online
statusList.platformIDsarrayList of platform types on which the user is logged in; values range from 1 to 9

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