Skip to content
On this page

Group Detail

  • Endpoint Path: /api/v2/group/{gid}/detail
  • Method: GET
  • Request: Rest

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Rest Params

Parameter NameTypeRequiredDescription
gidStringrequired小组 GID

Query Params

Parameter NameTypeRequiredDescription
whitelistKeysStringoptional白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
blacklistKeysStringoptional黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "items": {
            "title": "String / SEO 标题",
            "keywords": "String / SEO 关键词",
            "description": "String / SEO 描述",
            "extensions": [
                {
                    // 小组的扩展
                    // Common Data Structure -> Extend Function Info
                }
            ]
        },
        "detail": {
            // Common Data Structure -> Group Info
        }
    }
}

Released under the Apache-2.0 License