You can call this operation to delete a face image.
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/face/delete 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 face image information to be deleted.
Parameter | Type | Required | Example | Description |
personId | String | Yes | person1 | The ID of the individual associated with the face image. |
faceIds | StringArray | Yes | ["1244453323565","1345345466455"] | The ID list of the face image to be deleted. Note You can call the getPersonInfo operation to query the ID of the face image associated with an individual. |
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. |
faceIds | StringArray | ["1244453323565","1345345466455"] | The ID list of successfully deleted face images. |
deleteCount | Integer | 2 | The number of successfully deleted face images. |
Examples
Sample requests
POST /green/sface/face/delete HTTP/1.1
Common request headers
{
"personId": "person1",
"faceIds": [
"1244453323565",
"1345345466455"
]
}Sample success responses
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"faceIds": [
"1244453323565",
"1345345466455"
],
"deleteCount": 2
}
}Error codes
For a list of error codes, see Service error codes.