VEverdun
camera-health

Notify Camera View Flags Site

ONE e-mail about several cameras at one site, one message per recipient, each camera's newest checked frame attached. Items must be in scope (404), at one site (400) and open or confirmed (409); open items are confirmed by the send, and only once at least one message was accepted. Same e-mail rules as /{flag_id}/notify (503 EMAIL_NOT_CONFIGURED, 502 when nothing was accepted). Activity-logged per item, with counts, never addresses.

post/camera-health/flags/notify-site

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/camera-health/flags/notify-site
  • Auth
    HTTP bearer

Request body

flag_idsstring[] required

The items this e-mail covers, 1-12, all at ONE site and each open or confirmed. Open items are confirmed by the send. Each camera's newest checked frame is attached, in this order.

recipientsstring[] required

Addresses to e-mail, 1-10 (one message each, no CC); syntax-checked only.

subjectstring required

E-mail subject, 1-200 characters.

bodystring required

Plain-text e-mail body, 1-5000 characters.

Example request

{
  "recipients": [
    "facilities@example.com"
  ],
  "subject": "3 cameras need attention at Harbor Yard"
}

Response

Successful Response

sentstring[] required

Recipients SES accepted.

rejectedstring[] required

Recipients SES rejected or could not confirm; do not assume these were delivered or undelivered.

Example response

{
  "flags": [
    {
      "status": "open",
      "camera_label": "Back of Building Driveway",
      "site_name": "Harbor Yard",
      "site_timezone": "America/Chicago",
      "parent_name": "Sentinel Integrations",
      "kind": "web_or_insect",
      "coverage_pct": 40,
      "opening_checks": [
        {
          "light": "night",
          "kind": "web_or_insect",
          "coverage_pct": 40
        }
      ],
      "raise_count": 3,
      "checks_obstructed": 3,
      "checks_total": 4,
      "checks": [
        {
          "light": "night",
          "kind": "web_or_insect",
          "coverage_pct": 40
        }
      ],
      "recent_alarms": [
        {
          "incident_type": "INTRUSION",
          "outcome_label": "False alarm - no human activity"
        }
      ],
      "notify_summary": "Emailed 2 recipients",
      "contacts": [
        {
          "name": "Dana Ruiz",
          "role": "Facilities manager",
          "email": "facilities@example.com"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.