检查好友关系 | OpenIM Docs

跳到主要内容

检查好友关系

简要描述

检查两个用户是否存在好友关系。

请求方式

post

请求 URL

{API_ADDRESS}/friend/is_friend

header 名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	operationID 用于全局链路追踪
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

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

字段名	选填	类型	说明
userID1	必填	string	用户 ID
userID2	必填	string	用户 ID

成功返回示例

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

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,0 表示成功
errMsg	string	错误简要信息,无错误时为空
errDlt	errDlt	错误详细信息,无错误时为空
data	object	通用数据对象，具体结构见下方
inUser1Friends	boolean	ture: userID2 在 userID1 的好友列表中
inUser2Friends	boolean	ture: userID1 在 userID2 的好友列表中

失败返回示例

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

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息

检查好友关系