跳到主要内容

检查好友关系

简要描述

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

请求方式

  • post

请求 URL

  • {API_ADDRESS}/friend/is_friend
header 名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪,建议使用时间戳,在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例

{
"userID1": "11111111",
"userID2": "11111112"
}
字段名选填类型说明
userID1必填string用户 ID
userID2必填string用户 ID

成功返回示例

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

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,为空
errDlterrDlt错误详细信息,为空
dataobject通用数据对象,具体结构见下方
inUser1Friendsbooleanture: userID2 在 userID1 的好友列表中
inUser2Friendsbooleanture: userID1 在 userID2 的好友列表中

失败返回示例

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

失败返回示例的参数说明

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息