Grandstream Networks, Inc.

Grandstream Video Surveillance

HTTP API
Version [Link]

PROPRIETARY & CONFIDENTIAL

2012 Grandstream Networks, Inc.

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.

Software Version Requirement

The current official firmwares from Grandstream about the surveillance products are all
supported.
URL format:
ClientServer
[Link]
Note: <param> is used to mark the different function modules
Example 1:
Get device status.
[Link]
Example 2: POST
POST /goform/systeminfo HTTP/1.0\r\n
Content-Type: application/x-www-form-urlencoded\r\n
Context-type: text/xml;charset=utf-8\r\n
Content-Length: xxx\r\n
\r\n
cmd=get\r\n
ServerClient
HTTP/1.0 <HTTP code> <HTTP text>\r\n
Example:
Get device status
http/1.0 200 OK\r\n
productmode=GXV3601\r\n
hardwareversion=V0.2B\r\n
partnumber=9670000302B\r\n
bootloaderversion=[Link]\r\n
coreversion=[Link]\r\n
baseversion=[Link]\r\n
firmwareversion=[Link]\r\n
systemrun=641\r\n
mac=000B821EA32F\r\n

-3-

URL Parameter Definitions

<parameter>=<value>

Values

Description

cmd=<string>

add/remove/set/get
/search/reg

Operation command type (Required).

add: adding client parameter
remove: deleting client parameter
set: setting client parameter
get: getting client parameter
search: searching Wi-Fi SSID
reg: registering DDNS account

channel=<int>

0, 1, 2, 3

Channel 0-3: Some parameters require

the assigned channel: e.g. audio/video
setting and motion detection.
If the channel is not assigned, the default
channel 0 will be returned.
For DVS, channel is: 0-3.
This parameter not applied to IPCamera

Common URL Format

Format Description

The Corresponding Format

Devices with multiple channels (GXV3504)

will use channel number as separators
when getting parameters.
All the parameters are ordered by level.

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

Index is used as mark when multiple

parameters with same lever are applied.

channel=0\r\n
.
[Link]=0\r\n
<param>=<value>\r\n

[Link]=1\r\n
<param>=<value>\r\n

[Link]=2\r\n
<param>=<value>\r\n

e.g.:
16 motion detection regions in channel 0

-4-

[Link]=3\r\n
<param>=<value>\r\n

count and id are used to differentiate

when same lever of parameters with
uncertain number of format used.
e.g.:
Schedule of motion detect region

[Link]=3\r\n
[Link]=1
[Link]=0
[Link]=7
[Link]=0
[Link]=86399
[Link]=2
[Link]=0
[Link]=1
[Link]=0
[Link]=4879
[Link]=3
[Link]=1
[Link]=7
[Link]=0
[Link]=86399
.

Responses from the Device

HTTP/1.0 <HTTP code> <HTTP text>\r\n
HTTP Code

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

Bad request or request failed.

401

Unauthorized

Authorization failed.

404

Not Found

Not found due to incorrect command format

or incorrect data.

503

Service
Unavailable

This message returned when the server busy or

unavailable (e.g.: retrieve/set/add/delete failed or busy)

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.:
[Link]
<parameter>=<value>

Values

Description

channel=<int>

0, 1, 2, 3

Channel numbers in integer.

Default 0 for IP Camera.

[Link]=<int>
[Link]=<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.

[Link]=<int>
[Link]=<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.

[Link]=<int>
[Link]=<int>

16, 32, 64,

1024

Video bit rate.

Varies among different device
models.

[Link]=<int>
[Link]=<int>

0, 1

0: VBR(Variable bitrate)
1: CBR(Constant bitrate)

[Link]=<int>
[Link]=<int>

1-30

Frame rate.
Varies among different device
models and NTSC/PAL format.

[Link]=<int>
[Link]=<int>

1-100

I frame interval.

[Link]=<int>
[Link]=<int>

1-5

Image quality:
Level 1-5.
The lower the value the greater
the image quality (only valid
with VBR configuration)

[Link]=<int>
[Link]=<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 [Link]
(share "[Link]")
[Link]=<int>
[Link]=<int>

16, 32

Audio bitrate.
Some device models may only
support [Link]
(share [Link]")

[Link]=<int>

0, 1

Audio input

[Link]=<int>

0, 1

Audio output

[Link]=<int>

(1-10)
Valid for:
GXV3601/3601
LL/3601HD/361
1LL/3611HD/35
01/3504/3615/3
615W

Audio input volume

(1-5)
Valid for
GXV3651FHD/
3662HD/3615
WP_HD/3500
[Link]=<int>

(1-10)
Valid for:
GXV3601/3601
LL/3601HD/361
1LL/3611HD/35
01/3504/3615/3
615W

Audio output volume

(0-31)
Valid for
GXV3651FHD/
3662HD/3615
WP_HD/3500
[Link]=<int>

0, 1, 0xFF

Audio chip type

(Read Only, not savable)
0: AIC33 (default)
-7-

1: AIC3104
0xFF: None
[Link]=<int>

0, 1

Video format
(Read Only, not savable)
0:PAL
1:NTSC

[Link]=<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.
[Link]
200 OK\r\n
Successful\r\n

2. OSD Settings
Support method: cmd = set/get
[Link]
<parameter>=<value>

Values

Description

channel=<int>

0, 1, 2, 3

Channel numbers in integer.

Default 0 for IP Camera.

osdposition=<int>

0, 1

Time OSD position.

0: top
1: bottom

osdtimeshow=<int>

0, 1

Display the time OSD

0: Not display
1: Display

osdtextshow=<int>

0, 1

OSD text:
0: Not display
1: Display

osdopacity=<int>

0, 10, 20100.

OSD Opaque lever (%)

(GXV3601/3601LL/3601HD/3611LL/3611
HD/3501/3504/3615/3615W Only)

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

OSD index number (pending)

Example:
[Link]
0&osdopacity=20&osdcolor =0xFFFFFE&osdtext=12345
200 OK\r\n
Successful\r\n

3. Network Parameters
Support cmd = set/get,

it will take effect after the reboot.

[Link]
<parameter>=<value>

Values

httpport=<int>

Description
HTTP port

enabledhcp=<int>

0, 1

DHCP.
0: disable
1: enable

ipaddress=<string>

[Link]

IP Address.
Not valid when starting DHCP.

subnetmask=<string>

[Link]

Subnet mask

defaultgateway=<string>

[Link]

Default gateway

autodns=<int>

0, 1

0: Preferred DNS server

1: Automatically obtain DNS server

[Link]=<string>

Primary DNS server

[Link]=<string>

Backup/secondary DNS server

Example

-9-

[Link]
86.145
200 OK\r\n
Successful Need Reboot\r\n

4. Dynamic DNS (DDNS)

Support

cmd = set/get

[Link]
<parameter>=<value>

Values

Description

enableddns=<int>

0, 1

DDNS
0: disable
1: enable

isptype=<int>

0-6

ISP type
0: [Link]
1: [Link]
2: ActiveDNS
3: [Link]
4: [Link]
5: [Link]
6: [Link]

sitename=<string>

Site name, max 255 Bytes

ddnsip=<string>

Custom DDNS site

account=<string>

DDNS account, max 23 Bytes

password=<string>

DDNS password, max 63 Bytes

stunserver=<string>

STUN Server, max 255 Bytes

Example:
[Link]
200 OK\r\n
Successful\r\n

5. SIP
Support cmd = set/get, it will take effect on next reboot.
[Link]
<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>

Account name, max 127 Bytes.

sipserver=<string>

SIP server, max 255 Bytes.

proxyserver=<string>

Proxy server or IP address.

userid=<string>

SIP user ID, max 255 Bytes.

authenticateid=<string>

Authenticate ID.
Could be the same or different as SIP UserID,
max 127 Bytes.

accountpassword=<string>

Account password, max 127 Bytes.

Only used for setting password, not for
acquiring password.

stunserver=<string>

STUN server URI or IP: PORT,

max 127 Bytes.

sipstream=<int>

0, 1

0: Secondary
1: Primary

audioencoder=<int>

0, 1

0: PCMU
1: PCMA
Default is 0, PCMU.

regexpiration=<int>

Default is 3600 (in second), max 45 days.

localsipport=<int>

Local SIP port.

Default is 5060.

localrtpport=<int>

1024-30000

Local RTP port, 1024~30000

autohooktimer=<int>

0-65535

Auto hook timer, in second.

0: Never onhook.
Default is 0.

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

Enable SIP open door.

0: No
1: Yes

sipdoorpwd=<string>

Number
0 to 9

SIP open door password.

Valid length between 4 to 8 characters.

sipdoortime=<int>
Phonebook settings. Support

SIP open door time (delay timer before close)

cmd = add/remove/get.
- 11 -

<parameter>=<value>

Values

[Link]=<int>

Description
Total phonebook entries.

[Link]=<int>

1, 2.

Index of phonebook entries.

[Link]=<string>

Phone number, max 15 Bytes.

[Link]=<string>

Name/Note of phone number, max 127 Bytes.

white_list_phone=<string>

Phone numbers of incoming call white list.

audio_warning_mode=<int>

0, 1

Audio warning mode.

0: No. Play alarm audio to the other party.
1: Yes. Establish 2-way audio.
Default value is 1.

Note: phonebook entry can be added one at a time.

Example:
Add phone number.
[Link]
200 OK\r\n
Successful Need Reboot\r\n

Example (URL)
[Link]
r=[Link]&userid=3028&authenticateid=3028&accountpassword=123456
[Link] white_list_phone=2222
[Link] white_list_phone=2222,3333,4444,

Delete phone
numbers in white list

6. Date & Time

Support

cmd = set/get

[Link]
<parameter>=<value>

Values

Description

updatemode=<int>

1-2

Update mode.
1: Update via NTP time server (Default)
2: Self-defined

year=<int>

Greater than 1900

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 -

35: GMT+10 (Hobart)

36: GMT+10 (Canberra, Melbourne,
Sydney)
37: GMT+11(Solomon Isl.)
38: GMT+12(Auckland, Wellington)
39: GMT-9:00 Daylight Saving
Time(Alaska Time)
40: GMT-8:00 Daylight Saving
Time(Pacific Time)
41: GMT-7:00 Daylight Saving
Time(Mountain Time)
42: GMT Daylight Saving Time (Dublin,
Ireland )
43: GMT Daylight Saving Time (Lisbon,
Portuga)
44: GMT Daylight Saving Time(London,
Great Britain)
45: GMT+1:00 Daylight Saving
Time(Amsterdam, Barcelona, Berlin,
Brussels, Budapest, Copenhagen)
46: GMT+1:00 Daylight Saving
Time(Geneva, Madrid, Oslo, Paris,
Prague, Roma, Stockholm)
47: GMT+2:00 Daylight Saving
Time(Athens, Helsinki, Kyiv, Tallinn)
48: GMT+3:00 Daylight Saving
Time(Moscow)
49: GMT+3:00 Daylight Saving
Time([Link])
50: GMT+9:30 Daylight Saving
Time(Adelaide)
51: GMT+10:00 Daylight Saving
Time(Melbourne, Canberra, Sydney)
52: GMT+10:00 Daylight Saving
Time(Hobart)
53: GMT+12:00 Daylight Saving
Time(Auckland, Wellington)
54: Using self-defined Time Zone
deftimezone=<string>

Self-defined Time Zone.

For example,
EST+5EDT+4,M3.2.0,M11.1.0
Valid Only when timezone= 54
(Using self-defined Time Zone)

ntpserverenable=<int>

0, 1

Enable NTP server.

- 14 -

0: No
1: Yes
ntpserver=<string>
datestyle=<int>

NTP server, max 255 Bytes

1, 2, 3

OSD date format

1: YYYY-MM-DD
2: MM/DD/YYYY
3: DD MM YYYY

Note: parameter "updatemode" is required in each link.

Example:
[Link]
ay=26&hour=22&minute=22&second=33&timezone=22&deftimezone=EST+5EDT+4,M3.
2.0,M11.1.11&ntpserver=[Link]
200 OK\r\n
Successful\r\n

7. Status
Support

cmd = get/set

(cmd=set can only be used by "devicename").

[Link]
<parameter>=<value>

Values

Description

productmode=<string>

GXV3501,
GXV3504,
GXV3601,
GXV3601HD/LL,
GXV3611HD/LL,
GXV3615W/P,
GXV3651FHD,
GXV3662HD,
GXV3615WP_HD
GXV3500

Device model may vary.

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>

Camera type: brand and model.

- 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

[Link]
[Link]

LED Status( GXV3615 series Only )

0:On
1:Off
PPPoE IP. Default is [Link]

0, 1

PPPoE status
0: disconnected
1: connected

ipaddress

For display only

subnetmask

For display only

defaultgateway

For display only

8. Account Management
Support cmd = add/remove/set/get
[Link]
<parameter>=<value>

Values

Description

[Link]=<int>

>=1

Total user numbers

[Link]=<int>

1, 2

Index of users

[Link]=<int>

0, 1, 2

User Privilege.
0: administrator
1: user
2: anonymous

[Link]=<string>

User namemax 23 Bytes

[Link]=<string>

User password, max 63 Bytes

[Link] =<int>

0, 1

Allow anonymous login.

0: No
1: Yes

Example:
[Link]

- 16 -

200 OK\r\n
Successful\r\n

9. SMTP (E-mail) Settings

Support

cmd = set/get

[Link]
<parameter>=<value>

Values

Description

enablesmtp=<int>

0, 1

Enable SMTP:
0: No
1: Yes

smtpserver=<string>

SMTP Server, max 255 Bytes

smtpserverport=<int>

SMTP Server port

emailfrom=<string>

From E-Mail address, max 63 Bytes

emailuser=<string>

E-mail user name, max 63 Bytes

emailpassword=<string>

E-mail password, max 63 Bytes

emailto1=<string>

To E-Mail address 1, max 63 Bytes

emailto2=<string>

To E-Mail address 2, max 63 Bytes

emailto3=<string>

To E-Mail address 3, max 63 Bytes

enablessl=<int>

0, 1

Use SSL.
0: No
1: Yes

smtptest=<int>

To test SMTP uses smtptest=1.

Other value does not work.
Return:
smtptestresult = 0:
test failed with smtp error message
smtptestresult = 1:
test success

Example:
Set SMTP parameters. When enablesmtp=1, the Email address format will be checked.
[Link]
(when enablesmtp=1, basic check will be performed to all the addresses)
200 OK\r\n
Successful\r\n

10. FTP Settings

Support

cmd = set/get
- 17 -

[Link]

<parameter>=<value>

Values

Description

enableftp=<int>

0, 1

Enable FTP.
0: No
1: Yes

ftpserver=<string>

FTP server, max 255 Bytes

ftpserverport=<int>

FTP server port

ftpuser=<string>

FTP user name, max 23 Bytes

ftppassword=<string>

FTP password; it would not be sent along with

parameters, max 63 Bytes

ftppath=<string>

FTP path, max 63 Bytes

ftptest=<int>

To test FTP use ftptest =1.

Other values do not work.
Return:
ftptestresult = 0: test failed with ftperrormessage
ftptestresult = 1: success

Example:
Set FTP parameters.
[Link]
dmin&ftppath=admin
200 OK\r\n
Successful\r\n

11. PTZ Settings

Support

cmd = set/get

(Only available to GXV3501/3504/3500)

[Link]
<parameter>=<value>

Values

Description

protocol=<int>

0, 1

Select PTZ Protocal

0: PELCO-P
1: PELCO-D

channel=<int>

0-3

(pending)

baudrate=<int>

1200, 2400, 4800,

9600

Baud rate.
May vary among different
device models.
- 18 -

ptzparam=<int>

0-63 (Speed)
0-127 (Default position)

PTZ speed or default position.

For default position values,
certain values between 0 to
127 have been already used.

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.
[Link]
(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

12. Alarm Event

Support

cmd = set/get/add/remove

[Link]
<parameter>=<value>

Values

Description

[Link]=<int>

0, 1, 4

Numbers of alarm input

supported by devices.
- 19 -

May vary among

models.
For example, IP camera
supports 1 alarm input,
GXV3504 supports 4.
[Link]=<int>

0, 1, 2, 3

Index of alarm input

[Link]=<int>

0, 1

Numbers of schedules

[Link]=<int>

1, 2, 3

ID of schedules

[Link]=<int>

0-7

0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
7: Everyday(default)

[Link]=<int>

0-86399

Default is 0 (in seconds).

Example: 12:39,
starttime =
12*3600+39*60

[Link]=<int>

0-86399

Alarm event end time.

Default is 86399 (in
seconds).

[Link]=<string>

yes

Stop alarm output

[Link]=<int>

0-160
([Link]<256)
0-100
([Link]<512)
0-50
([Link]<1024)
0-25
([Link]>1024)

Record Video From

Pre-Alarm (in seconds).
The range varies among
different bitrate.

[Link]=<int>

0-320
([Link]<256)
0-200
([Link]<512)
0-100
([Link]<1024)
0-50
([Link]>1024)

Record Video to
Post-Alarm (in seconds).
The range varies among
different bitrate.

[Link]=<int>

1, 2

Alarm record storage

method.
0: Do not save
1: SD card
- 20 -

2: USB Flash Drive

3: DISK
(This may not be
available for some
device models)
[Link]=<int>

0, 1

Record Video uploads to

FTP Server.
0: disable
1: enable

[Link]=<int>

0, 1

Voice Alarm to SIP

phone.
0: disable
1: enable

[Link]=<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;

[Link]=<int>

0, 1

Upload to Alarm Center.

This option has to be
enabled for PC to
receive alarm event
notification
0: disable
1: enable

[Link]=<int>

0, 1

Email snapshot and

store it to SD drive.
Note: e-mail and storage
devices have to be
existed and enabled.
0: disable
1: enable

Example:
Parameter settings.
[Link]
&[Link]=10&[Link]=1&[Link]=1&[Link]
[Link]=1&[Link]=1&[Link]=1&[Link]
[Link]=1

- 21 -

HTTP/1.0 200 OK\r\n

Successful\r\n

Add a schedule with Everyday as default.

[Link] [Link]=0
HTTP/1.0 200 OK\r\n
Successful\r\n
[Link]
=4& [Link]=200& [Link]=40000
HTTP/1.0 200 OK\r\n
Successful\r\n
Delete a schedule with id=111.
[Link] =111,2,3
HTTP/1.0 200 OK\r\n
Successful\r\n

13. Motion Detection

Support

cmd = add/remove/set/get

[Link]

<parameter>=<value>

Values

Description

[Link]=<int>

1, 4

Number of channels for

motion detection.
IP camera has only 1
channel; GXV3504
support 4 channels.

[Link]=<int>

0, 1, 2, 3

Corresponding index for

channels.
IP camera: 1.
4 channel DVS: 0-3.

[Link]=<int>

0, 1

Enable Motion
Detection
0: No
- 22 -

1: Yes
[Link]=<int>

0-15

Motion Detection
Region 0-15

[Link]=<int>

First 2 bytes used for X;

Last 2 bytes used for Y

[Link]=<int>

First 2 bytes used for X;

Last 2 bytes used for Y.
If [Link]=0 and
[Link]=0, it
means invalid region.

[Link]=<int>

0-100

Sensitivity.
The higher the value the
greater the sensitivity

[Link]=<int>

0, 1

Total number of
schedule.

[Link]=<int>

0, 1, 2, 3

Schedule ID (1-n).
If ID is set to 0, all the
schedules will be
deleted.

[Link]=<int>

0-7

0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
7: Everyday(default)

[Link]=<int>

0-86399

Default is 0 (in
seconds).
Example: 12:39,
starttime =
12*3600+39*60

[Link]=<int>

0-86399

Default is 86399 (in

seconds).
Example: 12:39,
starttime =
12*3600+39*60

[Link]=<int>

0, 1, 2, 3

Alarm record storage

method:
0: Do not save
1: SD card
2: USB Flash Drive
3: DISK
(This may not be
- 23 -

available for some

device model)
[Link]=<int>

0-160
([Link]<256)
0-100
([Link]<512)
0-50
([Link]<1024)
0-25
([Link]>1024)

Record Video From

Pre-Alarm (in seconds).
This may vary among
different bitrates.

[Link]=<int>

0-320
([Link]<256)
0-200
([Link]<512)
0-100
([Link]<1024)
0-50
([Link]>1024)

Record Video to
Post-Alarm (in
seconds). This may
vary among different
bitrates.

[Link]=<int>

0, 1

Record Video and

upload to FTP Server.
0: enable
1: disable

[Link]=<int>

0, 1

Voice Alarm to SIP

Phone.
0: enable
1: disable

[Link]=<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;

[Link]=<int>

0, 1

Upload to Alarm Center.

This option has to be
enabled for PC to
receive alarm event
notification.
0: enable
1: disable

[Link]=<int>

0, 1

Email snapshot and

store it to USB card or
SD drive.
- 24 -

Note: e-mail and

storage devices have to
be existed and enabled.
0: enable
1: disable
Example
Parameter settings.
Delete a schedule which has id=1.
[Link]
time=10&[Link]=20&[Link]=1&[Link]=1&[Link]
[Link]=1&[Link]=1&[Link]=1
HTTP/1.0 200 OK\r\n
Successful\r\n
Example (URL)

Note

[Link]
[Link]
[Link]=26214800&[Link]=1
[Link]
[Link]=26214800&[Link]=101
[Link]
[Link]
me=30&[Link]=10&[Link]=0&[Link]=0&[Link]
[Link]=0&[Link]=0&[Link]=0
[Link]
me=10&[Link]=20&[Link]=1&[Link]=1&[Link]
[Link]=1&[Link]=1&[Link]=1
[Link]
[Link]
[Link]
[Link]
[Link]
2
[Link]/goform/motiondetect?cmd=set&[Link]=0&[Link]=0&[Link]

Delete Alarm

[Link]=0&[Link]=1

Region

- 25 -

14. System Log

Support

cmd = set/get

[Link]
<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
[Link]
200 OK\r\n
Successful Need Reboot\r\n

Example (URL)

Note

[Link]
[Link]
[Link]

15. USB/SD Storage

Support

cmd = remove/get/format

[Link]
<parameter>=<value>

Values

Description

[Link]=<int>

Total number of storage

equipments

[Link]=<int>

1, 101, 201

1: USB
101: SD
201: DISK

[Link]=<string>

Total storage capacity

[Link]=<stri
ng>

Used space (MB)

- 26 -

[Link]=<strin
g>

Free Space (MB)

[Link]=<int>

Total numbers of saved files.

[Link]=<int>

1, 2, 3

File index

[Link]=<string>
[Link]=<string>

File size (MB)

192.168.86.20_chn0_201
1_09_21_14_43_48.jpg
0_2_2011_09_21_13_32
_21_1718_1.avi

File Name with path. It can be

used to download that particular
file.
e.g.
[Link]
Image file format:
ip_channel_date_time.jpg
AVI file format:
channel_recordtype_date_time_f
ilelength_endmark.avi

storage_type=<int>

1, 2, 3

When formatting the storage

device, use the storage type to
specify.
1: Flash USB
2: SD Card
3: USB Disk (Pending)

Example:
Delete a file from USB/SD card.
[Link]
n1_2010_01_13_09_21_58.jpg
200 OK\r\n
Successful\r\n

16. Maintenance/Upgrade
Support cmd = set/get
[Link]
<parameter>=<value>

Values

Description

restart=<string>

yes

Restart the device

restore=<string>

yes

Reset settings to factory

default

[Link]=<int>

1, 2, 3

Upgrade via:
1: TFTP
2: HTTP
3: HTTPS
- 27 -

[Link]=<string>

serverhost:port/dir

Firmware Server path

[Link]=<string>

serverhost:port/dir

Configuration server
path, max 255 Bytes

upgrade_cfg_xml_pwd=<string>

XML config file password

[Link]=<int>

0, 1

Automatic upgrade:
0: No
1: Yes

[Link]=<int>

60-525600

Automatic upgrade
interval (in minutes)

Example:
Set maintenance and upgrading parameters.
[Link]
200 OK\r\n
Successful\r\n

17. Contrast, Saturation, Brightness and Chroma

Support cmd = set/get
[Link]
Note: Contrast, saturation, brightness and chroma have to be set at the same time.
Otherwise, it would be 0(default). Color may not be available for some models.
<parameter>=<value>

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

Chroma (Chroma may not

be available for some
models)

Default=<int>

3, 4

3: set default value

4: set color-enhancement
default value (For
GXV3601HD/3611HD
only)

Example:
[Link]
200 OK\r\n
Successful\r\n

- 29 -

18. WIFI Settings

Support cmd = set/get/search
[Link]
<parameter>=<value>

Values

Description

wifiexist=<int>

0, 1

This is only applicable on GXV3615W and

GXV3615WP_HD.
0: WIFI is not supported
1: WIFI is supported

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:

Setting WIFI parameter.

[Link] =mywifi
200 OK\r\n
Successful Need Reboot\r\n

19. System Settings

Support cmd = set/get/search
[Link]
<parameter>=<value>

Values

devicename=<string>

Description
Device name

channel=<int>

0-3

Channel number

[Link]=<int>

0,1

0:Normal Open
1:Normal Close
- 30 -

[Link]=<int>

0,1

0:Normal Open
1:Normal Close

[Link]=<int>

0,1

This is used to get the current state of the alarm

in.
0: Open
1: Close

[Link]=<int>

0,1

This is used to get the current state of the alarm

in.
0: Open
1: Close

alarm_output_time=<int>

0, 5,15,
30, 60,
180, 300,
600,
900,1800

0: keep alarm until manually turned off

N: alarm off after N seconds

gpio_pin_multiplex=<int>

0, 1

Extension port mode.

0: control mode (RS485) (default)
1: alarm input/output mode.
(For IP960/IP1200/IP5150 only)

Example 1:

Setting alarm active state.

[Link]
200 OK\r\n
Successful \r\n

Example 2:

Alarm Type

Alarm Status

Result

[Link]=NORMAL
OPEN

[Link]=OPEN

IDLE, no alarm output

[Link]=NORMAL
OPEN

[Link]=CLOSE

alarm output enabled

[Link]=NORMAL
CLOSE

[Link]=OPEN

alarm output enabled

[Link]=NORMAL
CLOSE

[Link]=CLOSE

IDLE, no alarm output

[Link]=NORMAL
OPEN

[Link]=OPEN

IDLE, no alarm input

[Link]=NORMAL
OPEN

[Link]=CLOSE

alarm input detected

[Link]=NORMAL

[Link]=OPEN

alarm input detected

- 31 -

CLOSE
[Link]=NORMAL
CLOSE

[Link]=CLOSE

IDLE, no alarm input

20. PPPoE Settings

Support

cmd = set/get

[Link]
<parameter>=<value>

Values

Description

[Link]=<string>

PPPoE username

password=<string>

PPPoE password
(Not show when using get)

[Link]=<int>

0, 1

PPPoE stauts (read only)

0: disconnected
1: connected

[Link]=< string >

PPPoE IP (read only)

Example:

Set PPPoE parameter.

[Link]
200 OK\r\n
Successful \r\n

21. Snapshot
[Link]
<parameter>=<value>
[Link]
[Link]
[Link]
[Link]

Values

[Link]
[Link]
[Link]
[Link]

Description
Capture [Link] in single channel.
Capture [Link] [Link] in 4 channels.

Example:

Capture a snapshot.
[Link]

- 32 -

22. Web GUI Language

[Link]
<parameter>=<value>

Values

Description

language=<int>

0, 1, 2

0: English (default)
1: Chinese
2: Russian

Example:

[Link]

23. Decode Settings (For GXV3500 only)

[Link]
<parameter>=<value>

Values

Description

decode_source=<int>

0, 1

Decode source.
0:RTSP
1:SIPphone

default_decode=<int>

0-7

Default decode channel

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:

[Link]

24. Stream Acquiring

[Link]
<parameter>=<value>

Values

Description

channel=<int>

0-7

Stream channel (default is 0)

For secondary stream, the channel number used
is equal to: n+4.

Example:

[Link]

25. CMOS Settings

Support
cmd = set/get.
Note: This setting only applies to certain models:
GXV3651FHD/3662HD/3615WP_HD/3500
[Link]
<parameter>=<value>

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

IRIS aperture open range

1:100%
2:80%
3:60%
4:40%
5:20%

up_bias=<int>

6000-11000

IRIS aperture bias up range.

Default value is 8160
(For GXV3662HD only)

down_bias=<int>

6000-11000

IRIS bias down range:

Default value is 8150
(For GXV3662HD only)

- 34 -

shutter_speed=<int>

0, 30, 60, 125, 250, 500,

1000

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.

[Link] =1
200 OK\r\n
Successful \r\n
Example (URL)

Note

[Link] cmos?cmd=get
[Link] =30

26. 4*D1 Settings (For GXV3504 only)

[Link]
<parameter>=<value>

Values

Description

enable=<int>

0, 1

0: No
1: Yes

[Link]=<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:

[Link]

27. Alarm HTTP Servers Settings

Support

cmd=set/get

[Link]
<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.

[Link]
l=http://
200 OK\r\n
Successful \r\n

Example (URL)

Note

[Link] event_server?cmd=get
[Link]
verurl&server_username=username&server_user_password=pwd

28. Record Settings

Support

cmd = set/get

[Link]
<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

Enable record schedule.

0: No
1: Yes

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

When the record is full,

1: Override the oldest record.
2: Stop recording. (Use channel 0 record only)
- 37 -

start_recort=<int>

0, 1

For record manually.

0: Stop
1: Start
Manual record will fail if auto-record or
alarm-record has started already.

Example:
Set Record parameters.

[Link] channel =0& enable_time_table =1&

record_time_table=010111111
200 OK\r\n
Successful \r\n
Example (URL)

Note

[Link] sdrecord?cmd=get

[Link] channel =0& enable_time_table

=1& record_time_table=010111111
[Link] =0
[Link] channel =0&record_start =1

- 38 -

Table 1:

Device Alarm Recording Time Table

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
[Link](s
)
100
50
45
30
20
15
10
10
50
20
15
10
5
5
4
3
90
50
20
15
10

Post_Record
[Link](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 -