get_black_list

Brief Description

• Retrieve the blacklist of a specified user.

Request Method

• post

Request URL

• {API_ADDRESS}/friend/get_black_list

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	operationID is used for global link tracking
token	eyJhbxxxx3Xs	Required	string	Administrator token

Request Sample Parameters

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

Field Name	Optional	Type	Description
userID	Required	string	User ID
pagination	Required	object	Pagination parameter structure
pagination.pageNumber	Required	int	Current page number, starting from 1
pagination.showNumber	Required	int	Number of requests on the current page

Successful Return Sample

{
  "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
  }
}

Successful Return Sample Explanation

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty when no error
errDlt	errDlt	Detailed error message, empty when no error
data	object	General data object, specific structure shown below
blacks	array	List of Blacklist Information
total	int	Total number of blacklisted users

Failed Return Sample

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

Failed Return Sample Explanation

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