# Range

## Function

This API is used to get Alarm > Pedestrian Detection configuration parameters range.

## Request Message

###### Table 1

Parameter | Range | Type | Description
--- | --- | --- | ---
channel | "CH1"…"CHx", "IP_CH1"…"IP_CHx", "WIFI_CH1"…"WIFI_CHx" The channels supported by the device. | string array | IPC can only Use "CH1".
page_type | "ChannelConfig", "AlarmConfig" | string | It is used to distinguish the data of channel configuration page or alarm configuration page

Sample:

    POST /API/AlarmConfig/Intelligent/PD/Range HTTP/1.1

    {
        "version": "1.0",
        "data": {"page_type": "AlarmConfig"}
    }

## Response Message

### Parameter Description

##### Table 2

Parameter | Range | Type | Description
--- | --- | --- | ---
channel_info |  | object | Total channel information see Table 3.
page_type | "ChannelConfig", "AlarmConfig" | string | It is used to distinguish the data of channel configuration page or alarm configuration page.
channel_max |  | int | The maximum number of channels.

##### Table 3

Parameter | Range | Type | Description
--- | --- | --- | ---
CH1 |  | object | See Table 4
… |  | object |
IP_CH1 |  | object |
… |  | object |
WIFI_CH1 |  | object |
… |  | object |

##### Table 4

Parameter | Range | Type | Description
--- | --- | --- | ---
status | "Offline","Online","Nonsupport" | string | Online status of the channel, only for digital channels. Note: When the channel is online, there is no such field.
alarm_out | "Local->1"…"Local->x" "IP_CH1->1"…"IP_CHx->x" The number of channels depends on the function of the device. | string array | alarm Output channel. Array members use a string to represent an alarm output channel. Local->1: open, empty value: close.
latch_time | "10","20","40","60" | string | Alarm output time, IPC: 5 10 20 30
record_enable | true, false | bool | Channel recording switch.
record_channel | "CH1"…"CHx" "IP_CH1"…"IP_CHx" "WIFI_CH1"…"WIFI_CHx" | string array | Channel of linkage recording.
post_recording | "30","60","120","300" | string | Recording delay time, IPC: 0 5 10 20 30.
send_email | true, false | bool | Send Email switch.
ftp_picture_upload | true, false | bool | Channel snapshot FTP upload switch (for NVR only).
ftp_video_upload | true, false | bool | Channel video FTP upload switch (for NVR only).
picture_to_cloud | true, false | bool | Picture upload switch (for NVR only).
video_to_cloud | true, false | bool | Video cloud upload switch (for NVR only).
full_screen |  | bool | FullScreen switch (for NVR only).
buzzer | "0","10","20","40","60" | string | Buzzer buzzing time (for NVR only).
show_message |  | bool | Show Message switch (for NVR only).
switch | true, false | bool | switch, false: close;true: open.
is_ai_param | true, false | bool | Distinguish between ordinary humanoid and intelligent humanoid models (only for NVR).
level | "Low", "Middle", "High" | string | Detection sensitivity.
sensitivity | 0-100 | int | Detection sensitivity.
snap_mode | "Default","RealTimeMode","IntervalMode" | string | "IntervalMode".
min_pixel | 64-1080 | int | minimum pixel value.
max_pixel | 320-1080 | int | maximum pixel value.
detection_type | "Pedestrian", "Vehicle", "Pedestrian & Vehicle" | string | Detection type, human and vehicle.
detection_mode | "StaticMode","MotionMode" | string | detection mode.
detection_range | "FullScreen","Customize" | string | detection range.
iva_lines | 0,1 | int | Whether there will be lines in preview and playback, 0 does not draw lines, 1 draws lines.
rule_info |  | object | See Table 5 for details.
voice_prompts_index | 0~4294967295 | int | File index (0~4294967295, 0 means None, that is, no audio file is selected). Each file is named as "index_filename" (1_i will try), on the page When displaying, "index_" should be hidden, such as "1_i will try", and only "i will try" will be displayed.
voice_prompts_select |  | int array | Play channel, counted by bit (bit0 is local, bit1 corresponds to front-end channel 1, bit2 corresponds to channel 2...).
voice_prompts_time |  | object array | Time period, there can be no time conflict among the 12 time periods, see Table 8.
copy_ch | "digit", "analog", "wifi", "local", "all" | string | Support channel copy flag (for NVR and DVR only).
voice_prompts_speaker_select |  | int array | Play ip speaker, counted by bit (bit0 is ip speaker 1, bit1 corresponds to front-end ip speaker 2...).

##### Table 5

Parameter | Range | Type | Description
--- | --- | --- | ---
rule_number1 |  | object | rule number 1, see Table 6.

##### Table 6

Parameter | Range | Type | Description
--- | --- | --- | ---
rule_switch |  | bool | rule switch.
rule_type | "Normal" | string | rule type.
rule_rect |  | object | Rectangle, see Table 7 for details.

##### Table 7

Parameter | Range | Type | Description
--- | --- | --- | ---
x1 | 0-704 | short | x1 coordinate point.
y1 | 0-576 | short | y1 coordinate point.
x2 | 0-704 | short | x2 coordinate point.
y2 | 0-576 | short | y2 coordinate point.
x3 | 0-704 | short | x3 coordinate point.
y3 | 0-576 | short | y3 coordinate point.
x4 | 0-704 | short | x4 coordinate point.
y4 | 0-576 | short | y4 coordinate point.

##### Table 8

Parameter | Range | Type | Description
--- | --- | --- | ---
start_hour | 0-23 | int |
start_minute | 0-59 | int |
start_second | 0-59 | int |
end_hour | 0-23 | int |
end_minute | 0-59 | int |
end_second | 0-59 | int |

Sample:

    HTTP/1.1 200 OK
    Content-Type: application/json

    {
        "result": "success",
        "data": {
            "channel_max": 16,
            "support_copy": true,
            "channel_info": {
                "type": "object",
                "items": {"CH2": {
                    "type": "object",
                    "items": {
                        "status": {
                            "description": "Only offline channel has this variable.",
                            "type": "string",
                            "mode": "r",
                            "items": [
                                "Offline",
                                "Online",
                                "Nonsupport"
                            ]
                        },
                        "buzzer": {
                            "type": "string",
                            "items": [
                                "0",
                                "10",
                                "20",
                                "40",
                                "60"
                            ]
                        },
                        "alarm_out": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 33,
                            "items": {
                                "type": "string",
                                "items": [
                                    "Local->1",
                                    "IP_CH1->1"
                                ]
                            }
                        },
                        "latch_time": {
                            "type": "string",
                            "items": [
                                "10",
                                "20",
                                "40",
                                "60"
                            ]
                        },
                        "record_enable": {"type": "bool"},
                        "record_channel": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 16,
                            "items": {
                                "type": "string",
                                "items": [
                                    "CH1",
                                    "CH2",
                                    "CH3",
                                    "CH4",
                                    "CH5",
                                    "CH6",
                                    "CH7",
                                    "CH8",
                                    "CH9",
                                    "CH10",
                                    "CH11",
                                    "CH12",
                                    "CH13",
                                    "CH14",
                                    "CH15",
                                    "CH16"
                                ]
                            }
                        },
                        "post_recording": {
                            "type": "string",
                            "items": [
                                "30",
                                "60",
                                "120",
                                "300"
                            ]
                        },
                        "show_message": {"type": "bool"},
                        "send_email": {"type": "bool"},
                        "full_screen": {"type": "bool"},
                        "ftp_picture_upload": {"type": "bool"},
                        "ftp_video_upload": {"type": "bool"},
                        "picture_to_cloud": {"type": "bool"},
                        "video_to_cloud": {"type": "bool"},
                        "copy_ch": {
                            "type": "string",
                            "items": [
                                "digit",
                                "analog",
                                "wifi",
                                "local",
                                "all"
                            ]
                        },
                        "voice_prompts_index": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 12,
                            "items": []
                        },
                        "voice_prompts_select": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 12,
                            "items": []
                        },
                        "voice_prompts_speaker_select": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 12,
                            "items": []
                        },
                        "voice_prompts_time": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 12,
                            "items": []
                        },
                        "http_listening": {"type": "bool"}
                    }
                }}
            }
        }
    }

## Error Code

See Response Messages Body and Common error_code for more information.