新建個體
調(diào)用addPerson接口新建一個個體。
新建個體時，您必須為個體指定一個或者多個個體組。如果您指定了一個不存在的個體組，則會自動創(chuàng)建該個體組。
最多支持創(chuàng)建100個個體組。
新建個體后，您可以調(diào)用addFaces接口為個體添加關(guān)聯(lián)的人臉圖片。
QPS限制
本接口的單用戶QPS限制為20次/秒。超過限制，API調(diào)用會被限流，這可能會影響您的業(yè)務(wù)，請合理調(diào)用。
請求語法
POST /green/sface/person/add HTTPS|HTTP請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求頭。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 客戶端信息，由ClientInfo結(jié)構(gòu)體通過JSON序列化獲得，包含umid、imei等信息，具體結(jié)構(gòu)描述，請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數(shù)，用來指定個體信息。
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
groupIds | StringArray | 是 | ["group1","group2"] | 新建個體要加入的個體組ID列表。 個體組ID僅支持使用英文字母、數(shù)字、下劃線（_）和中劃線（-），且不超過32個字符。 說明 如果您指定的個體組ID不存在，則會自動創(chuàng)建該個體組。 |
personId | String | 是 | person1 | 新建個體的ID。 個體ID僅支持使用英文字母、數(shù)字、下劃線（_）和中劃線（-），且不超過32個字符。 |
name | String | 否 | Tom | 新建個體的名稱。 |
note | String | 否 | Male | 新建個體的備注信息。 |
返回數(shù)據(jù)
所有請求均返回JSON格式的數(shù)據(jù)。關(guān)于返回數(shù)據(jù)中的公共字段，請參見公共返回參數(shù)。返回數(shù)據(jù)中的data字段表示與業(yè)務(wù)相關(guān)的數(shù)據(jù)，一般是一個JSON結(jié)構(gòu)體或數(shù)組。
響應(yīng)出錯的情況下，data字段可能為空。
該接口返回的data字段包含以下參數(shù)。
名稱 | 類型 | 示例值 | 描述 |
code | Integer | 200 | 錯誤碼，和HTTP狀態(tài)碼一致。 更多信息，請參見公共錯誤碼。 |
personId | String | person1 | 新建個體的ID。 |
groupIds | StringArray | ["group1","group2"] | 新建個體對應(yīng)的個體組ID列表。 |
示例
請求示例
POST /green/sface/person/add HTTP/1.1
公共請求頭
{
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}正常返回示例
{
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。