detection.face.detected (Face match)

detection.face.detected: Face match

detection.face.detected · Channel scope · Message query permission Alarm

What it does

Reported when face match triggers. The uplink msgType is detection.face.detected. Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

Fields inside outputData. Platform fields: Overview and common payload.

Name	Description	Type	Required	Values
`id`	Face library ID.	`text`	no	string
`faces`	Face attribute list. Up to 100 entries.	`array`	no	Up to `100` entries
`snapFace`	Snapshot face.	`struct`	no	struct
`candidates`	Match candidates. Up to 100 entries.	`array`	no	Up to `100` entries
`isDuplicateRemove`	Deduplicate.	`text`	no	string
`address`	Snapshot URL.	`text`	no	string
`passerby`	Passerby library with `uid`, `groupId`, `groupName`.	`struct`	no	Includes `uid`, `groupId`, `groupName`
`passerby.uid`	Passerby ID.	`text`	no	string
`passerby.groupId`	Passerby library ID.	`text`	no	string
`passerby.groupName`	Passerby library name.	`text`	no	string
`ptzInfo`	PTZ info with `presetNumber`, `presetName`.	`struct`	no	Includes `presetNumber`, `presetName`
`ptzInfo.presetNumber`	Preset number. Range 0-999999, step 1.	`int`	no	`0`-`999999`, step `1`
`ptzInfo.presetName`	Preset name.	`text`	no	string

Example

{
 "msgType": "detection.face.detected",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "channelId": "0",
 "outputData": {
 "id": "example",
 "faces": [],
 "snapFace": {},
 "candidates": [],
 "isDuplicateRemove": "example",
 "address": "example",
 "passerby": {
 "uid": "example",
 "groupId": "example",
 "groupName": "example"
 },
 "ptzInfo": {
 "presetNumber": 0,
 "presetName": "example"
 }
 },
 "time": 1673406989,
 "localTime": "20230111T111629",
 "alarmId": "116257862023505xxxx",
 "token": "f2dc8c09eeae4b5bad6abf522c93d825",
 "thumbUrl": "https://example.imou.com/pic/thumb.jpg",
 "picUrlArray": [
 "https://example.imou.com/pic/frame1.jpg",
 "https://example.imou.com/pic/frame2.jpg"
 ]
}

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the alarm-message permission. A bound sub-user does not. A sub-account needs Alarm. list/search filters out events you are not allowed to see. Face recognition.