Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
          • detection.pet.enabled (Read pet detection switch)
          • detection.pet.enabled (Set pet detection switch)
          • detection.pet.sensitivity (Read pet sensitivity)
          • detection.pet.sensitivity (Set pet sensitivity)
          • detection.pet.plan (Read pet arming schedule)
          • detection.pet.plan (Set pet arming schedule)
          • detection.pet.frame (Read pet bounding box)
          • detection.pet.frame (Set pet bounding box)
          • detection.pet.tracking (Read pet tracking)
          • detection.pet.tracking (Set pet tracking)
          • detection.pet.detected (Pet detected)
        • PIR
        • License plate recognition
        • Vehicle guard
        • Siren
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

detection.pet.plan (Read pet arming schedule)

detection.pet.plan: Read pet arming schedule

detection.pet.plan · Channel scope · Permission Config

What it does

Reads pet arming schedule on this channel.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

Minimum permission

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.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesArrayyes["detection.pet.plan"]

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",
 "properties": [
 "detection.pet.plan"
 ]
 }
}

Response data fields

The value is in result.data.properties["detection.pet.plan"]。

NameDescriptionTypeRequiredValues
periodsTime periods. Used only when mode.model=3. At least one segment; each needs date (weekday 0–6), beginTime, endTime (THHmmss).arraynoup to 21 entries
periods.item.dateWeekday 0–6. Required on every segment.enumyes0 Sunday; 1 Monday; 2 Tuesday; 3 Wednesday; 4 Thursday; 5 Friday; 6 Saturday
periods.item.beginTimeStart time within the day, format THHmmss (e.g. T000000). Required on every segment.textyesFormat THHmmss, e.g. T235959
periods.item.endTimeEnd time within the day, format THHmmss (e.g. T235959). Required on every segment.textyesFormat THHmmss, e.g. T235959
modeSchedule mode: 0 all day / 1 daytime / 2 night / 3 custom. Include model when writing. When 3, also write periods (each with date, beginTime, endTime).structnocontains model, date
mode.modelMode enum. Required when writing mode. When 3, also write periods.enumyes0 all day; 1 daytime only; 2 night only; 3 custom
mode.dateDevice-side auxiliary time value (int 0–255), not weekday.intno0–255, step 1

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.pet.plan": {
 "mode": {
 "model": 0,
 "date": 127
 }
 }
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set pet arming schedule · Pet detection

detection.pet.sensitivity (Set pet sensitivity)
detection.pet.plan (Set pet arming schedule)