Deletes one or more face images associated with an individual from the face library.
QPS limits
This operation supports up to 20 calls per second per account. Exceeding this limit triggers throttling, which may affect your service.
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 | JSON object | No | {"userId":"120234234","userNick":"Mike","userType":"others"} | The client information serialized from the ClientInfo structure in JSON format. The information includes the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo. |
Request body
Specify the following parameters in the request body to identify the face images to delete.
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| personId | String | Yes | person1 | The ID of the individual associated with the face images. |
| faceIds | String array | Yes | ["1244453323565","1345345466455"] | The IDs of the face images to delete. To get face image IDs, call the getPersonInfo operation. |
Response parameters
All responses are returned as JSON. For more information about common response parameters, see Common response parameters. Business-specific data is returned in the data field as a JSON object or array.
The data field may be empty if an error occurs.The following table describes the parameters returned in the data field.
| Parameter | Type | Example | Description |
|---|---|---|---|
| code | integer | 200 | The HTTP status code. For more information, see Common error codes. |
| personId | String | person1 | The ID of the individual. |
| faceIds | String array | ["1244453323565","1345345466455"] | The IDs of the successfully deleted face images. |
| deleteCount | integer | 2 | The number of successfully deleted face images. |
Examples
Sample request:
POST /green/sface/face/delete HTTP/1.1
Common request headers
{
"personId": "person1",
"faceIds": [
"1244453323565",
"1345345466455"
]
}Sample success response:
{
"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.