getPersonInfo 操作を呼び出して、個人名、関連付けられた顔画像 ID、個人グループ ID など、個人の情報をクエリできます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が生じる可能性があります。この操作を呼び出す際は、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/person HTTPS|HTTPリクエストヘッダー
この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | JSON 形式の ClientInfo 構造体からシリアル化されたクライアント情報。情報には、クライアントの一意識別子（UMID）と国際移動体装置識別子（IMEI）が含まれます。詳細については、「ClientInfo」をご参照ください。 |
リクエスト本文
クエリ対象の個人情報を指定するには、リクエスト本文で次のパラメーターも指定する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
personId | String | はい | person1 | クエリ対象の個人の ID。 |
レスポンスパラメーター
すべてのリクエストに対して JSON 形式のデータが返されます。共通レスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。レスポンスの data パラメーターは、ビジネス関連のデータを返すために使用されます。一般に、このパラメーターの値は JSON 構造体または配列です。
エラーが発生した場合、data パラメーターは空の場合があります。
次の表は、data フィールドで返されるパラメーターを示しています。
パラメーター | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
personId | String | person1 | 個人の ID。 |
name | String | Tom | 個人の名前。 |
groupIds | StringArray | ["group1","group2"] | 個人が属する個人グループ ID のリスト。 |
faceIds | StringArray | ["1234999323333","124556455466"] | 個人に関連付けられた顔画像の ID リスト。 |
note | String | Male | 個人の説明。 |
例
リクエストの例
POST /green/sface/person HTTP/1.1
共通リクエストヘッダー
{
"personId": "person1"
}成功レスポンスの例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"name": "Tom",
"groupIds": [
"group1",
"group2"
],
"faceIds": [
"1234999323333",
"124556455466"
],
"note": "Male"
}
}