detection.face.list (Query face library)

detection.face.list: Query face library

detection.face.list · Channel scope · Permission Config

What it does

Query the local face library. No inputs—inputData is {}. One invoke runs one action. Returns up to 99 faceDatabase entries.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008. A timeout does not mean the operation did not run.

Request parameters

Name	Type	Required	Description
`token`	String	yes	accessToken for administrator, sub-user, or sub-account
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional. If sent and it does not match the device model → `DV2009`
`channelId`	String	yes	Channel number; `"0"` is common on IPCs
`serviceId`	String	yes	`detection.face.list`
`inputData`	Object	conditional	Pass `{}` when there are no inputs

Common request fields and the signature are in Development specification.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "serviceId": "detection.face.list",
 "inputData": {}
 }
}

Response data fields

Output is in result.data.outputData.

Name	Description	Type	Required	Values
`faceDatabase`	Face library info. Up to 99 entries.	`array`	no	Up to `99` entries
`faceDatabase.item.id`	Face library ID.	`text`	no	string
`faceDatabase.item.faceImageID`	Image ID.	`text`	no	string

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "faceDatabase": [
 {
 "id": "face-1",
 "faceImageID": "img-1"
 }
 ]
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Face recognition