/group/create

描述

创建一个Group

一个Group最多允许包含10000个Person。
开发版最多允许创建5个group。

参数

 参数名参数说明
必须 api_key App的Face++ API Key
  api_secret APP的Face++ API Secret
  group_name Group的Name信息,必须在App中全局唯一。Name不能包含^@,&=*'"等非法字符,且长度不得超过255。Name也可以不指定,此时系统将产生一个随机的name。
可选 tag Group的tag,不需要全局唯一,不能包含^@,&=*'"等非法字符,长度不能超过255。
  person_id 或 person_name 一组用逗号分隔的person_id或person_name, 表示将这些Person加入到该Group中。注意,一个Person可以被加入到多个Group中。

返回值说明

字段类型说明
added_person int 成功加入的person数量
tag string group相关的tag
group_name string 相应group的name
group_id string 相应group的id

调用示例

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

JSON 示例

{
    "added_person": 0,
    "group_id": "f539fa9f6e4689397c76c57f2cfb4edc", 
    "group_name": "Family",
    "tag": "created_by_Alice"
}

错误列表

错误代码HTTP 状态代码错误信息
1001 500 INTERNAL_ERROR
1003 403 AUTHORIZATION_ERROR
1003 403 INSUFFICIENT_PRIVILEGE_OR_QUOTA_LIMIT_EXCEEDED
1004 400 MISSING_ARGUMENTS
1008 400 TOO_MANY_ITEMS_TO_ADD
1005 400 INVALID_ARGUMENTS
1006 403 ILLEGAL_USE_OF_DEMO_KEY
1202 502 SERVER_TOO_BUSY
1501 451 BAD_NAME
1502 452 BAD_TAG
1503 453 NAME_EXIST