get_black_list

Description

• Retrieve the blacklist of a specific user.

Request Method

• post

Request URL

• {API_ADDRESS}/friend/get_black_list

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	Used for global traceability, recommended to use a timestamp for uniqueness in each request.
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Body Example

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

Field Name	Optional	Type	Description
userID	Required	string	User ID
pagination	Required	object	Pagination details
pagination.pageNumber	Required	int	Current page number, starts from 1
pagination.showNumber	Required	int	Number of entries per page

Success Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "blacks": [
      {
        "ownerUserID": "11111111",
        "createTime": 1688460626,
        "blackUserInfo": {
          "userID": "11111113",
          "nickname": "yourNickname",
          "faceURL": "yourFaceURL",
          "ex": ""
        },
        "addSource": 0,
        "operatorUserID": "openIMAdmin",
        "ex": ""
      }
    ],
    "total": 1
  }
}

Success Response Parameters

Parameter Name	Type	Description
errCode	int	Error code, 0 means success
errMsg	string	Brief error message, empty if successful
errDlt	string	Detailed error message, empty if successful
data	object	Data object, see structure below
blacks	array	List of blacklist information
total	int	Total number of blacklist entries

Failure Response Example

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

Failure Response Parameters

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