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

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

{
  "userID": "9168684795",
  "userIDs": ["7475779354", "6317136453", "8450535746"],
  "genre": 1
}

Field Name	Required	Type	Description
userID	Required	string	Specified user ID
userIDs	Required	array	List of user IDs
genre	Required	int	1 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

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
statusList	array	List of status results
statusList.userID	string	User account
statusList.status	int	Online status: 0 for offline, 1 for online
statusList.platformIDs	array	List 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

Parameter	Type	Description
errCode	int	Error code; refer to global error code documentation
errMsg	string	Brief error message
errDlt	string	Detailed error information