/group/get_info

描述

获取Group的信息,包括Group中的Person列表,Group的tag等信息

参数

参数名 参数说明
必须 api_key App的Face++ API Key
api_secret APP的Face++ API Secret
group_id 或 group_name 待查询Group的id或name。开发者也可以指定group_id=none,此时将返回所有未加入任何Group的Person。

返回值说明

字段 类型 说明
person array 属于该group的person信息
tag string group相关的tag
group_name string 相应group的name
group_id string 相应group的id

调用示例

https://apicn.faceplusplus.com/v2/group/get_info?api_secret=YOUR_API_SECRET&api_key=YOUR_API_KEY&group_name=Family

JSON 示例

{
    "person": [
        {
            "person_id": "98b0fe01f6f212e19a3e659e324e37ab", 
            "tag": "", 
            "person_name": "Alice"
        }, 
        {
            "person_id": "9d1598f2831eadfc5817008859865cbd", 
            "tag": "", 
            "person_name": "Bob"
        }
    ], 
    "group_id": "f539fa9f6e4689397c76c57f2cfb4edc", 
    "tag": "created_by_Alice", 
    "group_name": "Family"
}

错误列表

错误代码 HTTP 状态代码 错误信息
1001 500 INTERNAL_ERROR
1003 403 AUTHORIZATION_ERROR
1003 403 INSUFFICIENT_PRIVILEGE_OR_QUOTA_LIMIT_EXCEEDED
1004 400 MISSING_ARGUMENTS
1005 400 INVALID_ARGUMENTS
1006 403 ILLEGAL_USE_OF_DEMO_KEY
1202 502 SERVER_TOO_BUSY