Range

Function

This API is used to get parameter range for Channel > Channel Configuration > Broadcast IPC page.

Note:

The Range provides reference information for client UI input limits and API request limits. When sending Search and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.

Request Message

None.

Sample:

POST /API/ChannelConfig/RemoteDev/Range HTTP/1.1
{
    "version": "1.0",
    "data": {}
}

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…” WIFI_CH1x”
The number of channels depends on the capabilities of the device.
string arrayEach array bit represents a channel with a string.

Table 2

ParameterRangeTypeDescription
device_infoJSON ObjectChannel Information JSON show as follow Table 5

Table 3

ParameterRangeTypeDescription
operation_type"AddOrEditChannel",
"EditIPCParam",
"EditIPCPwd"
stringOperation Type: Add or modify channel parameters, edit connection IPC parameters, and edit connection IPC password.
remove_ipc“IP_CH1”…” IP_CH1x”
The number of channels depends on the capabilities of the device.
arrayEach array bit represents a channel with a string.
channel_infoJSON objectshow as follow Table 4

Table 4

ParameterRangeTypeDescription
CH1Json ObjectJSON show as follow Table 5
Json Object
IP_CH1Json Object
Json Object
WIFI_CH1Json Object
Json Object

Table 5

ParameterRangeTypeDescription
No1~1000000int
activesign0~2int
channel_numintNumber of channels supported by each device.
device_typeMax length: 35bytestringManufacturer
device_type_flagMax length: 32bytestringManufacturer flag, informing the third party IPC can broadcast protocol search, modify IP, but online still to ONVIF protocol online (only for NVR)
dns1Max length: 15bytestringPreferred DNS server, for example, 8.8.8.8.
dns2Max length: 15bytestringStandby DNS server, for example, 8.8.8.8.
fmuti_devidMax length: 1024bytestring
gatewayMax length: 15bytestringGateway
ip_addressMax length: 63bytestringIP address
ismodify_dhcpbool
ismodify_ipboolWhether the ip address is changed.
ismodify_portboolWhether the port address is changed.
ismodify_usernamebool
mac_addressMax length: 35bytestringMAC address
manufacturerMax length: 35bytestringDevice type
network_mode“Dhcp”,
”Static”
stringNetwork mode
old_ip_addressMax length: 63bytestringOld IP address
passwordMax length: 31bytestringPassword
password_emptyboolWhether the password is empty.
port[1~65535]intMedia port
protocolMax length: 15bytestringIPC access protocol
software_versionMax length: 40bytestringSoftware version
subnet_maskMax length: 15bytestringSubnet mask
usernameMax length: 31bytestring
version_flag[0~255]intVersion flag
web_port[1~65535]int

Tips:

The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
	"result": "success",
	"data": {
		"device_info": {
			"type": "array",
			"min_size": 0,
			"max_size": 500,
			"items": [
				{
					"network_mode": {
						"type": "string",
						"items": [
							"Dhcp",
							"Static"
						]
					},
					"ip_address": {
						"type": "string",
						"min_len": 7,
						"max_len": 63
					},
					"subnet_mask": {
						"type": "string",
						"min_len": 7,
						"max_len": 15
					},
					"gateway": {
						"type": "string",
						"min_len": 7,
						"max_len": 15
					},
					"dns1": {
						"type": "string",
						"min_len": 7,
						"max_len": 15
					},
					"dns2": {
						"type": "string",
						"min_len": 7,
						"max_len": 15
					},
					"port": {
						"type": "int32",
						"min": 1,
						"max": 65535
					},
					"web_port": {
						"type": "int32",
						"min": 1,
						"max": 65535
					},
					"channel_num": {
						"type": "int32",
						"mode": "r",
						"min": 1,
						"max": 256
					},
					"protocol": {
						"type": "string",
						"mode": "r",
						"items": [
							"Private",
							"Onvif",
							"RTSP",
							"Custom 1",
							"Custom 2",
							"Custom 3",
							"Custom 4",
							"Custom 5",
							"Custom 6",
							"Custom 7",
							"Custom 8",
							"Custom 9",
							"Custom 10",
							"Custom 11",
							"Custom 12",
							"Custom 13",
							"Custom 14",
							"Custom 15",
							"Custom 16"
						]
					},
					"username": {
						"type": "string",
						"mode": "w",
						"min_len": 0,
						"max_len": 31
					},
					"password": {
						"type": "string",
						"mode": "w",
						"min_len": 0,
						"max_len": 31
					},
					"manufacturer": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 35
					},
					"activesign": {
						"type": "int32",
						"mode": "r",
						"min": 0,
						"max": 2
					},
					"device_type": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 35
					},
					"device_type_flag": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 32
					},
					"mac_address": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 35
					},
					"software_version": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 40
					},
					"fmulti_devid": {
						"type": "string",
						"mode": "r",
						"min_len": 0,
						"max_len": 1024
					},
					"version_flag": {
						"type": "int32",
						"mode": "r",
						"min": 0,
						"max": 255
					},
					"old_ip_address": {
						"type": "string",
						"mode": "w",
						"min_len": 7,
						"max_len": 63
					},
					"ismodify_dhcp": {
						"type": "bool",
						"mode": "r"
					},
					"ismodify_ip": {
						"type": "bool",
						"mode": "r"
					},
					"ismodify_port": {
						"type": "bool",
						"mode": "r"
					},
					"ismodify_username": {
						"type": "bool",
						"mode": "r"
					},
					"password_empty": {
						"type": "bool"
					},
					"No": {
						"type": "int32",
						"min": 1,
						"max": 1000000
					}
				}
			]
		}
	}
}

Error Code

See Response Messages Body and Common error_code for more information.