获取树结构小组列表
开发中
GET
http://localhost:8080/api/v2/group/tree
请求参数
Query 参数
whitelistKeys
string
可选
多个以英文逗号隔开，支持「点表示法」表示多维数组
blacklistKeys
string
可选
多个以英文逗号隔开，支持「点表示法」表示多维数组
Header 参数
X-Fresns-App-Id
string
必需
密钥位置：控制面板->应用中心->应用密钥
默认值:
{{appId}}
X-Fresns-Client-Platform-Id
integer
必需
默认值:
{{clientPlatformId}}
X-Fresns-Client-Version
string
必需
默认值:
{{clientVersion}}
X-Fresns-Client-Device-Info
string
必需
压缩 Object 信息为字符串传参
默认值:
{{clientDeviceInfo}}
X-Fresns-Aid
string
可选
默认值:
{{aid}}
X-Fresns-Aid-Token
string
可选
默认值:
{{aidToken}}
X-Fresns-Uid
integer
可选
默认值:
{{uid}}
X-Fresns-Uid-Token
string
可选
默认值:
{{uidToken}}
X-Fresns-Signature
string
签名
X-Fresns-Signature-Timestamp
string
必需
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8080/api/v2/group/tree?whitelistKeys=&blacklistKeys=' \
--header 'X-Fresns-App-Id;' \
--header 'X-Fresns-Client-Platform-Id;' \
--header 'X-Fresns-Client-Version;' \
--header 'X-Fresns-Client-Device-Info;' \
--header 'X-Fresns-Aid: ' \
--header 'X-Fresns-Aid-Token: ' \
--header 'X-Fresns-Uid: ' \
--header 'X-Fresns-Uid-Token: ' \
--header 'X-Fresns-Signature;' \
--header 'X-Fresns-Signature-Timestamp;'返回响应
🟢200成功
application/json
Body
code
integer
必需
message
string
必需
data
array [object {6}]
必需
gid
string
小组 ID
gname
string
小组名称
description
string
小组描述
cover
string
小组封面图地址
banner
string
小组条幅图地址
groups
array[object (Group) {33}]
必需
示例
{
"code": 0,
"message": "string",
"data": [
{
"gid": "string",
"gname": "string",
"description": "string",
"cover": "string",
"banner": "string",
"groups": [
{
"gid": "string",
"url": "string",
"type": 0,
"gname": "string",
"description": "string",
"cover": "string",
"banner": "string",
"recommend": true,
"mode": 0,
"modeEndAfter": 0,
"find": 0,
"followType": 0,
"followUrl": "string",
"parentGid": "string",
"category": {
"gid": "string",
"gname": "string",
"description": "string",
"cover": "string",
"banner": "string"
},
"likeCount": 0,
"dislikeCount": 0,
"followCount": 0,
"blockCount": 0,
"postCount": 0,
"postDigestCount": 0,
"commentCount": 0,
"commentDigestCount": 0,
"permissions": {},
"createDate": "string",
"contentArchive": [
{
"code": "string",
"name": "string",
"description": "string",
"value": "string"
}
],
"operations": {
"customizes": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"buttonIcons": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"diversifyImages": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"tips": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
]
},
"extends": {
"textBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"infoBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"interactionBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
]
},
"creator": {
"fsid": "string",
"uid": 0,
"username": "string",
"url": "string",
"nickname": "string",
"avatar": "string",
"decorate": "string",
"banner": "string",
"gender": 0,
"birthday": "string",
"bio": "string",
"bioHtml": "string",
"location": "string",
"conversationLimit": 0,
"commentLimit": 0,
"timezone": "string",
"verifiedStatus": true,
"verifiedIcon": "string",
"verifiedDesc": "string",
"verifiedDateTime": "string",
"expired": true,
"expiryDateTime": "string",
"lastPublishPost": "string",
"lastPublishComment": "string",
"lastEditUsername": "string",
"lastEditNickname": "string",
"registerDate": "string",
"hasPassword": true,
"rankState": 0,
"status": true,
"waitDelete": true,
"waitDeleteDateTime": "string",
"nicknameColor": "string",
"rid": 0,
"roleName": "string",
"roleNameDisplay": true,
"roleIcon": "string",
"roleIconDisplay": true,
"roleExpiryDateTime": "string",
"roleRankState": 0,
"rolePermissions": {},
"roleStatus": true,
"stats": {
"likeUserCount": 0,
"likeGroupCount": 0,
"likeHashtagCount": 0,
"likePostCount": 0,
"likeCommentCount": 0,
"dislikeUserCount": 0,
"dislikeGroupCount": 0,
"dislikeHashtagCount": 0,
"dislikePostCount": 0,
"dislikeCommentCount": 0,
"followUserCount": 0,
"followGroupCount": 0,
"followHashtagCount": 0,
"followPostCount": 0,
"followCommentCount": 0,
"blockUserCount": 0,
"blockGroupCount": 0,
"blockHashtagCount": 0,
"blockPostCount": 0,
"blockCommentCount": 0,
"likeMeCount": 0,
"dislikeMeCount": 0,
"followMeCount": 0,
"blockMeCount": 0,
"postPublishCount": 0,
"postDigestCount": 0,
"postLikeCount": 0,
"postDislikeCount": 0,
"postFollowCount": 0,
"postBlockCount": 0,
"commentPublishCount": 0,
"commentDigestCount": 0,
"commentLikeCount": 0,
"commentDislikeCount": 0,
"commentFollowCount": 0,
"commentBlockCount": 0,
"extcredits1": 0,
"extcredits1Status": 0,
"extcredits1Name": "string",
"extcredits1Unit": "string",
"extcredits2": 0,
"extcredits2Status": 0,
"extcredits2Name": "string",
"extcredits2Unit": "string",
"extcredits3": 0,
"extcredits3Status": 0,
"extcredits3Name": "string",
"extcredits3Unit": "string",
"extcredits4": 0,
"extcredits4Status": 0,
"extcredits4Name": "string",
"extcredits4Unit": "string",
"extcredits5": 0,
"extcredits5Status": 0,
"extcredits5Name": "string",
"extcredits5Unit": "string"
},
"archives": [
{
"code": "string",
"name": "string",
"description": "string",
"value": "string"
}
],
"operations": {
"customizes": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"buttonIcons": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"diversifyImages": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"tips": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
]
},
"extends": {
"textBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"infoBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"interactionBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
]
},
"roles": [
{
"rid": 0,
"isMain": true,
"nicknameColor": "string",
"name": "string",
"nameDisplay": true,
"icon": "string",
"iconDisplay": true,
"permission": {},
"status": true
}
],
"interaction": {
"userName": "string",
"userUidName": "string",
"userUsernameName": "string",
"userNicknameName": "string",
"userRoleName": "string",
"userBioName": "string",
"likeSetting": true,
"likeName": "string",
"dislikeSetting": true,
"dislikeName": "string",
"followSetting": true,
"followName": "string",
"blockSetting": true,
"blockName": "string",
"publishPostName": "string",
"publishCommentName": "string",
"likeStatus": true,
"dislikeStatus": true,
"followStatus": true,
"followMeStatus": true,
"followNote": "string",
"blockStatus": true,
"blockMeStatus": true,
"blockNote": "string"
},
"conversation": {
"status": true,
"code": 0,
"message": "string"
}
},
"publishRule": {
"allowPost": true,
"subGroupPost": true,
"reviewPost": true,
"allowComment": true,
"reviewComment": true
},
"contentMeta": {
"post": [
{
"unikey": "string",
"name": "string",
"description": "string",
"code": "string",
"formElement": "string",
"elementType": "string",
"elementOptions": [
{
"name": "string",
"value": "string"
}
],
"isMultiple": true,
"isRequired": true,
"fileType": 0,
"fileAccept": "string",
"fileExt": "string",
"inputPattern": "string",
"inputMax": 0,
"inputMin": 0,
"inputMaxlength": 0,
"inputMinlength": 0,
"inputSize": 0,
"inputStep": 0,
"valueType": "string"
}
],
"comment": [
{
"unikey": "string",
"name": "string",
"description": "string",
"code": "string",
"formElement": "string",
"elementType": "string",
"elementOptions": [
{
"name": "string",
"value": "string"
}
],
"isMultiple": true,
"isRequired": true,
"fileType": 0,
"fileAccept": "string",
"fileExt": "string",
"inputPattern": "string",
"inputMax": 0,
"inputMin": 0,
"inputMaxlength": 0,
"inputMinlength": 0,
"inputSize": 0,
"inputStep": 0,
"valueType": "string"
}
]
},
"admins": [
{
"fsid": "string",
"uid": 0,
"username": "string",
"url": "string",
"nickname": "string",
"avatar": "string",
"decorate": "string",
"banner": "string",
"gender": 0,
"birthday": "string",
"bio": "string",
"bioHtml": "string",
"location": "string",
"conversationLimit": 0,
"commentLimit": 0,
"timezone": "string",
"verifiedStatus": true,
"verifiedIcon": "string",
"verifiedDesc": "string",
"verifiedDateTime": "string",
"expired": true,
"expiryDateTime": "string",
"lastPublishPost": "string",
"lastPublishComment": "string",
"lastEditUsername": "string",
"lastEditNickname": "string",
"registerDate": "string",
"hasPassword": true,
"rankState": 0,
"status": true,
"waitDelete": true,
"waitDeleteDateTime": "string",
"nicknameColor": "string",
"rid": 0,
"roleName": "string",
"roleNameDisplay": true,
"roleIcon": "string",
"roleIconDisplay": true,
"roleExpiryDateTime": "string",
"roleRankState": 0,
"rolePermissions": {},
"roleStatus": true,
"stats": {
"likeUserCount": 0,
"likeGroupCount": 0,
"likeHashtagCount": 0,
"likePostCount": 0,
"likeCommentCount": 0,
"dislikeUserCount": 0,
"dislikeGroupCount": 0,
"dislikeHashtagCount": 0,
"dislikePostCount": 0,
"dislikeCommentCount": 0,
"followUserCount": 0,
"followGroupCount": 0,
"followHashtagCount": 0,
"followPostCount": 0,
"followCommentCount": 0,
"blockUserCount": 0,
"blockGroupCount": 0,
"blockHashtagCount": 0,
"blockPostCount": 0,
"blockCommentCount": 0,
"likeMeCount": 0,
"dislikeMeCount": 0,
"followMeCount": 0,
"blockMeCount": 0,
"postPublishCount": 0,
"postDigestCount": 0,
"postLikeCount": 0,
"postDislikeCount": 0,
"postFollowCount": 0,
"postBlockCount": 0,
"commentPublishCount": 0,
"commentDigestCount": 0,
"commentLikeCount": 0,
"commentDislikeCount": 0,
"commentFollowCount": 0,
"commentBlockCount": 0,
"extcredits1": 0,
"extcredits1Status": 0,
"extcredits1Name": "string",
"extcredits1Unit": "string",
"extcredits2": 0,
"extcredits2Status": 0,
"extcredits2Name": "string",
"extcredits2Unit": "string",
"extcredits3": 0,
"extcredits3Status": 0,
"extcredits3Name": "string",
"extcredits3Unit": "string",
"extcredits4": 0,
"extcredits4Status": 0,
"extcredits4Name": "string",
"extcredits4Unit": "string",
"extcredits5": 0,
"extcredits5Status": 0,
"extcredits5Name": "string",
"extcredits5Unit": "string"
},
"archives": [
{
"code": "string",
"name": "string",
"description": "string",
"value": "string"
}
],
"operations": {
"customizes": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"buttonIcons": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"diversifyImages": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
],
"tips": [
{
"code": "string",
"style": "string",
"name": "string",
"description": "string",
"imageUrl": "string",
"imageActiveUrl": "string",
"displayType": 0,
"pluginUrl": "string"
}
]
},
"extends": {
"textBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"infoBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
],
"interactionBox": [
{
"eid": "string",
"type": 0,
"textContent": "string",
"textIsMarkdown": true,
"infoType": 0,
"infoTypeString": "string",
"cover": "string",
"title": "string",
"titleColor": "string",
"descPrimary": "string",
"descPrimaryColor": "string",
"descSecondary": "string",
"descSecondaryColor": "string",
"buttonName": "string",
"buttonColor": "string",
"position": 0,
"accessUrl": "string"
}
]
},
"roles": [
{
"rid": 0,
"isMain": true,
"nicknameColor": "string",
"name": "string",
"nameDisplay": true,
"icon": "string",
"iconDisplay": true,
"permission": {},
"status": true
}
],
"interaction": {
"userName": "string",
"userUidName": "string",
"userUsernameName": "string",
"userNicknameName": "string",
"userRoleName": "string",
"userBioName": "string",
"likeSetting": true,
"likeName": "string",
"dislikeSetting": true,
"dislikeName": "string",
"followSetting": true,
"followName": "string",
"blockSetting": true,
"blockName": "string",
"publishPostName": "string",
"publishCommentName": "string",
"likeStatus": true,
"dislikeStatus": true,
"followStatus": true,
"followMeStatus": true,
"followNote": "string",
"blockStatus": true,
"blockMeStatus": true,
"blockNote": "string"
},
"conversation": {
"status": true,
"code": 0,
"message": "string"
}
}
],
"interaction": {
"groupName": "string",
"likeSetting": true,
"likeName": "string",
"dislikeSetting": true,
"dislikeName": "string",
"followSetting": true,
"followName": "string",
"blockSetting": true,
"blockName": "string",
"publishPostName": "string",
"publishCommentName": "string",
"likeStatus": true,
"dislikeStatus": true,
"followStatus": true,
"followNote": "string",
"followExpired": true,
"followExpiryDateTime": "string",
"blockStatus": true,
"blockNote": "string"
}
}
]
}
]
}