跳到主要内容

圈子动态

圈子-提交创建圈子申请

允许已授权的用户通过此接口更新自己的信息。

  • URL/app-api/circle/base-info/create
  • MethodPOST
  • 需要鉴权:是

请求参数

参数类型约束
circleNameString圈子名称,必传
circleLogoString圈子logo,必传
circleDescString圈子描述,必传
circleTagsString圈子标签,非必传
applyUserNameString申请人姓名,必传
applyUserPhoneString申请人手机号,必传

请求示例

可以仅传递部分请求参数。

{
"circleName":"吕国栋的直播间",
"circleLogo":"https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"circleDesc":"吕国栋的直播间",
"circleTags":"#标签1#标签2",
"applyUserName":"吕国栋",
"applyUserPhone":"18612982956",
"extend":"备注"
}

响应示例

{
"code": 0,
"data": {
"id": 9,
"memberUserId": 305,
"circleName": "LKD台球圈",
"circleLogo": "https://zhuangqiudi-public.oss-cn-shanghai.aliyuncs.com/5a527e0bfac791655c1a0c3ecef9345085f6ce6b4ce380a1c53d784ea750898c.png",
"circleDesc": "圈子简介",
"circleTags": "#lkd#斯诺克",
"applyUserName": "陈泽宇",
"applyUserPhone": "18612982956",
"status": 1,
"circleFriendsCount": 0,
"discussCount": 0,
"sort": 99999,
"extend": null,
"createTime": 1735915122000
},
"msg": "成功"
}

响应说明

参数类型说明
idLong圈子数据编号
memberUserIdLong用户编号
circleNameString圈子名称
circleLogoString圈子logo
circleDescString圈子描述
circleTagsString圈子标签
applyUserNameString申请人姓名
applyUserPhoneString申请人手机号
statusLong审核状态0-禁用 1-审核中 2-正常
extendString审核反馈
circleFriendsCountLong圈友数
discussCountLong讨论数(动态数)
sortLong排序
提示

圈子创建成功,申请人为圈主,自动加入圈子。


圈子-修改圈子申请

当创建申请被驳回时,用户可以修改申请内容,并重新提交申请。

  • URL/app-api/circle/base-info/update
  • MethodPOST
  • 需要鉴权:是

请求参数

参数类型约束
idString圈子数据编号,必传
circleNameString圈子名称,非必传
circleLogoString圈子logo,非必传
circleDescString圈子描述,非必传
circleTagsString圈子标签,非必传
applyUserNameString申请人姓名,非必传
applyUserPhoneString申请人手机号,非必传

请求示例

可以仅传递部分请求参数。

{
"id":2,
"circleName":"吕国栋的直播间",
"circleLogo":"https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"circleDesc":"吕国栋的直播间",
"circleTags":"#标签1#标签2",
"applyUserName":"吕国栋",
"applyUserPhone":"18612982956",
"extend":"备注"
}

响应示例

{
"code": 200,
"data": true,
"msg": "成功"
}

响应说明

参数类型约束
databooleantrue 提交成功,false 失败

圈子-获取圈子详情

  • URL/app-api/circle/base-info/get?id=3
  • MethodGET
  • 需要鉴权:是

请求参数

注意

id 为圈子数据编号,必传。

请求示例

localhost:48080/app-api/circle/base-info/get?id=3

响应示例

{
"code": 200,
"data": {
"memberUserId": 250,
"circleName": "吕国栋的直播间",
"circleLogo": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"circleDesc": "吕国栋的直播间",
"circleTags": "#标签1#标签2",
"applyUserName": "吕国栋",
"applyUserPhone": "18612982956",
"status": 1,
"circleFriendsCount": 0,
"discussCount": 0,
"sort": 99999,
"extend": "备注",
"id": 3,
"createTime": 1701225532000
},
"msg": "成功"
}

响应说明

参数类型约束
idLong圈子数据编号
memberUserIdLong用户编号
circleNameString圈子名称
circleLogoString圈子logo
circleDescString圈子描述
circleTagsString圈子标签
applyUserNameString申请人姓名
applyUserPhoneString申请人手机号
statusLong审核状态
extendString审核反馈
circleFriendsCountLong圈友数
discussCountLong讨论数(动态数)
sortLong排序

圈子-删除圈子

  • URL/app-api/circle/base-info/delete?id=3
  • MethodGET
  • 需要鉴权:是

请求参数

注意

id 为圈子数据编号,必传。

请求示例

localhost:48080/app-api/circle/base-info/delete?id=3

响应示例

{
"code": 200,
"data": true,
"msg": "成功"
}

响应说明

参数类型约束
databooleantrue 成功,false 失败

圈子-用户加入圈子

  • URL/app-api/circle/base-info/joinCircle
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

circleId 为圈子数据编号,必传。

请求示例

{
"circleId":2
}

响应示例

{
"code": 200,
"data": 1,
"msg": "成功"
}

错误详情

{
"code": -1,
"data": null,
"msg": "已加入圈子,无须重复加入"
}

响应说明

参数类型约束
dataLong数据编号,返回即添加成功

圈子-退出已加入圈子

  • URL/app-api/circle/base-info/quitCircle
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

memberUserId 为圈子用户的数据编号,circleId 为圈子数据编号,必传。

请求示例

{
"memberUserId":250,
"circleId":2
}

响应示例

{
"code": 200,
"data": true,
"msg": "成功"
}

响应说明

参数类型约束
dataBoolean布尔值

圈子-获取所有圈子列表

  • URL/app-api/circle/base-info/page
  • MethodPOST
  • 需要鉴权:是

请求参数

提示

需要分页,可以通过以下参数进行筛选。

参数类型约束
circleNameString圈子名称,非必传
circleDescString圈子描述,非必传
circleTagsString圈子标签,非必传

请求示例

{
"circleName": "LKD台",
"pageNo":1,
"pageSize":2
}

响应示例

{
"code": 200,
"data": {
"list": [
{
"memberUserId": 250,
"circleName": "吕国栋的直播间",
"circleLogo": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"circleDesc": "吕国栋的直播间",
"circleTags": "#标签1#标签2",
"applyUserName": "吕国栋",
"applyUserPhone": "18612982956",
"status": 1,
"circleFriendsCount": 0,
"discussCount": 0,
"sort": 99999,
"extend": "备注",
"id": 3,
"createTime": 1701225532000
}
],
"total": 3
},
"msg": "成功"
}

响应说明

参数类型约束
idLong圈子数据编号
memberUserIdLong用户编号
circleNameString圈子名称
circleLogoString圈子logo
circleDescString圈子描述
circleTagsString圈子标签
applyUserNameString申请人姓名
applyUserPhoneString申请人手机号
statusLong审核状态
extendString审核反馈
circleFriendsCountLong圈友数
discussCountLong讨论数(动态数)
sortLong排序

圈子-获取用户已加入圈子列表+用户创建的圈子列表

用户发表动态的时候调用此接口。

  • URL/app-api/circle/base-info/getMemberCirclePage
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

需要授权验证。

请求示例

无请求参数。

响应示例

{
"code": 0,
"data": {
"createdCircleList": [
{
"memberUserId": 305,
"circleId": 11,
"circleName": "LKD台球圈",
"circleLogo": "https://zhuangqiudi-public.oss-cn-shanghai.aliyuncs.com/5a527e0bfac791655c1a0c3ecef9345085f6ce6b4ce380a1c53d784ea750898c.png",
"circleDesc": "圈子简介",
"circleTags": "#lkd#斯诺克",
"applyUserName": "陈泽宇",
"status": 1
}
],
"joinCircleList": [
{
"memberUserId": 305,
"circleId": 11,
"circleName": "LKD台球圈",
"circleLogo": "https://zhuangqiudi-public.oss-cn-shanghai.aliyuncs.com/5a527e0bfac791655c1a0c3ecef9345085f6ce6b4ce380a1c53d784ea750898c.png",
"circleDesc": "圈子简介",
"circleTags": "#lkd#斯诺克",
"applyUserName": "陈泽宇",
"status": 1
}
]
},
"msg": "成功"
}

响应说明

参数类型约束
createdCircleListObject用户创建的圈子
joinCircleListObject用户已加入的圈子
memberUserIdLong用户编号
circleIdLong圈子数据编号
circleNameString圈子名称
circleLogoString圈子logo
circleDescString圈子描述
circleTagsString圈子描述
applyUserNameString圈子申请人
statusLong状态0-禁用 1-审核中 2-正常

动态

动态-发布动态

  • URL/app-api/trends/base-info/create
  • MethodPOST
  • 需要鉴权:是

请求参数

参数类型约束
trendsContentString动态内容
imgUrlString图片地址,多张图片用分号隔开
videoUrlString视频地址,视频仅能上传一个
circleIdLong圈子编号
extendString如果是视频,则此字段传视频文件的 file ID

请求示例

{
"trendsContent":"今天天气不错!",
"tendsTags":"#天气",
"circleId": 11
}

响应示例

{
"code": 0,
"data": {
"id": 112,
"publishMemberUserId": 305,
"trendsContent": "今天天气不错!",
"tendsTags": "#天气",
"isHeat": true,
"circleId": 11,
"circleName": "LKD台球圈",
"shareTimes": 0,
"commentTimes": 0,
"collectTimes": 0,
"likeTimes": 0,
"imgUrl": null,
"videoUrl": null,
"status": 1,
"extend": null,
"createTime": 1736941711000
},
"msg": "成功"
}

响应说明

参数类型约束
idLong数据编号
publishMemberUserIdLong作者数据编号
trendsContentString动态内容
imgUrlString图片地址,如果是多个图片,则用分号分割,最多发布9张图片。用户发布动态的时候,由前端组合
videoUrlString视频地址,只能一个视频
statusLong动态状态0-不展示1-展示
createTimeLong发布时间
isHeatBoolean是否热帖
circleIdLong圈子编号
circleNameString圈子名称
shareTimesLong分享次数
commentTimesLong回复次数
collectTimesLong收藏次数

动态-更新动态

  • URL/app-api/trends/base-info/update
  • MethodPOST
  • 需要鉴权:是

请求参数

参数类型约束
idLong数据编号,必传
trendsContentString动态内容
imgUrlString图片地址,多张图片用分号隔开
videoUrlString视频地址,视频仅能上传一个
circleIdLong圈子编号

请求示例

{
"id": 111,
"trendsContent": "今天天气不错!",
"tendsTags": "#天气",
"circleId": 8,
"imgUrl": "https://jingqihui.oss-cn-beijing.aliyuncs.com/009be8d928d1b639c120b5c4385c32503c3c0453a8c4b403b27d62bf1e8f325c.jpg",
"videoUrl": "https://1500035483.vod-qcloud.com/6cd08a3fvodcq1500035483/ae3d2c961397757901515884449/f0.mp4"
}

响应示例

{
"code": 0,
"data": true,
"msg": "成功"
}

响应说明

参数类型约束
dataLong返回的动态数据编号

动态-获取动态详情

  • URL/app-api/trends/base-info/getTrendsInfo
  • MethodPOST
  • 需要鉴权:是

请求参数

参数类型约束
idLong数据编号
注意

用户是否登录,均可进行获取(非必须授权)。

请求示例

{
"id":1
}

响应示例

{
"code": 200,
"data": {
"publishMemberUserId": 250,
"trendsContent": "动态内容1",
"tendsTags": null,
"isHeat": false,
"circleId": 1,
"circleName": "圈子名称",
"shareTimes": 0,
"commentTimes": 0,
"collectTimes": 0,
"likeTimes": 1,
"imgUrl": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"videoUrl": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"status": 1,
"extend": null,
"id": 1,
"createTime": 1701248361000,
"memberUserNickname": "撞球帝",
"memberUserAvatar": "https://zhuangqiudi.oss-cn-shanghai.aliyuncs.com/static/logo.png",
"isFocus": false,
"comments": null
},
"msg": "成功"
}

响应说明

参数类型约束
idLong数据编号
publishMemberUserIdLong作者数据编号
memberUserNicknameString作者昵称
memberUserAvatarString作者头像
isFocusBoolean当前用户是否关注作者
trendsContentString动态内容
imgUrlString图片地址,如果是多个图片,则用分号分割,最多发布9张图片。用户发布动态的时候,由前端组合
videoUrlString视频地址,只能一个视频
statusLong动态状态0-不展示1-展示
createTimeLong发布时间
isHeatBoolean是否热帖
circleIdLong圈子编号
circleNameString圈子名称
shareTimesLong分享次数
commentTimesLong回复次数
collectTimesLong收藏次数
likeTimesLong点赞次数

动态-删除动态

  • URL/app-api/trends/base-info/delete
  • MethodGET
  • 需要鉴权:是

请求参数

参数类型约束
idLong数据编号
注意

id 必传。

请求示例

localhost:48080/app-api/trends/base-info/delete?id=111

响应示例

{
"code": 200,
"data": true,
"msg": "成功"
}

响应说明

参数类型约束
dataBoolean布尔值

圈子+动态

圈子主页-动态列表分页

  • URL/app-api/trends/base-info/getCircleTrendsPage
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

如果用户登录了,会返回:是否关注了该动态的作者,是否加入了圈子。

参数类型约束
pageNoLong页码
pageSizeLong页大小
circleIdLong圈子编号
trendsContentString动态内容-搜索关键字

请求示例

{
"pageNo":1,
"pageSize":1,
"circleId":1
}

响应示例

{
"code": 200,
"data": {
"pageResult": {
"list": [
{
"publishMemberUserId": 250,
"trendsContent": "动态内容",
"tendsTags": null,
"isHeat": true,
"circleId": 1,
"circleName": "圈子名称",
"shareTimes": 0,
"commentTimes": 0,
"collectTimes": 0,
"likeTimes": 0,
"imgUrl": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"videoUrl": "https://kanglebang.oss-cn-shanghai.aliyuncs.com/static/1685533854019.jpg",
"status": 1,
"extend": null,
"id": 3,
"createTime": 1701353633000,
"memberUserNickname": "撞球帝",
"memberUserAvatar": "https://zhuangqiudi.oss-cn-shanghai.aliyuncs.com/static/logo.png",
"isFocus": false,
"comments": null
}
],
"total": 2
},
"circleBaseInfoRespApiVO": {
"memberUserId": 250,
"circleName": "lkd测试圈子",
"circleLogo": "https://zhuangqiudi-public.oss-cn-shanghai.aliyuncs.com/51a94cd1222f91640f7be84ef296ea3d374c68a85f059126d5d023a8e764950f.png",
"circleDesc": "圈子简介",
"circleTags": "#lkd#斯诺克",
"applyUserName": "吕国栋",
"applyUserPhone": "18612982956",
"status": 2,
"circleFriendsCount": null,
"discussCount": null,
"sort": 1,
"extend": null,
"id": 1,
"createTime": 1701174596000,
"isJoinCircle": false
}
},
"msg": "成功"
}

响应说明

参数类型约束
pageResultObject动态数据分页对象
idLong数据编号
publishMemberUserIdLong作者数据编号
memberUserNicknameString作者昵称
memberUserAvatarString作者头像
isFocusBoolean当前用户是否关注作者
trendsContentString动态内容
imgUrlString图片地址,如果是多个图片,则用分号分割,最多发布9张图片。用户发布动态的时候,由前端组合
videoUrlString视频地址,只能一个视频
statusLong动态状态0-不展示1-展示
createTimeLong发布时间
isHeatBoolean是否热帖
circleIdLong圈子编号
circleNameString圈子名称
shareTimesLong分享次数
commentTimesLong回复次数
collectTimesLong收藏次数
likeTimesLong点赞次数
isCollectActionBoolean当前用户是否收藏了该帖子
circleBaseInfoRespApiVOObject圈子信息
idLong圈子编号
circleNameString圈子名称
circleLogoString圈子logo
circleDescString圈子描述
statusLong状态0-禁用 1-审核中 2-正常
createTimeLong创建时间
isJoinCircleBoolean当前用户是否已经加入圈子

用户+动态

动态-我的动态-动态列表分页

  • URL/app-api/trends/base-info/getMyTrendsPage
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

必须授权。

参数类型约束
pageNoLong页码
pageSizeLong页大小

请求示例

{
"pageNo": 1,
"pageSize": 10
}

响应示例

{
"code": 0,
"data": {
"list": [
{
"id": 112,
"publishMemberUserId": 305,
"trendsContent": "今天天气不错!",
"tendsTags": "#天气",
"isHeat": true,
"circleId": 11,
"circleName": "LKD台球圈",
"shareTimes": 0,
"commentTimes": 0,
"collectTimes": 0,
"likeTimes": 0,
"imgUrl": null,
"videoUrl": null,
"status": 1,
"extend": null,
"createTime": 1736941711000,
"publishMemberUserNickname": "吕国栋",
"publishMemberUserAvatar": "https://jingqihui.oss-cn-beijing.aliyuncs.com/tmp_ed59aa031dd916655f5a9394c3a1344f4b21e78f3ef37af1.jpg",
"isFocus": false,
"isCollectAction": false,
"comments": null,
"videoCoverImg": null
}
],
"total": 2
},
"msg": "成功"
}

响应说明

参数类型约束
pageResultObject动态数据分页对象
idLong数据编号
publishMemberUserIdLong作者数据编号
memberUserNicknameString作者昵称
memberUserAvatarString作者头像
isFocusBoolean当前用户是否关注作者
trendsContentString动态内容
imgUrlString图片地址,如果是多个图片,则用分号分割,最多发布9张图片。用户发布动态的时候,由前端组合
videoUrlString视频地址,只能一个视频
statusLong动态状态0-不展示1-展示
createTimeLong发布时间
isHeatBoolean是否热帖
circleIdLong圈子编号
circleNameString圈子名称
shareTimesLong分享次数
commentTimesLong回复次数
collectTimesLong收藏次数
likeTimesLong点赞次数
isFocusBoolean是否关注
isCollectActionBoolean是否收藏
videoCoverImgString视频封面图片地址