subscribe_users_status

Brief Description

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

Request Method

• post

Request URL

• http://x.x.x.x:10002/user/subscribe_users_status

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

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

Field Name	Optional	Type	Description
userID	Required	string	Specified user ID
userIDs	Required	array	List of user IDs
genre	Required	int	Subscribe or unsubscribe, 1 - Subscribe; 2 - Unsubscribe

Successful Response Example

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

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
statusList	array	Status return results
statusList.userID	string	User account
statusList.status	int	Online status, 1: online, 0: offline
statusList.platformIDs	array	List of platform numbers, can be online on multiple platforms, 1: IOS, 2: Android, 3: Windows, 4: OSX, 5: Web, 6: MiniWeb, 7: Linux, 8: Android Pad, 9: IPad, 10: admin

Failed Response Example

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

Explanation for Failed Response Parameters

Parameter Name	Type	Description
errCode	int	Error code, refer to the global error code document
errMsg	string	Brief error message
errDlt	errDlt	Detailed error information