Grandstream HTTP API
Grandstream HTTP API
Contents
DOCUMENT OVERVIEW ......................................................................................................... - 3 -
Software Version Requirement ................................................................................................ - 3 -
URL Parameter Definitions...................................................................................................... - 4 -
Common URL Format ............................................................................................................. - 4 -
Responses from the Device ...................................................................................................... - 5 -
PARAMETERS ........................................................................................................................... - 6 -
1. Audio/Video Parameters .................................................................................................. - 6 -
2. OSD Settings ................................................................................................................... - 8 -
3. Network Parameters ........................................................................................................ - 9 -
4. Dynamic DNS (DDNS) ................................................................................................. - 10 -
5. SIP ................................................................................................................................. - 10 -
6. Date & Time .................................................................................................................. - 12 -
7. Status ............................................................................................................................. - 15 -
8. Account Management .................................................................................................... - 16 -
9. SMTP (E-mail) Settings ................................................................................................ - 17 -
10.
FTP Settings .............................................................................................................. - 17 -
11.
PTZ Settings .............................................................................................................. - 18 -
12.
Alarm Event .............................................................................................................. - 19 -
13.
Motion Detection....................................................................................................... - 22 -
14.
System Log ................................................................................................................ - 26 -
15.
USB/SD Storage ........................................................................................................ - 26 -
16.
Maintenance/Upgrade ............................................................................................... - 27 -
17.
Contrast, Saturation, Brightness and Chroma ........................................................... - 28 -
18.
WIFI Settings ............................................................................................................ - 30 -
19.
System Settings ......................................................................................................... - 30 -
20.
PPPoE Settings .......................................................................................................... - 32 -
21.
Snapshot .................................................................................................................... - 32 -
22.
Web GUI Language ................................................................................................... - 33 -
23.
Decode Settings (For GXV3500 only) ...................................................................... - 33 -
24.
Stream Acquiring....................................................................................................... - 34 -
25.
CMOS Settings .......................................................................................................... - 34 -
26.
4*D1 Settings (For GXV3504 only) ......................................................................... - 35 -
27.
Alarm HTTP Servers Settings ................................................................................... - 36 -
28.
Record Settings ......................................................................................................... - 37 -
-2-
DOCUMENT OVERVIEW
Grandstream Video Surveillance API (Application Programming Interface) supports HTTP
1.0 protocol (RFC1945). This document explains in detail the parameter of functions in
client side, via the supported GET/POST method. Users will require administrator
privilege to retrieve or set the parameters.
-3-
Values
Description
cmd=<string>
add/remove/set/get
/search/reg
channel=<int>
0, 1, 2, 3
channel=0\r\n
<param>=<value>\r\n
channel=1\r\n
<param>=<value>\r\n
channel=2\r\n
<param>=<value>\r\n
channel=3\r\n
<param>=<value>\r\n
channel=0\r\n
.
md.regn.index=0\r\n
<param>=<value>\r\n
md.regn.index=1\r\n
<param>=<value>\r\n
md.regn.index=2\r\n
<param>=<value>\r\n
e.g.:
16 motion detection regions in channel 0
-4-
md.regn.index=3\r\n
<param>=<value>\r\n
md.regn.schedule.count=3\r\n
md.regn.schedule.id=1
md.regn.index=0
md.regn.schedule.dayset=7
md.regn.schedule.starttime=0
md.regn.schedule.endtime=86399
md.regn.schedule.id=2
md.regn.index=0
md.regn.schedule.dayset=1
md.regn.schedule.starttime=0
md.regn.schedule.endtime=4879
md.regn.schedule.id=3
md.regn.index=1
md.regn.schedule.dayset=7
md.regn.schedule.starttime=0
md.regn.schedule.endtime=86399
.
HTTP Text
Description
200
OK
Request successful.
It does not mean set/delete/add successful until
receiving Successful\r\n.
Successful Need Reboot\r\n: configure successful but it
would take effect after reboot.
No Privilege\r\n: incorrect privilege.
<param> Invalid\r\n: invalid parameter.
<param> Missing\r\n: missing parameter.
400
Bad Request
401
Unauthorized
Authorization failed.
404
Not Found
503
Service
Unavailable
Example:
Request includes invalid file names.
HTTP/1.0 404 Not Found\r\n
-5-
PARAMETERS
1. Audio/Video Parameters
Support method:
cmd = set/get
If devices support 2 streams, they are called primary stream and secondary stream, e.g.:
http://<servername>/goform/audio_video?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
channel=<int>
0, 1, 2, 3
video.primary.encoder=<int>
video.secondary.encoder=<int>
96, 26
Video codec:
96: H264
26: MJPEG (not supported by
some models)
This parameter needs to be set
along with the parameter of
bitrate.
video.primary.resolution=<int>
video.secondary.resolution=<int>
width(2 bytes)|
height(2 bytes)
First 2 bytes for
width of pixels;
Last 2 bytes for
height of pixels.
Video resolution.
Varies among different device
models and the NTSC/PAL
format used.
video.primary.bitrate=<int>
video.secondary.bitrate=<int>
video.primary.brtype=<int>
video.secondary.brtype=<int>
0, 1
0: VBR(Variable bitrate)
1: CBR(Constant bitrate)
video.primary.framerate=<int>
video.secondary.framerate=<int>
1-30
Frame rate.
Varies among different device
models and NTSC/PAL format.
video.primary.iframe=<int>
video.secondary.iframe=<int>
1-100
I frame interval.
video.primary.imagequality=<int>
video.secondary.imagequality=<int>
1-5
Image quality:
Level 1-5.
The lower the value the greater
the image quality (only valid
with VBR configuration)
audio.primary.encoder=<int>
audio.secondary.encoder=<int>
0, 1, 2, 3, 4
Audio codec.
0: pcmu
1: pcma
2: g726 (valid only for
-6-
GXV3601/350x/3611LL/3611H
D/3615/3615W)
3. disabled
4. AAC (valid only for
GXV3651FHD/3662HD/3615W
P_HD/3500)
Some device models may only
support audio.primary.encoder
(share "audio.primary.encoder")
audio.primary.bitrate=<int>
audio.secondary.bitrate=<int>
16, 32
Audio bitrate.
Some device models may only
support audio.primary.encoder
(share audio.primary.encoder")
audio.linein=<int>
0, 1
Audio input
audio.lineout=<int>
0, 1
Audio output
audio.microphone.volume=<int>
(1-10)
Valid for:
GXV3601/3601
LL/3601HD/361
1LL/3611HD/35
01/3504/3615/3
615W
(1-5)
Valid for
GXV3651FHD/
3662HD/3615
WP_HD/3500
audio.speaker.volume=<int>
(1-10)
Valid for:
GXV3601/3601
LL/3601HD/361
1LL/3611HD/35
01/3504/3615/3
615W
(0-31)
Valid for
GXV3651FHD/
3662HD/3615
WP_HD/3500
audio.chip.type=<int>
0, 1, 0xFF
1: AIC3104
0xFF: None
ntscpal.type=<int>
0, 1
Video format
(Read Only, not savable)
0:PAL
1:NTSC
power.frequency=<int>
50, 60, 61
Power frequency.
Indoor 50: 50
Indoor 60: 60
Outdoor: 61
(For GXV3651_FHD/3662_HD
only, not for other models)
Example:
Set Audio/Video parameters.
http://192.168.86.6/goform/audio_video?cmd=set&channel=0&video.primary.encoder=96
200 OK\r\n
Successful\r\n
2. OSD Settings
Support method: cmd = set/get
http://<servername>/goform/osd?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
channel=<int>
0, 1, 2, 3
osdposition=<int>
0, 1
osdtimeshow=<int>
0, 1
osdtextshow=<int>
0, 1
OSD text:
0: Not display
1: Display
osdopacity=<int>
0, 10, 20100.
osdcolor =<string>
(GXV3601/3601L
L/3601HD/3611L
OSD color
0xFFFFFE: Auto
-8-
L/3611HD/3501/3
504/3615/3615W
Only)
osdtext=<string>
osdtextindex=<int>
0xFFFFFF: White
0xFF0000: Red
0x800080: Purple
0xFF6100: Orange
0x0000FF: Blue
0xFFFF00: Yellow
0x008000: Green
0x00FFFF: Cyan
0x000000: Black
OSD; maximum 63 bytes.
0, 1, 2
Example:
http://192.168.86.6/goform/osd?cmd=set&osdposition=1&osdtimeshow=0&osdtextshow=
0&osdopacity=20&osdcolor =0xFFFFFE&osdtext=12345
200 OK\r\n
Successful\r\n
3. Network Parameters
Support cmd = set/get,
http://<servername>/goform/network?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
httpport=<int>
Description
HTTP port
enabledhcp=<int>
0, 1
DHCP.
0: disable
1: enable
ipaddress=<string>
192.168.1.123
IP Address.
Not valid when starting DHCP.
subnetmask=<string>
255.255.255.0
Subnet mask
defaultgateway=<string>
192.168.1.1
Default gateway
autodns=<int>
0, 1
dnsserver.primary=<string>
dnsserver.standby=<string>
Example
-9-
http://192.168.86.6/goform/network?cmd=set&channel=0&autodns=1&ipadress=192.168.
86.145
200 OK\r\n
Successful Need Reboot\r\n
cmd = set/get
http://<servername>/goform/ddns?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
enableddns=<int>
0, 1
DDNS
0: disable
1: enable
isptype=<int>
0-6
ISP type
0: dyndns.org
1: noip.com
2: ActiveDNS
3: cn99.com
4: ipkan.net
5: ipkan.cn
6: ipkan.com.cn
sitename=<string>
ddnsip=<string>
account=<string>
password=<string>
stunserver=<string>
Example:
http://192.168.86.6/goform/ddns?cmd=set&enableddns=1
200 OK\r\n
Successful\r\n
5. SIP
Support cmd = set/get, it will take effect on next reboot.
http://<servername>/goform/sip?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
registeredstate=<int>
0, 1
Registration state.
0: Offline
- 10 -
1: Online
unregister=<int>
0, 1
Unregister on reboot.
0: No
1: Yes
accountname=<string>
sipserver=<string>
proxyserver=<string>
userid=<string>
authenticateid=<string>
Authenticate ID.
Could be the same or different as SIP UserID,
max 127 Bytes.
accountpassword=<string>
stunserver=<string>
sipstream=<int>
0, 1
0: Secondary
1: Primary
audioencoder=<int>
0, 1
0: PCMU
1: PCMA
Default is 0, PCMU.
regexpiration=<int>
localsipport=<int>
localrtpport=<int>
1024-30000
autohooktimer=<int>
0-65535
disable_audio=<int>
0, 1
0: No
1: Yes
enable_keep_alive=<int>
0, 1
0: No
1: Yes
direct_ip_call=<int>
0, 1
0: No
1: Yes
enable_white_list=<int>
0, 1
0: No
1: Yes
sipdoorenable=<int>
0, 1
sipdoorpwd=<string>
Number
0 to 9
sipdoortime=<int>
Phonebook settings. Support
<parameter>=<value>
Values
phone.count=<int>
Description
Total phonebook entries.
phone.index=<int>
1, 2.
phone.number=<string>
phone.name=<string>
white_list_phone=<string>
audio_warning_mode=<int>
0, 1
Example (URL)
http://192.168.89.19/goform/sip?cmd=set&unregister=1&accountname=xkowen&sipserve
r=192.168.89.207&userid=3028&authenticateid=3028&accountpassword=123456
http://192.168.89.19/goform/sip?cmd=add& white_list_phone=2222
http://192.168.89.19/goform/sip?cmd=remove& white_list_phone=2222,3333,4444,
Delete phone
numbers in white list
cmd = set/get
http://<servername>/goform/date_time?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
updatemode=<int>
1-2
Update mode.
1: Update via NTP time server (Default)
2: Self-defined
year=<int>
Current year
month=<int>
1-12
Current month
day=<int>
0-31
Current day
hour=<int>
0-23
Current hour
minute=<int>
0-59
Current minute
- 12 -
second=<int>
0-59
Current second
timezone=<int>
1-54
1: GMT-12 (Eniwetok,Kwajalein)
2: GMT-11 (Midway Isl., Samoa)
3: GMT-10 (Hawaii, AleutianIsl.)
4: GMT-09 (Alaska)
5: GMT-08 (LasVegas,SanFran cisco,
Vancouver)
6: GMT-07 (Calgary, Denver, Salt Lake
City)
7: GMT-06 (Chicago, Dallas, Mexico City)
8: GMT-05 (Cuba)
9: GMT-05 (New York, Toronto,
Washington DC)
10: GMT-04 (Paraguay)
11: GMT-04 (Chile)
12: GMT-04 (Charlottetown, Manaus)
13: GMT-03 (Brazilia, Sao Paulo)
14: GMT-02 (Noronha, Mid-Atlantic)
15: GMT-01(Azores, Cap Verde Isl.)
16: GMT (Dublin, Lisbon, London,
Reykjavik)
17: GMT+01 (Amsterdam, Berlin, Rome,
Stockholm)
18: GMT+02 (Athens, Helsinki, Istanbul,
Riga)
19: GMT+02 (Egypt)
20: GMT+02 (Israel)
21: GMT+02 (Lebanon)
22: GMT+02 (Syria)
23: GMT+03 (Moscow, Riyadh)
24: GMT+03 (Iraq)
25: GMT+03:30 (Iran)
26: GMT+04 (Abu Dubai, Baku)
27: GMT+04:30 (Kabul)
28: GMT+05 (Islamabad, Karachi,
Tashkent)
29: GMT+05:30 (Bombay, Calcutta, New
Delhi)
30: GMT+06 (Novosibirsk, Omsk)
31: GMT+07 (Bangkok, Hanoi, Jakarta)
32: GMT+08 (Beijing, Hong Kong,
Shanghai, Taipei, Taiwan)
33: GMT+09 (Osaka, Sapporo, Tokyo)
34: GMT+09:30 (Adelaide, Darwin)
- 13 -
ntpserverenable=<int>
0, 1
0: No
1: Yes
ntpserver=<string>
datestyle=<int>
7. Status
Support
cmd = get/set
http://<servername>/goform/systeminfo?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
productmode=<string>
GXV3501,
GXV3504,
GXV3601,
GXV3601HD/LL,
GXV3611HD/LL,
GXV3615W/P,
GXV3651FHD,
GXV3662HD,
GXV3615WP_HD
GXV3500
hardwareversion=<string>
V0.2B...
Hardware version
partnumber=<string>
P/N number
bootloaderversion=<string>
BOOTLOADER version
coreversion=<string>
Core version
baseversion=<string>
Base version
firmwareversion=<string>
0-59
Firmware version
0, 1, 2, 3, 4, 5, 6
DDNS Status
0 :Disable
cameratype=<string>
ddnsstate=<int>
- 15 -
1 :Processing
2 :Success
3 :Account/Password Error
4 :Server blocking
5 :Stun Server error
6 :Database failed
wifistate=<int>
0, 1
Wi-Fi Status
0: Disconnected
1: Connected
systemrun=<string>
System up time
mac=<string>
MAC Address
ledstatus=<int>
0, 1
pppoe.ip
pppoe.status
0, 1
PPPoE status
0: disconnected
1: connected
ipaddress
subnetmask
defaultgateway
8. Account Management
Support cmd = add/remove/set/get
http://<servername>/goform/usermanage?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
user.count=<int>
>=1
user.index=<int>
1, 2
Index of users
user.level=<int>
0, 1, 2
User Privilege.
0: administrator
1: user
2: anonymous
user.name=<string>
user.password=<string>
anonymous.enable =<int>
0, 1
Example:
http://192.168.89.43/goform/usermanage?cmd=remove&user.name=name
- 16 -
200 OK\r\n
Successful\r\n
cmd = set/get
http://<servername>/goform/smtp?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
enablesmtp=<int>
0, 1
Enable SMTP:
0: No
1: Yes
smtpserver=<string>
smtpserverport=<int>
emailfrom=<string>
emailuser=<string>
emailpassword=<string>
emailto1=<string>
emailto2=<string>
emailto3=<string>
enablessl=<int>
0, 1
Use SSL.
0: No
1: Yes
smtptest=<int>
Example:
Set SMTP parameters. When enablesmtp=1, the Email address format will be checked.
http://192.168.86.66/goform/smtp?cmd=set&enablesmtp=0
(when enablesmtp=1, basic check will be performed to all the addresses)
200 OK\r\n
Successful\r\n
cmd = set/get
- 17 -
http://<servername>/goform/ftp?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
enableftp=<int>
0, 1
Enable FTP.
0: No
1: Yes
ftpserver=<string>
ftpserverport=<int>
ftpuser=<string>
ftppassword=<string>
ftppath=<string>
ftptest=<int>
Example:
Set FTP parameters.
http://192.168.86.6/goform/ftp?cmd=set&ftpserver=123456&ftpserverport=111&ftpuser=a
dmin&ftppath=admin
200 OK\r\n
Successful\r\n
cmd = set/get
http://<servername>/goform/ptz?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
protocol=<int>
0, 1
channel=<int>
0-3
(pending)
baudrate=<int>
Baud rate.
May vary among different
device models.
- 18 -
ptzparam=<int>
0-63 (Speed)
0-127 (Default position)
ptzcontrol=<int>
0, 1
PTZ Control.
0: Stop
1: Tilt Up
2: Tilt Down
3: Pan Left
4: Pan Rigjt
5: Pan to upper left corner
6: Pan to lower left corner
7: Pan to upper right corner
8: Pan to lower right corner
9: Zoom in
10: Zoom out
11: Focus near
12: Focus far
13: IRIS open
14: IRIS close
15: Turn to default position
16: Clear default position
17: Set default position
18: Auto Pan
19: Stop Auto Pan
Example:
Set PTZ parameter.
http://192.168.86.66/goform/ptz?cmd=set&ptzcontrol=4&ptzparam=31
(rotation and speed have to be used together)
200 OK\r\n
Successful\r\n
Note: ptzcontrol and ptzparam would both need to be included in the link
cmd = set/get/add/remove
http://<servername>/goform/alarmio?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
alarmin.count=<int>
0, 1, 4
0, 1, 2, 3
alarmin.schedule.count=<int>
0, 1
Numbers of schedules
alarmin.schedule.id=<int>
1, 2, 3
ID of schedules
alarmin.schedule.dayset=<int>
0-7
0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
7: Everyday(default)
alarmin.schedule.starttime=<int>
0-86399
alarmin.schedule.endtime=<int>
0-86399
alarmout.stop=<string>
yes
event.record.pretime=<int>
0-160
(video.primary.bitrate<256)
0-100
(video.primary.bitrate<512)
0-50
(video.primary.bitrate<1024)
0-25
(video.primary.bitrate>1024)
event.record.aftertime=<int>
0-320
(video.primary.bitrate<256)
0-200
(video.primary.bitrate<512)
0-100
(video.primary.bitrate<1024)
0-50
(video.primary.bitrate>1024)
Record Video to
Post-Alarm (in seconds).
The range varies among
different bitrate.
event.record.storage=<int>
1, 2
0, 1
event.sipphone.enable=<int>
0, 1
event.alarmout.enable=<int>
0, 1
Enable/Disable alarm
output.
0: disable.
1: enable.
alarm in 1 corresponds
alarm out 1;
alarm in 2 corresponds
alarm out 2;
event.uploadcenter.enable=<int>
0, 1
event.shotemail.enable=<int>
0, 1
Example:
Parameter settings.
http://192.168.86.6/goform/alarmio?cmd=add&alarmin.index=0&event.record.pretime=20
&event.record.aftertime=10&event.record.storage=1&event.record.uploadftp=1&event.sip
phone.enable=1&event.alarmout.enable=1&event.uploadcenter.enable=1&event.shotem
ail.enable=1
- 21 -
cmd = add/remove/set/get
http://<servername>/goform/motiondetect?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
md.channel.count=<int>
1, 4
md.channel.index=<int>
0, 1, 2, 3
md.active.enable=<int>
0, 1
Enable Motion
Detection
0: No
- 22 -
1: Yes
md.regn.index=<int>
0-15
Motion Detection
Region 0-15
md.regn.leftup=<int>
md.regn.rightdown=<int>
md.regn.sensitivity=<int>
0-100
Sensitivity.
The higher the value the
greater the sensitivity
md.regn.schedule.count=<int>
0, 1
Total number of
schedule.
md.regn.schedule.id=<int>
0, 1, 2, 3
Schedule ID (1-n).
If ID is set to 0, all the
schedules will be
deleted.
md.regn.schedule.dayset=<int>
0-7
0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
7: Everyday(default)
md.regn.schedule.starttime=<int>
0-86399
Default is 0 (in
seconds).
Example: 12:39,
starttime =
12*3600+39*60
md.regn.schedule.endtime=<int>
0-86399
md.record.storage=<int>
0, 1, 2, 3
0-160
(video.primary.bitrate<256)
0-100
(video.primary.bitrate<512)
0-50
(video.primary.bitrate<1024)
0-25
(video.primary.bitrate>1024)
md.record.aftertime=<int>
0-320
(video.primary.bitrate<256)
0-200
(video.primary.bitrate<512)
0-100
(video.primary.bitrate<1024)
0-50
(video.primary.bitrate>1024)
Record Video to
Post-Alarm (in
seconds). This may
vary among different
bitrates.
md.record.uploadftp=<int>
0, 1
md.sipphone.enable=<int>
0, 1
md.alarmout.enable=<int>
0, 1
Enable/Disable alarm
output.
0: enable.
1: disable.
alarm in 1 corresponds
alarm out 1;
alarm in 2 corresponds
alarm out 2;
md.uploadcenter.enable=<int>
0, 1
md.snapshot.enable=<int>
0, 1
Note
http://192.168.86.6/goform/motiondetect?cmd=set&md.active.enable=2
http://192.168.86.6/goform/motiondetect?cmd=set&md.regn.index=0&md.regn.leftup=1&
md.regn.rightdown=26214800&md.regn.sensitivity=1
http://192.168.86.6/goform/motiondetect?cmd=set&md.regn.index=0&md.regn.leftup=1&
md.regn.rightdown=26214800&md.regn.sensitivity=101
http://192.168.86.6/goform/motiondetect?cmd=set&record.storage=0
http://192.168.86.6/goform/motiondetect?cmd=set&md.record.storage=2&md.record.afterti
me=30&md.record.pretime=10&md.record.uploadftp=0&md.sipphone.enable=0&md.alar
mout.enable=0&md.uploadcenter.enable=0&md.snapshot.enable=0
http://192.168.86.6/goform/motiondetect?cmd=set&md.record.storage=1&md.record.afterti
me=10&md.record.pretime=20&md.record.uploadftp=1&md.sipphone.enable=1&md.alar
mout.enable=1&md.uploadcenter.enable=1&md.snapshot.enable=1
http://192.168.86.6/goform/motiondetect?cmd=remove&md.regn.schedule.id=1,2,3,...
http://192.168.86.6/goform/motiondetect?cmd=add
http://192.168.86.6/goform/motiondetect?cmd=add&md.regn.index=1
http://192.168.86.6/goform/motiondetect?cmd=add&md.regn.index=1
http://192.168.86.6/goform/motiondetect?cmd=add&md.regn.index=1&md.channel.index=
2
192.168.86.6/goform/motiondetect?cmd=set&md.regn.index=0&md.regn.leftup=0&md.reg
Delete Alarm
n.rightdown=0&md.regn.sensitivity=1
Region
- 25 -
cmd = set/get
http://<servername>/goform/systemlog?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
logserver=<string>
loglevel=<int>
Description
Syslog server, max 127
Bytes
0, 1, 2, 3, 45
Syslog level:
0: NONE
1: DEBUG
2: INFO
3: WARNING
4: ERROR
Example
http://192.168.86.6/goform/systemlog?cmd=set&loglevel=1&logserver=12345464
200 OK\r\n
Successful Need Reboot\r\n
Example (URL)
Note
http://192.168.86.6/goform/systemlog?cmd=get
http://192.168.86.6/goform/systemlog?cmd=set&loglevel=1&logserver=12345464
http://192.168.86.6/goform/systemlog?cmd=set&loglevel=6&logserver=12345464
cmd = remove/get/format
http://<servername>/goform/storage?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
storage.count=<int>
storage.index=<int>
1, 101, 201
1: USB
101: SD
201: DISK
storage.capacity=<string>
storage.usedspace=<stri
ng>
- 26 -
storage.freespace=<strin
g>
file.count=<int>
file.index=<int>
1, 2, 3
File index
file.size=<string>
file.name=<string>
storage_type=<int>
1, 2, 3
Example:
Delete a file from USB/SD card.
http://192.168.86.95/goform/storage?cmd=remove&file.name=/mnt/sd/192.168.86.95_ch
n1_2010_01_13_09_21_58.jpg
200 OK\r\n
Successful\r\n
16. Maintenance/Upgrade
Support cmd = set/get
http://<servername>/goform/maintenance?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
restart=<string>
yes
restore=<string>
yes
update.viatype=<int>
1, 2, 3
Upgrade via:
1: TFTP
2: HTTP
3: HTTPS
- 27 -
upgrade.serverpath=<string>
serverhost:port/dir
upgrade.cfgserverpath=<string>
serverhost:port/dir
Configuration server
path, max 255 Bytes
upgrade_cfg_xml_pwd=<string>
upgrade.automatic=<int>
0, 1
Automatic upgrade:
0: No
1: Yes
upgrade.interval=<int>
60-525600
Automatic upgrade
interval (in minutes)
Example:
Set maintenance and upgrading parameters.
http://192.168.86.6/goform/maintenance?cmd=set&upgrade.serverpath=192.168.86.1
200 OK\r\n
Successful\r\n
Values
Description
channel=<int>
0, 1, 2, 3
Assigned channel
number. Default number
for IP Camera is 0
brightness=<int>
For
GXV3501/3504/3600/3601/3612,
(0-255)
Brightness
For
GXV3601LL/3611LL/3615/3615W
, (0-60)
For GXV3601HD/3611HD, (0-5)
For
GXV3651HD/3651FHD/3662HD/
3500/ip1200/ip5150, (0-255)
- 28 -
contrast=<int>
For
GXV3501/3504/3600/3601/3612,
(0-255)
Contrast
For
GXV3601LL/3611LL/3615/3615W
, (0-7)
For GXV3601HD/3611HD, (0-3)
For
GXV3651HD/3651FHD/3662HD/3
500/ip1200/ip5150, (0-255)
saturation=<int>
For
GXV3501/3504/3600/3601/3612,
(0-255)
Saturation
For
GXV3601LL/3611LL/3615/3615W
, (0-63)
For GXV3601HD/3611HD, (0-8)
For
GXV3651HD/3651FHD/3662HD/3
500/ip1200/ip5150, (0-255)
chroma=<int>
0-255
Default=<int>
3, 4
Example:
http://192.168.86.6/goform/videocontrol?cmd=set&contrast=101
200 OK\r\n
Successful\r\n
- 29 -
Values
Description
wifiexist=<int>
0, 1
enable=<int>
0, 1
0: Disable
1: Enable
ssid=<string>
SSID
authentication=<int>
0-6
Security Mode
0:NONE
1:WEP/Shared
2:WEP/Open
3:WPA PSK TKIP
4:WPA PSK AES
5:WPA2 PSK TKIP
6:WPA2 PSK AES
keyindex=<int>
1-4
Key index
key=<string>
Encryption Key
Example:
Values
devicename=<string>
Description
Device name
channel=<int>
0-3
Channel number
alarmin.type=<int>
0,1
0:Normal Open
1:Normal Close
- 30 -
alarmout.type=<int>
0,1
0:Normal Open
1:Normal Close
alarmin.status=<int>
0,1
alarmout.status=<int>
0,1
alarm_output_time=<int>
0, 5,15,
30, 60,
180, 300,
600,
900,1800
gpio_pin_multiplex=<int>
0, 1
Example 1:
Example 2:
Alarm Type
Alarm Status
Result
alarmout.type=NORMAL
OPEN
alarmout.status=OPEN
alarmout.type=NORMAL
OPEN
alarmout.status=CLOSE
alarmout.type=NORMAL
CLOSE
alarmout.status=OPEN
alarmout.type=NORMAL
CLOSE
alarmout.status=CLOSE
alarmin.type=NORMAL
OPEN
alarmin.status=OPEN
alarmin.type=NORMAL
OPEN
alarmin.status=CLOSE
alarmin.type=NORMAL
alarmin.status=OPEN
- 31 -
CLOSE
alarmin.type=NORMAL
CLOSE
alarmin.status=CLOSE
cmd = set/get
http://<servername>/goform/pppoe?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
pppoe.user=<string>
PPPoE username
password=<string>
PPPoE password
(Not show when using get)
pppoe.status=<int>
0, 1
Example:
21. Snapshot
http://<servername>/snapshot/view0.jpg
<parameter>=<value>
view0.jpg
view2.jpg
view4.jpg
view6.jpg
Values
view1.jpg
view3.jpg
view5.jpg
view7.jpg
Description
Capture view0.jpg in single channel.
Capture view0.jpg view7.jpg in 4 channels.
Example:
Capture a snapshot.
http://<servername>/snapshot/view0.jpg
- 32 -
Values
Description
language=<int>
0, 1, 2
0: English (default)
1: Chinese
2: Russian
Example:
http://<servername>/goform/language?cmd=set?language=1
Values
Description
decode_source=<int>
0, 1
Decode source.
0:RTSP
1:SIPphone
default_decode=<int>
0-7
enable_patrol=<int>
0, 1
Enable patrol
0:Disable
1:Enable
video_ouput_type
0-3
0:Auto or NTSC
1:Auto or PAL
2:NTSC
3:PAL
start_patrol=<int>
0, 1
Start patrol
0: Stop patrol
1: Start patrol
channel[i]=<int>
0-4
Video channel
Use i=0-7 to specify the 8
patrol decode devices
port[i]=<int>
Port i=0-7
time[i]=<int>
i=0-7
host[i]=<string>
i=0-7
user[i]=<string>
i=0-7
password[i]=<string>
i=0-7
description[i]=<string>
i=0-7
- 33 -
Example:
http://<servername>/goform/decode?cmd=set?channel=1
Values
Description
channel=<int>
0-7
Example:
http://192.168.86.25/goform/stream?cmd=get&channel=0
Values
Description
flip=<int>
0, 1
0:off
1:on
lris=<int>
0, 1, 2
IRIS setting.
0: Mech_Manual
1: DC_Auto
2: DC_Manual
iris_open=<int>
1, 2, 3, 4, 5
up_bias=<int>
6000-11000
down_bias=<int>
6000-11000
- 34 -
shutter_speed=<int>
Shutter speed
0:Auto
N:1/N
ir_cut_setting=<int>
0, 1
IR CUT setting
0: Manual_Mode
1: Automatic_Mode
ir_cut_sensitivity=<int>
1, 2, 3, 4, 5
IR_CUT sensitivity
d_n_mod=<int>
0, 1
Day/Night mode.
0: day
1: night
color_mod=<int>
0, 1, 2
Color mode.
0: color
1: black-white
2: auto
Example:
Set CMOS parameters.
http://192.168.86.6/goform/cmos?cmd=set&lris =1
200 OK\r\n
Successful \r\n
Example (URL)
Note
http://192.168.86.6/goform/ cmos?cmd=get
http://192.168.86.6/goform/cmos?cmd=set&lris=1&shutter_speed =30
Values
Description
enable=<int>
0, 1
0: No
1: Yes
ntscpal.type=<int>
0, 1
0: PAL
1: NTSC
Read only. To identity type
for display.
Options=<int>
1-8
H264
1:4*704*480,
2048kbps@15fps+no
secondary stream
2:4*704*480,
- 35 -
1536kbps@19fps+no
secondary stream
3:4*704*480,
1536kbps@15fps+secondary
stream 4*QCIF (176*112)
128kbps@10fps
4:4*704*576,
2048kbps@13fps+no
secondary stream
5:4*704*576,
1536kbps@16fps+no
secondary stream
6:4*704*576,
1536kbps@10fps+secondary
stream 4*QCIF (176*144)
128kbps@10fps
MJPEG
7:4*704*480,
4096kbps@15fps+no
secondary stream
8:4*704*576,
4096kbps@13fps+no
secondary stream
Example:
http://192.168.86.25/goform/fourdone?cmd=get
cmd=set/get
http://<servername>/goform/event_server?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
server_name=<string>
Server name
server_url=<string>
Server URL
- 36 -
server_username=<string >
Username
server_user_password=<string >
Password
Example:
Set Alarm HTTP Servers parameters.
http://192.168.86.6/goform/event_server?cmd=set&server_name=servername&server_ur
l=http://
200 OK\r\n
Successful \r\n
Example (URL)
Note
http://192.168.86.6/goform/ event_server?cmd=get
http://192.168.86.6/goform/event_server?cmd=set&server_name=servername&server_url=ser
verurl&server_username=username&server_user_password=pwd
cmd = set/get
http://<servername>/goform/sdrecord?cmd=<value>&<parameter>=<value>...
<parameter>=<value>
Values
Description
channel=<int>
0-3
Channel number.
(For single channel device, this could be
skipped)
state_record=<int>
0-4
0: No record
1: Manual record
2: Auto record
3: Alarm record
4: No storage device
enable_time_table=<int>
0, 1
record_time_table=<string>
record_full_handle=<int>
Record schedule.
This is a 168-character string with possible
values 0 and 1.
0: No
1: Yes
1, 2
start_recort=<int>
0, 1
Example:
Set Record parameters.
Note
http://192.168.86.6/goform/ sdrecord?cmd=get
- 38 -
Table 1:
MODEL
GXV3662
GXV3651
GXV3601HD
GXV3611HD
Preserve
d
Memory(M
)
24
IP960
GXV3500
IP5150
GXV3501
GXV3504
GXV3601
GXV3601LL
GXV3611LL
GXV3615(W
)
3615WP_HD
IP1200
24
BitRate
(bps)
<=512
<=1024
<=1536
<=2048
<=3072
<=4096
<=6144
>6144
<=512
<=1024
<=1536
<=2048
<=3072
<=4096
<=6144
>6144
<=256
<=512
<=1024
<=1536
<=2048
Pre_Record
Max.Time(s
)
100
50
45
30
20
15
10
10
50
20
15
10
5
5
4
3
90
50
20
15
10
Post_Record
Max.Time(s)
200
100
60
60
40
30
20
10
70
40
25
20
15
10
5
4
120
70
40
25
20
<=256
160
320
<=512
100
200
<=1024
50
100
<=1536
45
60
<=2048
30
60
NA
- 39 -