get_all_users_uid

Description

• Retrieves a list of registered user IDs.

Request Method

• POST

Request URL

• {API_ADDRESS}/user/get_all_users_uid

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

{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}

Field Name	Required	Type	Description
pagination	Required	object	Pagination structure
pagination.pageNumber	Required	int	Current page number, starting from 1
pagination.showNumber	Required	int	Number of items per page

Success Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 0,
    "userIDs": [
      "openIM123456",
      "openIM654321",
      "openIMAdmin",
      "kernaltestuid2",
      "alantestuid2"
    ]
  }
}

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
total	int	Total number of users
userIDs	array	List of user IDs

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