Platform APIEnterprise

List disabled users

List disabled accounts by user ID, status, and pagination criteria. This endpoint is available only in OpenIM Enterprise. Configure the API address and a valid token as described in Prepare to use the API.

HTTP request

POST {API_ADDRESS}/user/page_find_disable_users

Request example

curl --request POST "${API_ADDRESS}/user/page_find_disable_users" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "userIDs": ["user_001"],
  "status": 1,
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}'

Enterprise: This endpoint requires the corresponding OpenIM Enterprise services. Availability and permissions depend on the delivered version.

Request body

{
  "userIDs": ["user_001"],
  "status": 1,
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

Parameter	Required	Type	Description
userIDs	Yes	string[]	OpenIM user IDs to query.
status	No	int	Account status filter.
pagination	Yes	RequestPagination	Pagination settings.

Response

A normally processed request typically returns 200 OK. Check errCode in the response body to determine whether the operation succeeded.

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "users": [
      {
        "userID": "user_001",
        "nickname": "Example user",
        "faceURL": "https://example.com/avatar.png",
        "ex": "{}",
        "createTime": 1719800000000,
        "appMangerLevel": 0,
        "globalRecvMsgOpt": 0,
        "status": 1,
        "addFriendPermission": 0,
        "category": "default"
      }
    ],
    "total": 1
  }
}

Response properties

Property	Type	Description
errCode	int	Business error code. `0` indicates success.
errMsg	string	Short error message; normally empty on success.
errDlt	string	Detailed error information; normally empty on success.
data.users	UserInfo[]	User records. See `UserInfo`.
data.total	int	Total number of matching records.

Errors

Error responses use the common Platform API structure. See Error codes.

Permissions and limits

Available only in OpenIM Enterprise.
The caller must validate its authority over the target users.
Pagination and request array limits follow the delivered server version.

Was this page helpful?