用户 - 好友☍
版本:v1
认证方式:Bearer Token
目录☍
接口列表☍
获取用户资料☍
接口说明
用于他人主页展示
基本信息☍
- 接口名称:获取用户资料
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/Profile/{userId}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
userId | - | 用户ID | 是 |
appKey | - | - | 是 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | GetUserProfileResult | - | 否 |
error | string | 错误信息 | 否 |
添加关注☍
接口说明
关注指定用户
基本信息☍
- 接口名称:添加关注
- 请求方式:POST
- 请求路径:/UserFriends/{appKey}/Follower/{userId}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
userId | - | 要关注的用户ID | 是 |
appKey | - | - | 是 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
取消关注☍
接口说明
取消关注指定用户
基本信息☍
- 接口名称:取消关注
- 请求方式:DELETE
- 请求路径:/UserFriends/{appKey}/Follower/{userId}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
userId | - | 要取消关注的用户ID | 是 |
appKey | - | - | 是 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
刷新粉丝数据☍
接口说明
根据粉丝ID更新粉丝信息
基本信息☍
- 接口名称:刷新粉丝数据
- 请求方式:PUT
- 请求路径:/UserFriends/{appKey}/Follower/{id}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
id | - | 粉丝ID | 是 |
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
alias | string | - | 别名 | 否 |
closenessScore | integer | - | 亲密度分数 | 否 |
attentionScore | integer | - | 关注度分数 | 否 |
tags | string | - | 标签 | 否 |
status | string | - | 状态 | 否 |
remark | string | - | 备注 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
获取粉丝列表☍
接口说明
根据条件获取我的粉丝列表
基本信息☍
- 接口名称:获取粉丝列表
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/Followers
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
tag | string | - | 标签 | 否 |
status | string | - | 状态 | 否 |
targetUserId | integer | - | 指定用户的粉丝 | 否 |
skip | integer | - | 跳过的记录数 | 否 |
take | integer | 10 | 获取的记录数 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | UserFollowersResult | - | 否 |
error | string | 错误信息 | 否 |
获取关注列表 / 判断是否关注☍
接口说明
根据条件获取我的关注列表,或判断是否关注某个用户
基本信息☍
- 接口名称:获取关注列表 / 判断是否关注
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/Following
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
tag | string | - | 用于过滤关注列表的标签(可选)。 | 否 |
status | string | - | 用于过滤关注列表的状态(可选)。 | 否 |
targetUserId | integer | - | 指定用户的关注记录,如果不提供则默认为当前用户的关注。 | 否 |
skip | integer | - | 跳过的记录数,用于分页(默认0)。 | 否 |
take | integer | 10 | 获取的记录数,用于分页(默认10)。 | 否 |
checkUserId | integer | - | 要判断是否关注的目标用户ID。如果提供此参数,方法将返回一个布尔值,表示当前用户是否关注该目标用户。 | 否 |
onlyIDs | boolean | - | 是否只返回关注用户的ID集合,默认为false(即返回完整的关注用户信息)。 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
推荐共同关注用户☍
接口说明
推荐有共同关注的用户
基本信息☍
- 接口名称:推荐共同关注用户
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/MutualFollowings
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
skip | integer | - | 跳过的记录数 | 否 |
take | integer | 10 | 获取的记录数 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | UserMutualFollowingsResult | - | 否 |
error | string | 错误信息 | 否 |
推荐共同粉丝用户☍
接口说明
推荐有共同粉丝的用户
基本信息☍
- 接口名称:推荐共同粉丝用户
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/MutualFollowers
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
skip | integer | - | 跳过的记录数 | 否 |
take | integer | 10 | 获取的记录数 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | UserMutualFollowersResult | - | 否 |
error | string | 错误信息 | 否 |
推荐相似兴趣用户☍
接口说明
推荐有共同爱好的用户
基本信息☍
- 接口名称:推荐相似兴趣用户
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/CommonInterests
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
tag | string | - | 兴趣标签 | 否 |
skip | integer | - | 跳过的记录数 | 否 |
take | integer | 10 | 获取的记录数 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | UserCommonInterestsResult | - | 否 |
error | string | 错误信息 | 否 |
推荐附近用户☍
接口说明
根据地理位置坐标和多种筛选条件,查询附近满足条件的用户列表,支持分页和按距离排序。
地理位置查询使用MySQL的ST_Distance_Sphere函数计算球面距离。 注意:longitude为经度(X轴),latitude为纬度(Y轴),参数顺序与常规坐标系一致
基本信息☍
- 接口名称:推荐附近用户
- 请求方式:GET
- 请求路径:/UserFriends/{appKey}/NearBy
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
longitude | number | - | 当前用户经度坐标(WGS84坐标系) | 是 |
latitude | number | - | 当前用户纬度坐标(WGS84坐标系) | 是 |
country | string | - | 国家过滤条件(精确匹配) | 否 |
state | string | - | 省份过滤条件(精确匹配) | 否 |
city | string | - | 城市过滤条件(精确匹配) | 否 |
district | string | - | 区县过滤条件(精确匹配) | 否 |
gender | string | - | 性别过滤条件(可选值示例:Male/Female/Other) | 否 |
ageS | integer | - | 年龄起始范围(包含,0表示不限制) | 否 |
ageE | integer | - | 年龄结束范围(包含,0表示不限制) | 否 |
tag | string | - | 兴趣标签过滤(支持模糊匹配,如:"运动") | 否 |
distance | integer | - | 搜索半径(单位:米,0表示不限制距离) | 否 |
skip | integer | - | 跳过的记录数(分页起始位置,默认0) | 否 |
take | integer | 10 | 获取的记录数(分页大小,默认10,最大100) | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | UserFriendsNearByResult | - | 否 |
error | string | 错误信息 | 否 |
数据结构☍
BooleanApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
CommonFriendModel☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
userID | integer | 用户ID | 否 |
nickName | string | 昵称 | 否 |
avatar | string | 头像 | 否 |
FollowerModel☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | 用户ID | 否 |
targetUserID | integer | 目标用户ID | 否 |
alias | string | 别名 | 否 |
nickName | string | 昵称 | 否 |
avatar | string | 头像 | 否 |
isMutual | boolean | 是否互相关注 | 否 |
closenessScore | integer | 亲密度分数 | 否 |
attentionScore | integer | 关注度分数 | 否 |
tags | string | 标签 | 否 |
status | string | 状态 | 否 |
remark | string | 备注 | 否 |
createDate | string | 创建日期 | 否 |
FollowerPutModel☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
alias | string | 别名 | 否 |
closenessScore | integer | 亲密度分数 | 否 |
attentionScore | integer | 关注度分数 | 否 |
tags | string | 标签 | 否 |
status | string | 状态 | 否 |
remark | string | 备注 | 否 |
GeoLocation☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | 唯一标识 | 否 |
bizCode | string | 业务代码 | 是 |
bizID | integer | 业务ID | 是 |
coordinates | - | - | 是 |
locationName | string | 地点的名称 | 否 |
locationType | string | 地点类型 | 否 |
recipientName | string | 收货人姓名 | 否 |
phoneNumber | string | 收货人联系电话 | 否 |
string | 收货人电子邮件 | 否 | |
country | string | 国家 | 否 |
state | string | 州/省 | 否 |
city | string | 城市 | 否 |
district | string | 区/县 | 否 |
street | string | 街道 | 否 |
zipCode | string | 邮政编码 | 否 |
address | string | 详细的地址信息 | 否 |
mapType | string | 地址类型 | 否 |
remark | string | 备注 | 否 |
tags | string | 标签 | 否 |
enable | boolean | 是否启用 | 否 |
showIndex | integer | 排序索引 | 否 |
createDate | string | 创建时间 | 否 |
lastUpdate | string | 最后更新时间 | 否 |
GetUserProfileResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
user | - | - | 否 |
currencies | array | - | 否 |
role | string | - | 否 |
location | - | - | 否 |
GetUserProfileResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
MySqlGeometry☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
xCoordinate | number | - | 否 |
yCoordinate | number | - | 否 |
srid | integer | - | 否 |
isNull | boolean | - | 否 |
value | string | - | 否 |
RecommendFriend☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
userID | integer | 用户ID | 否 |
nickName | string | 昵称 | 否 |
avatar | string | 头像 | 否 |
gender | string | 性别 | 否 |
age | integer | 年龄 | 否 |
interestTags | string | 兴趣标签 | 否 |
locationName | string | 位置名称 | 否 |
latitude | number | 纬度 | 否 |
longitude | number | 经度 | 否 |
distance | integer | 距离 | 否 |
biography | string | 个人简介 | 否 |
country | string | 国家 | 否 |
state | string | 省份 | 否 |
city | string | 城市 | 否 |
district | string | 区县 | 否 |
User☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | 用户唯一标识 | 否 |
platform | string | 用户所在平台 | 否 |
unionID | string | 用户所在平台的唯一标识 | 否 |
nickName | string | 昵称 | 否 |
avatar | string | 头像 | 否 |
data | string | 其他数据 | 否 |
userName | string | 用户名 | 否 |
pwd | string | 用户密码 | 否 |
string | 邮箱地址 | 否 | |
emailIsValid | boolean | 邮箱已验证 | 否 |
phone | string | 手机号码 | 否 |
phoneIsValid | boolean | 手机号码已验证 | 否 |
relationChain | string | 关系链 | 否 |
interestTags | string | 兴趣标签 | 否 |
biography | string | 个人简介 | 否 |
gender | string | 性别 | 否 |
birthday | string | 生日 | 否 |
occupation | string | 职业 | 否 |
education | string | 学历 | 否 |
contact | string | 联系方式 | 否 |
languages | string | 语言 | 否 |
socialLinks | string | 社交网络链接 | 否 |
relationshipStatus | string | 婚姻状态 | 否 |
company | string | 公司 | 否 |
industry | string | 行业 | 否 |
companyPosition | string | 行业职位 | 否 |
privateSettings | string | 私密设置 | 否 |
isLock | boolean | 账户是否锁定 | 否 |
lockUntil | string | 账户锁定截止时间 | 否 |
enableUserNameSignIn | boolean | 能使用用户名登录 | 否 |
enableEmailSignIn | boolean | 能使用邮箱登录 | 否 |
enablePhoneSignIn | boolean | 能使用电话号码登录 | 否 |
enableUnionIDSignIn | boolean | 能使用联合身份标识登录 | 否 |
enableOAuth | boolean | 能使用OAuth认证方式登录 | 否 |
enable2FAAuth | boolean | 启用双因素认证登录 | 否 |
createDate | string | 创建时间 | 否 |
lastUpdate | string | 最后更新时间 | 否 |
UserCommonInterestsResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
totalFollowers | integer | - | 否 |
data | array | - | 否 |
UserCommonInterestsResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
UserCurrency☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | 用户资产的唯一标识符。 | 否 |
userID | integer | 与用户资产关联的用户ID。 | 否 |
currencyCode | string | 用户资产的货币代码,例如 'USD', 'CNY' 等。 | 否 |
balance | integer | 用户的账户余额,表示当前持有的货币数量。 | 否 |
UserFollowersResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
totalFollowers | integer | - | 否 |
data | array | - | 否 |
UserFollowersResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
UserFriendsNearByResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
total | integer | 符合条件的总记录数 | 否 |
data | array | 当前分页的用户数据列表 | 否 |
UserFriendsNearByResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
UserMutualFollowersResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
totalFollowers | integer | - | 否 |
data | array | - | 否 |
UserMutualFollowersResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
UserMutualFollowingsResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
totalFollowers | integer | - | 否 |
data | array | - | 否 |
UserMutualFollowingsResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
通用错误码☍
错误码 | 说明 |
---|---|
200 | 成功 |