addPersonオペレーションを呼び出して、個人を作成できます。
新しい個人を作成する場合は、その個人に1つ以上の個人グループを指定する必要があります。 存在しない個人グループを指定した場合、個人グループは自動的に作成されます。
最大100個の個人グループを作成できます。 対応する個人グループが実際に作成される前に、新しい個人に顔を追加する必要があります。新しい個人グループは、作成の翌日に有効になります。
個人を作成した後、addFaces オペレーションを呼び出して、関連付けられた顔画像を個人に追加できます。
QPS制限
このオペレーションは、アカウントごとに1秒間に最大20回呼び出すことができます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。 その結果、ビジネスに影響が及ぶ可能性があります。 このオペレーションを呼び出すときは、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/person/add HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | ClientInfo構造体からJSON形式でシリアル化されたクライアント情報。 情報には、クライアントの一意のマシン識別子（UMID）と国際モバイル機器識別子（IMEI）が含まれます。 詳細については、「ClientInfo」をご参照ください。 |
リクエスト本文
リクエスト本文には、次のパラメーターを指定する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
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
Common request headers
{
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}成功レスポンスの例
{
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}
}エラーコード
エラーコードの一覧については、サービスエラーコード を参照してください。