服务端 API商业版

查询停用用户

按用户、状态和分页条件查询停用账号。此接口仅在 OpenIM 商业版中提供。请先在接入准备中配置 API 地址和有效 Token。

HTTP 请求

POST {API_ADDRESS}/user/page_find_disable_users

请求示例

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": 1
  }
}'

商业版：此接口需要部署对应的商业版服务。接口是否可用以及具体权限以客户交付版本为准。

请求体

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

参数名	是否必填	类型	说明
userIDs	是	string[]	OpenIM 用户 ID 列表。
status	否	int	状态筛选条件。
pagination	是	RequestPagination	分页参数。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "users": [
      {
        "userID": "user_001",
        "nickname": "示例名称",
        "faceURL": "https://example.com/resource",
        "ex": "{}",
        "createTime": 1719800000000,
        "appMangerLevel": 0,
        "globalRecvMsgOpt": 0,
        "status": 1,
        "addFriendPermission": 0,
        "category": "default"
      }
    ],
    "total": 0
  }
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，`0` 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。
data.users	UserInfo[]	结构为用户模块的 `UserInfo`。
data.total	int	符合条件的记录总数。

错误

错误响应使用 Platform API 通用结构，处理方式见错误码。

权限和限制

仅在 OpenIM 商业版中提供。
调用方必须校验操作用户和目标资源的业务权限。
请求数组和分页大小应遵循客户交付版本的服务端限制。

HTTP 请求

请求示例

请求体

响应

响应参数

错误

权限和限制

相关页面