Query

Function

This API is used to push query push parameters.

Request Message

Parameter Description

Table 1
ParameterRangeTypeDescription
Tokenstring

Sample:

POST /API/Push/Query HTTP/1.1
{
    "data": {
        "Token": "f06214c1d9348dee11a513213c9a38d0b62c9ffd32d1c1b6f6485117d1f187b9",
        "app_support_ai_notification_subscribe":true
    }
}

Response Message

Parameter Description

Table 2
ParameterRangeTypeDescription
DefaultobjectDefault parameters, see Table 3 for details.
Filterobjectsubscription parameters, see Table 6 for details.
Notificationobjectsubscription parameters, see Table 8 for details.
Table 3
ParameterRangeTypeDescription
notification_interval_max30intMaximum notification interval.
notification_interval_min1intThe minimum notification interval.
notification_intervalnotification_interval_min-notification_interval_maxintNotification interval.
notification_interval_switchboolPush switch.
StorageError"True", "False"string
StorageFull"True", "False"string
StorageUnformatted"True", "False"string
StorageNull"True", "False"string
Motion"True", "False"string
IOAlarm"True", "False"string
PIRAlarm"True", "False"string
Intellect"True", "False"string
AiHuman"True", "False"string
AiVehicle"True", "False"string
VideoLoss"True", "False"string
AiFaceDetectionobjectSee Table 4 for details.
LPRobjectSee Table 4 for details.
LCD"True", "False"string
PID"True", "False"string
PD&VD(PD)"True", "False"string
FD"True", "False"string
AD"True", "False"string
CC"True", "False"string
CD"True", "False"string
QD"True", "False"string
RSD"True", "False"string
LPD"True", "False"string
SOD"True", "False"string
VT"True", "False"string
SD"True", "False"string
Intrusion"True"、"False"string
RegionEntrance"True"、"False"string
RegionExiting"True"、"False"string
Table 4
ParameterRangeTypeDescription
GrouparraySee Table 5 for details.
Table 5
ParameterRangeTypeDescription
Namestring
AutoSubscribe"True"、"False"string
Table 6
ParameterRangeTypeDescription
IntellectobjectSee Table 7 for details.
IOAlarmobjectSee Table 7 for details.
MotionobjectSee Table 7 for details.
PIRAlarmobjectSee Table 7 for details.
VideoLossobjectSee Table 7 for details.
StorageErrorobject
StorageFullobject
StorageNullobject
StorageUnformattedobject
LCDobjectSee Table 7 for details.
PIDobjectSee Table 7 for details.
PD&VD(PD)objectSee Table 7 for details.
FDobjectSee Table 7 for details.
ADobjectSee Table 7 for details.
CCobjectSee Table 7 for details.
CDobjectSee Table 7 for details.
QDobjectSee Table 7 for details.
RSDobjectSee Table 7 for details.
LPDobjectSee Table 7 for details.
SODobjectSee Table 7 for details.
VTobjectSee Table 7 for details.
SDobjectSee Table 7 for details.
AiHumanobjectSee Table 7 for details.
AiVehicleobjectSee Table 7 for details.
IntrusionobjectSee Table 7 for details.
RegionEntranceobjectSee Table 7 for details.
RegionExitingobjectSee Table 7 for details.
AiFaceDetectionobject arraySee Table 9 for details.
LPRobject arraySee Table 9 for details.
Table 7
ParameterRangeTypeDescription
Channel0~maximum number of channelsint array
Table 8
ParameterRangeTypeDescription
notification_intervalnotification_interval_min-notification_interval_maxintNotification of push.
notification_interval_switchboolNotification switch.
Table 9
ParameterRangeTypeDescription
NamestringGroup name
Channel0~Max Channel Numberint array

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "Default": {
            "notification_interval_max": 30,
            "notification_interval_min": 1,
            "notification_interval": 1,
            "notification_interval_switch": false,
            "StorageError": "True",
            "StorageFull": "True",
            "StorageUnformatted": "True",
            "StorageNull": "True",
            "Motion": "True",
            "IOAlarm": "True",
            "PIRAlarm": "True",
            "LCD": "True",
            "PID": "True",
            "PD&VD": "True",
            "FD": "True",
            "AD": "True",
            "CC": "True",
            "CD": "True",
            "QD": "True",
            "RSD": "True",
            "LPD": "True",
            "SOD": "True",
            "VT": "True",
            "SD": "True",
            "Intrusion": "true",
            "RegionEntrance": "true",
            "RegionExiting": "true",
            "AiFaceDetection": {
            "Group": [
                {
                "Name": "Allow List",
                "AutoSubscribe": "True"
                },
                {
                "Name": "Block List",
                "AutoSubscribe": "True"
                },
                {
                "Name": "Stranger",
                "AutoSubscribe": "True"
                }
            ]
            },
            "LPR": {
            "Group": [
                {
                "Name": "Allow List",
                "AutoSubscribe": "True"
                },
                {
                "Name": "Block List",
                "AutoSubscribe": "True"
                },
                {
                "Name": "Unknown",
                "AutoSubscribe": "True"
                }
            ]
            },
            "AiHuman": "True",
            "AiVehicle": "True",
            "VideoLoss": "True"
        },
        "Filter": {
            "AD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "AiFaceDetection": {
            "Group": [
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Allow List"
                },
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Block List"
                },
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Stranger"
                }
            ]
            },
            "AiHuman": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "AiVehicle": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "CC": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "CD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "FD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "Intrusion": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "IOAlarm": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "LCD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "LPD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "LPR": {
            "Group": [
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Allow List"
                },
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Block List"
                },
                {
                "Channel": [0,1,2,3,4,5,6,7,8],
                "Name": "Unknown"
                }
            ]
            },
            "Motion": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "PID": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "PIRAlarm": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "PD&VD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "QD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "RegionEntrance": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "RegionExiting": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "RSD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "SD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "SOD": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "StorageError": {},
            "StorageFull": {},
            "StorageNull": {},
            "StorageUnformatted": {},
            "VideoLoss": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            },
            "VT": {
            "Channel": [0,1,2,3,4,5,6,7,8]
            }
        },
        "Notification": {
            "notification_interval": 1,
            "notification_interval_switch": false
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.