You can call the getPersonInfo operation to query the information of an individual, such as the individual name, associated face image ID, and individual group ID.
QPS limits
You can call this operation up to 20 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
Request syntax
POST /green/sface/person HTTPS|HTTPRequest headers
This operation uses only common request headers. For more information, see Common request headers.
Request parameters
Parameter | Type | Required | Example | Description |
clientInfo | JSONObject | No | {"userId":"120234234","userNick":"Mike","userType":"others"} | The client information that is serialized from the ClientInfo structure in the JSON format. The information includes the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo. |
RequestBody
You also need to specify the following parameters in RequestBody to specify the individual information to be queried.
Parameter | Type | Required | Example | Description |
personId | String | Yes | person1 | The ID of the individual to query. |
Response parameters
JSON-formatted data is returned for all requests. For more information about common response parameters, see Common response parameters. The data parameter in the response is used to return business-related data. In general, the value of this parameter is a JSON structure or array.
The data parameter may be empty when an error occurs.
The following table describes the parameters that are returned in the data field.
Parameter | Type | Example | Description |
code | Integer | 200 | The returned HTTP status code. For more information, see Common error codes. |
personId | String | person1 | The ID of the individual. |
name | String | Tom | The name of the individual. |
groupIds | StringArray | ["group1","group2"] | The list of individual group IDs to which the individual belongs. |
faceIds | StringArray | ["1234999323333","124556455466"] | The ID list of face images associated with the individual. |
note | String | Male | The description of the individual. |
Examples
Sample requests
POST /green/sface/person HTTP/1.1
Common request headers
{
"personId": "person1"
}Sample success responses
{
"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"
}
}