調用addPerson介面建立一個個體。
建立個體時,您必須為個體指定一個或者多個個體組。如果您指定了一個不存在的個體組,則會自動建立該個體組。
最多支援建立100個個體組。新的個體組需要在個體中新增人臉,才會實際建立新的個體組,新建立的個體組會在隔日生效。
建立個體後,您可以調用addFaces介面為個體添加關聯的人臉圖片。
QPS限制
本介面的單使用者QPS限制為20次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求文法
POST /green/sface/person/add HTTPS|HTTP要求標頭
該介面使用公用要求標頭,無特殊要求標頭。請參見公用要求標頭。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 用戶端資訊,由ClientInfo結構體通過JSON序列化獲得,包含umid、imei等資訊,具體結構描述,請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數,用來指定個體資訊。
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
groupIds | StringArray | 是 | ["group1","group2"] | 建立個體要加入的個體組ID列表。 個體組ID僅支援使用英文字母、數字、底線(_)和中劃線(-),且不超過32個字元。 說明 如果您指定的個體組ID不存在,則會自動建立該個體組。 |
personId | String | 是 | person1 | 建立個體的ID。 個體ID僅支援使用英文字母、數字、底線(_)和中劃線(-),且不超過32個字元。 |
name | String | 否 | Tom | 建立個體的名稱。 |
note | String | 否 | Male | 建立個體的備忘資訊。 |
返回資料
所有請求均返回JSON格式的資料。關於返回資料中的公用欄位,請參見公用返回參數。返回資料中的data欄位表示與業務相關的資料,一般是一個JSON結構體或數組。
響應出錯的情況下,data欄位可能為空白。
該介面返回的data欄位包含以下參數。
名稱 | 類型 | 樣本值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態代碼一致。 更多資訊,請參見公用錯誤碼。 |
personId | String | person1 | 建立個體的ID。 |
groupIds | StringArray | ["group1","group2"] | 建立個體對應的個體組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"
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。