Skip to main content

Region Entry/Exit Detection Configuration

Application Guide

For a complete walkthrough with code examples, see the Perimeter Security & Line Crossing application guide.

GetSmartAoiEntryConfig​

Retrieves region entry detection configuration. Triggers an alarm when a target enters a defined area (AOI — Area of Interest).

FieldValue
Endpoint/GetSmartAoiEntryConfig[/channelId]
MethodPOST or GET
ProductsIPC
Channel IDOptional (default 1)

GetSmartAoiLeaveConfig​

Retrieves region exit detection configuration. Triggers an alarm when a target leaves a defined area.

FieldValue
Endpoint/GetSmartAoiLeaveConfig[/channelId]
MethodPOST or GET
ProductsIPC
Channel IDOptional (default 1)

Response​

Both endpoints return configuration in the same XML format as other smart detection commands, with detection zone polygon coordinates and object filter settings. The structure follows the standard <config> wrapper.

Notes​

  • Region entry and exit are configured independently — you can enable one without the other.
  • These commands complement tripwire (line crossing) detection. Tripwire detects crossing a line; AOI entry/exit detects entering or leaving a polygon region.
  • The corresponding Set commands are SetSmartAoiEntryConfig and SetSmartAoiLeaveConfig using the same XML structure returned by the Get commands.
  • AOI entry webhook events use smartType value AOI_ENTRY (IPC) or regionEntrance (NVR). AOI exit events use AOI_LEAVE (IPC) or regionExiting (NVR).
  • Query these endpoints against your camera to see the full XML response structure for your firmware version.
EndpointPurpose
GetSmartTripwireConfigLine crossing detection (complementary to region entry/exit)
GetSmartPerimeterConfigIntrusion zone detection
SetHttpPostConfigConfigure webhook destination