Skip to main content

get_subscribe_users_status

Brief Description

  • Retrieve the online status of users subscribed by a specified user.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/user/get_subscribe_users_status
Header NameSample ValueOptionalTypeDescription
operationID1646445464564MandatorystringoperationID for global link tracing
tokeneyJhbxxxx3XsMandatorystringAdmin token

Request Parameter Example

{
"userID": "9609746682"
}
Field NameOptionalTypeDescription
userIDMandatorystringUser ID to be checked

Successful Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"statusList": [
{
"userID": "9168684795",
"status": 0,
"platformIDs": null
}
]
}
}

Successful Response Parameters Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if no error
errDlterrDltDetailed error message, empty if no error
dataobjectGeneric data object, see structure below
statusListarrayList of online statuses for subscribed users
statusList.userIDstringUser ID
statusList.statusintOnline status, 1: online, 0: offline
statusList.platformIDsarrayList of platform numbers, indicating multi-platform presence: 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"
}

Failed Response Parameters Explanation

Parameter NameTypeDescription
errCodeintError code, refer to global error code document for details
errMsgstringBrief error message
errDlterrDltDetailed error message