is_friend

Brief Description

• Check if two users have a friendship relation.

Request Method

• post

Request URL

• http://x.x.x.x:10002/friend/is_friend

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

{
  "userID1": "11111111",
  "userID2": "11111112"
}

Field Name	Optional	Type	Description
userID1	Required	string	User ID
userID2	Required	string	User ID

Successful Return Sample

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "inUser1Friends": true,
    "inUser2Friends": true
  }
}

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, the specific structure is shown below
inUser1Friends	boolean	true: userID2 is in userID1's friend list
inUser2Friends	boolean	true: userID1 is in userID2's friend list

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