Grandstream Networks Inc

Grandstream

Video Surveillance HTTP API

Version 10054

wwwgrandstreamcom

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 2 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

This page intentionally left blank

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 3 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

TABLE OF CONTENTS

Grandstream Video Surveillance HTTP API OVERVIEW 5

SOFTWARE VERSION REQUIREMENT 5 URL PARAMETER DEFINITIONS 8 COMMON URL FORMAT 9 RESPONSES FROM THE DEVICE 10

PARAMETERS 12 1 AUDIOVIDEO PARAMETERS 12 2 OSD SETTINGS 16 3 NETWORK PARAMETERS 17 4 DYNAMIC DNS (DDNS) 18 5 S I P 19 6 DATE amp TIME 22 7 STATUS 26 8 ACCOUNT MANAGEMENT 27 9 SMTP (E-MAIL) SETTINGS 28 10 FTP SETTINGS 29 11 PTZ SETTINGS (ONLY FOR GXV3500 AND GXV3504) 30 12 ALARM EVENT 33 13 MOTION DETECTION 37 14 SYSTEM LOG 41 15 LIVE STORAGE (ONLY FOR SUPPORTED MODELS) 42 16 MAINTENANCEUPGRADE 43 17 CONTRAST SATURATION BRIGHTNESS AND CHROMA 44 18 WIFI SETTINGS (ONLY FOR SUPPORTED MODELS) 46 19 SYSTEM SETTINGS 47 20 PPPOE SETTINGS 49 21 SNAPSHOT 50 22 WEB GUI LANGUAGE 51 23 DECODE SETTINGS (FOR GXV3500 ONLY) 52 24 STREAM ACQUIRING (MJPEG ONLY) 53 25 CMOS SETTINGS (ONLY FOR SUPPORTED MODELS) 54 26 4D1 SETTINGS (FOR GXV3504 ONLY) 57 27 ALARM HTTP SERVERS SETTINGS 58 28 RECORD SETTINGS 59 29 TIME LAPSE PHOTOGRAPHY 60

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 4 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

This page intentionally left blank

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 5 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

OVERVIEW Grandstream Video Surveillance H T T P API (Application Programming Interface) supports RFC1945 (HTTP 10) and RFC3550 (RTP) This document explains in details the parameters of functions in client side via the supported GETPOST method Administrator Privilege is required to set or retrieve those parameters This is achieved at the HTTP command level by prefixing the username and the password in accordance to the following format httpusernamepassword Software Version Requirement

All current official firmware of the Grandstream surveillance products are supported URL Format Client Server

httpusernamepasswordltservernamegtgoformltparamgtcmd=ltvaluegtampltparametergt=ltvaluegtamp

NOTE ltparamgt is used to identify the different module of functions

Example 1 GET Get device status httpltservernamegtgoformsysteminfocmd=get

GET goformsmtpcmd=setampenablesmtp=0ampsmtpserver=ampsmtpserverport=25ampemailfrom=ampemailto1=ampemailto2=ampemailto3=ampemailuser=ampenablessl=0 HTTP11 Accept Accept-Language zh-cn context-type textxmlcharset=utf-8 Referrer http1921688611Pagessmtphtml Cache-Control no-cache Content-Type applicationx-www-form-encodeURIComponent If-Modified-Since 0 Accept-Encoding gzip deflate User-Agent Mozilla40 (compatible MSIE 80 Windows NT 51 Trident40 NET CLR 2050727 NET CLR 114322 CIBA NET CLR 3004506648 NET CLR 3045062152 NET CLR 3530729) Host 1921688611 Connection Keep-Alive Authorization Basic YWRtaW46YWRtaW4=1 1 Authentication Information encrypted via BASE64 with Format Authorization Basic info Info User ID Password separated via encrypted via BASE64 encryption strings eg adminadmin is YWRtaW46YWRtaW4=

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 6 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example 2 POST POST goformsysteminfo HTTP10rn Content-Type applicationx-www-form-urlencodedrn Context-type textxmlcharset=utf-8rn Content-Length xxxrn rn cmd=getrn

Server Client

HTTP10 ltHTTP codegt ltHTTP textgtrn

Example 3 Get Device Status GET goformsmtpcmd=get HTTP11 Accept Accept-Language zh-cn Referer http1921688611Pagessmtphtml If-Modified-Since 0 Accept-Encoding gzip deflate User-Agent Mozilla40 (compatible MSIE 80 Windows NT 51 Trident40 NET CLR 2050727 NET CLR 114322 CIBA NET CLR 3004506648 NET CLR 3045062152 NET CLR 3530729) Host 1921688611 Connection Keep-Alive Authorization Basic YWRtaW46YWRtaW4= http10 200 OKrn productmode=XXXXrn hardwareversion=V02Brn partnumber=9670000302Brn bootloaderversion=1025rn coreversion=1201rn baseversion=1205rnq firmwareversion=1205rn systemrun=641rn

mac=000B821EA32Frn

TIPS of HTTP API Usage In most situation parameters fetched by using ldquoGETrdquo can be revised by using ldquoSETrdquo

unless Status or Display parameter information When using ldquoSETrdquo sometimes there are inter-action or restrictions among those related

parameters all parameters must ldquoSETrdquo or configure correctly together before the device taking effect

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 7 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Please refer to related WebGUI page for reference if unsure about the HTTP API

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 8 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

URL Parameter Definitions

ltparametergt=ltvaluegt Values Description cmd=ltstringgt addremovesetget

searchreg Operation command type (Required) add add client parameter remove delete client parameter set configure client parameter get fetch client parameter search search parameter eg Wi-Fi ID reg register DDNS account

channel=ltintgt 0 1 2 3 Channel 0-3

Some parameters require assigned channel eg audiovideo setting and motion detection

If no channel assigned the default channel 0 used For GXV3504 channel is 0 ~ 3 IP Camera no need to set this parameter

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 9 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Common URL Format

Format Description Corresponding Format

Devices with multiple channels (GXV3504) will use channel number as separators when getting parameters All parameters organized by levels

channel=0rn ltparamgt=ltvaluegtrn helliphellip channel=1rn ltparamgt=ltvaluegtrn helliphellip channel=2rn ltparamgt=ltvaluegtrn helliphellip channel=3rn ltparamgt=ltvaluegtrn helliphellip

Index used as mark when multiple parameters with same level are applied

eg 16 Motion Detection Regions in Channel 0

channel=0rn helliphellip mdregnindex=0rn ltparamgt=ltvaluegtrn helliphellip mdregnindex=1rn ltparamgt=ltvaluegtrn helliphellip mdregnindex=2rn ltparamgt=ltvaluegtrn helliphellip mdregnindex=3rn ltparamgt=ltvaluegtrn helliphellip

ldquocountrdquo and ldquoidrdquo used to differentiate unidentified parameters format at the same level

eg

Schedule of Motion Detect Region

mdregnschedulecount=3rn mdregnscheduleid=1 mdregnindex=0 mdregnscheduledayset=7 mdregnschedulestarttime=0 mdregnscheduleendtime=86399 mdregnscheduleid=2 mdregnindex=0 mdregnscheduledayset=1 mdregnschedulestarttime=0 mdregnscheduleendtime=4879 mdregnscheduleid=3 mdregnindex=1 mdregnscheduledayset=7 mdregnschedulestarttime=0 mdregnscheduleendtime=86399 helliphellip

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 10 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Responses from the Device

HTTP10 ltHTTP codegt ltHTTP textgtrn

HTTP Code HTTP Text Description 200 OK Request i s successful

ldquoSuccessfulrnrdquo indicate configuration is successful It does not mean setdeleteadd successful until receiving ldquoSuccessfulrnrdquo Successful Need Rebootrn configure successful but it need reboot in order for parameters taking effect No Privilegern indicate incorrect privilege used ltparamgt Invalidrn invalid parameter used ltparamgt Missingrn missing parameters

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 (eg retrievesetadddelete failed or busy)

Example Request includes invalid file names

HTTP10 404 Not Foundrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 11 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

This page intentionally left blank

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 12 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

PARAMETERS 1 AudioVideo Parameters

Support method cmd = setget If devices support 2 streams they are called primary stream and secondary stream respectively

httpltservernamegtgoformaudio_videocmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description channel=ltintgt 0 1 2 3 Channel numbers in integer

Default 0 for IP Camera videoprimaryencoder=ltintgt videosecondaryencoder=ltintgt

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_profile=ltintgt video_secondary_profile=ltintgt

012

Profile

0- baseline 1- main profile 2- high profile

videoprimaryresolution=ltintgt videosecondaryresolution=ltintgt

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 NTSCPAL format used

videoprimarybitrate=ltintgt videosecondarybitrate=ltintgt

16 32 64 1024hellip

Video bit rate Varies among different device or models

videoprimarybrtype=ltintgt videosecondarybrtype=ltintgt

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

videoprimaryframerate=ltintgt videosecondaryframerate=ltintgt

1-30 Frame rate Varies among different device or models NTSCPAL format

videoprimaryiframe=ltintgt videosecondaryiframe=ltintgt

1-100 I frame interval

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 13 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

videoprimaryimagequality=ltintgt videosecondaryimagequality=ltintgt

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

audioprimaryencoder=ltintgt audiosecondaryencoder=ltintgt

0 1 2 3 4 Audio codec 0 PCMU 1 PCMA 2 G726 (valid only for HIS GXV3601HD35043611HD36153615W) 3 disabled Some models may only support audioprimaryencoderrdquo

(share audioprimaryencoder)

audioprimarybitrate=ltintgt audiosecondarybitrate=ltintgt

16 32 Audio bitrate Some models may only support audioprimaryencoderrdquo (share ldquoaudioprimaryencoder)

audiolinein=ltintgt 0 1 Audio input audiolineout=ltintgt 0 1 Audio output audiomicrophonevolume=ltintgt (1-10) Valid for

GXV3601HD3611HD3501350436153615W

(1-5) Valid for GXV3651FHD 3662HD3615 WP_HD3500361036723674 Series

Audio input volume HIS 1 ~ 10 TI 1 ~ 5

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 14 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

audiospeakervolume=ltintgt

(1-10) Valid for GXV3601HD3611HD3501350436153615W (1-5) Valid for GXV3651FHD 3662HD3615 WP_HD3500361036723674 Series

Audio output volume HIS 1 ~ 10 TI 1 ~ 5

audiochiptype=ltintgt 0 1 0xFF Audio chip type (Read Only non-writable) 0 AIC33 (default) 1 AIC3104 0xFF None

ntscpaltype=ltintgt 0 1 Video format (Read Only non-writable) 0PAL 1NTSC

powerfrequency=ltintgt 50 60 61 Power frequency

Indoor 50 50 (Europe China) Indoor 60 60 (US LATAM) Outdoor 61 (For models like GXV3651_FHDGXV3611IR_HD3662361036723674 Only)

tv_output_type=ltintgt

01

0-NTSC(default) 1-PAL

video_statu=ltstringgt

x0x1x2x3

cmd=get_video_statu (only for GXV3504) Get only Analog Camera Connection Status X0 channel 0 X1 channel 1 X2 channel 2 X3 channel 3 Status 0 - Disconnect 1 - Connect

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 15 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example Set AudioVideo parameters

http192168866goformaudio_videocmd=setampchannel=0ampvideoprimaryencoder=96 200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 16 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

2 OSD Settings

Support method cmd = setget

httpltservernamegtgoformosdcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description channel=ltintgt 0 1 2 3 Channel numbers in integer

Default 0 for IP Camera osdposition=ltintgt 0 1 Time OSD position

0 top 1 bottom

osdtimeshow=ltintgt 0 1 Display the time OSD 0 Not display 1 Display

osdtextshow=ltintgt 0 1 OSD text 0 Not display 1 Display

osdopacity=ltintgt 0 10 20hellip100 OSD Opaque lever () (HIS Model GXV3601HD3611HD350436153615W Only)

osdcolor =ltstringgt HIS GXV3601HDGXV3611HDGXV3501GXV3504GXV36153615W Only)

OSD color 0xFFFFFE Auto 0xFFFFFF White 0xFF0000 Red 0x800080 Purple 0xFF6100 Orange 0x0000FF Blue 0xFFFF00 Yellow 0x008000 Green 0x00FFFF Cyan 0x000000 Black

osdtext=ltstringgt OSD maximum 63 bytes osdtextindex=ltintgt 0 1 2hellip OSD index number (no use reserved)

Example http192168866goformosdcmd=setamposdposition=1amposdtimeshow=0amposdtextshow= 0amposdopacity=20amposdcolor =0xFFFFFEamposdtext=12345

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 17 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

3 Network Parameters

Support cmd = setget will take effect after the reboot

httpltservernamegtgoformnetworkcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description httpport=ltintgt HTTP port enabledhcp=ltintgt 0 1 DHCP

0 disable 1 enable

ipaddress=ltstringgt 1921681123 IP Address Not valid when using DHCP

subnetmask=ltstringgt 2552552550 Subnet mask defaultgateway=ltstringgt 19216811 Default gateway autodns=ltintgt 0 1 0 Preferred DNS server

1 Automatically obtain DNS server dnsserverprimary=ltstringgt Primary DNS server dnsserverstandby=ltstringgt Backupsecondary DNS server

Example

http192168866goformnetworkcmd=setampchannel=0ampautodns=1ampipadress=192168 86145

200 OKrn Successful Need Rebootrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 18 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

4 Dynamic DNS (DDNS)

Support cmd = setget

httpltservernamegtgoformddnscmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description enableddns=ltintgt 0 1 DDNS

0 disable 1 enable

isptype=ltintgt 0-6 ISP type 0 dyndnsorg 1 noipcom 2 ActiveDNS 3 cn99com 4 ipkannet 5 ipkancn 6 ipkancomcn

sitename=ltstringgt Site name maximum 255 Bytes ddnsip=ltstringgt Custom DDNS site account=ltstringgt DDNS account maximum 23 Bytes password=ltstringgt DDNS password maximum 63 Bytes stunserver=ltstringgt STUN Server maximum 255 Bytes

Example http192168866goformddnscmd=setampenableddns=1

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 19 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

5 S I P

Support cmd = setget will take effect immediately after saving

httpltservernamegtgoformsipcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description registeredstate=ltintgt 0 1 Registration state

0 Offline 1 Online unregister=ltintgt 0 1 Unregister on reboot

0 No 1 Yes

accountname=ltstringgt Account name maximum 127 Bytes sipserver=ltstringgt SIP server maximum 255 Bytes proxyserver=ltstringgt Proxy server domain or IP address userid=ltstringgt SIP user ID maximum 255 Bytes authenticateid=ltstringgt Authenticate ID

Could be the same or different wi th SIP UserID maximum 127 Bytes

accountpassword=ltstringgt Account password maximum 127 Bytes

Only used for setting password not for acquiring password

stunserver=ltstringgt STUN server URI or IP PORT maximum 127 Bytes

sipstream=ltintgt 0 1 0 Secondary 1 Primary

audioencoder=ltintgt 0 1 0 PCMU 1 PCMA Default is 0 PCMU

regexpiration=ltintgt Default is 3600 (in second) maximum 45 days localsipport=ltintgt Local SIP port

Default is 5060 localrtpport=ltintgt 1024-30000 Local RTP port 1024~30000 autohooktimer=ltintgt 0-65535 Auto hook timer in second

0 Never onhook Default is 0

disable_audio=ltintgt 0 1 0 No 1 Yes

enable_keep_alive=ltintgt 0 1 0 No 1 Yes

direct_ip_call=ltintgt 0 1 0 No 1 Yes

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 20 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

sip_proxy_compatibility_mode=ltintgt

01 SIP Server Compatibility 0 ndash No 1-Yes means compatible to more SIP servers but may consume more network bandwidth

enable_white_list=ltintgt 0 1 0 No 1 Yes

sipdoorenable=ltintgt 0 1 Enable SIP open door 0 No 1 Yes

sipdoorpwd=ltstringgt Number 0 to 9

SIP open door password Valid length 1 to 8 numeric digits

sipdoortime=ltintgt Open door timer (timer before relay reset) accessuploadaudiofile=ltintgt 01 Chek uploaded audio file existence

0-No (not exist) 1-Yes (exist only GET)

tel_uri=ltintgt 012 TEL URI 0 forbidden 1 User=Phone 2 Enable

sip_enable_tls=ltintgt 012 SIP Transport Method 0 UDP 1 TCP 2 TLSTCP

sip_tls_certificate=ltstringgt SIP TLS Certificate (maximum 8192 byte) sip_tls_private_key=ltstringgt SIP TLS Key (maximum 8192 byte) sip_tls_private_key_password

t i SIP TLS Key Password

accesstlscrtfile=ltintgt 01 Check TLS Certificate existence 0 Not exist 1 Yes (exist only GET)

accesstlskeyfile=ltintgt 01 Check TLS Key Existence 0 Not exist 1 Yes (exist only GET)

Support cmd = uploaddel Uploaddelete self-defined audio files TLS certificate and TLS keys Will take effect upon next reboot

file_type=ltintgt 012 UploadDel file 0 ndashself defined file 1- SIP TLS certificate 2 - SIP TLS private key 0 - Default No file_type

eg

http192168866goformsipcmd=del (delete uploaded files)

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 21 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Support cmd = addremoveget Phonebook settings

ltparametergt=ltvaluegt Values Description phonecount=ltintgt Total phonebook entries phoneindex=ltintgt 1 2hellip Index of phonebook entries phonenumber=ltstringgt Phone number maximum 15 Bytes phonename=ltstringgt NameNote of phone number max 127 Bytes white_list_phone=ltstringgt Phone numbers of incoming call white list audio_warning_mode=ltintgt 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 entries could be added one at a time

Example Add phone number http192168866goformsipcmd=addampphonename=6006ampphonenumber=5003

200 OKrn Successful Need Rebootrn

Example (URL) Notes http1921688919goformsipcmd=setampunregister=1ampaccountname=xkowenampsipserver=19216889207ampuserid=3028ampauthenticateid=3028ampaccountpassword=123456

http1921688919goformsipcmd=addamp white_list_phone=2222

http1921688919goformsipcmd=removeamp white_list_phone=222233334444

Delete phone numbers in

white list

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 22 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

6 Date amp Time

Support cmd = setget

httpltservernamegtgoformdate_timecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description updatemode=ltintgt 1-2 Update mode

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

year=ltintgt Greater than 1900 Current year month=ltintgt 1-12 Current month day=ltintgt 0-31 Current day hour=ltintgt 0-23 Current hour minute=ltintgt 0-59 Current minute second=ltintgt 0-59 Current second timezone=ltintgt 1-54 1 GMT-12 (EniwetokKwajalein)

2 GMT-11 (Midway Isl Samoa) 3 GMT-10 (Hawaii Aleutians) 4 GMT-09 (Alaska) 5 GMT-08 (Las Vegas San Francisco 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 (Brazil 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)

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 23 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

23 GMT+03 (Moscow Riyadh) 24 GMT+03 (Iraq) 25 GMT+0330 (Iran) 26 GMT+04 (Abu Dubai Baku) 27 GMT+0430 (Kabul) 28 GMT+05 (Islamabad Karachi Tashkent) 29 GMT+0530 (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+0930 (Adelaide Darwin) 35 GMT+10 (Hobart) 36 GMT+10 (Canberra Melbourne Sydney) 37 GMT+11(Solomon Island) 38 GMT+12(Auckland Wellington) 39 GMT-900 Daylight Saving Time (Alaska Time) 40 GMT-800 Daylight Saving Time (Pacific Time) 41 GMT-700 Daylight Saving Time (Mountain Time) 42 GMT Daylight Saving Time (Dublin Ireland ) 43 GMT Daylight Saving Time (Lisbon Portugal) 44 GMT Daylight Saving Time (London Great Britain) 45 GMT+100 Daylight Saving Time(Amsterdam Barcelona Berlin Brussels Budapest Copenhagen) 46 GMT+100 Daylight Saving Time(Geneva Madrid Oslo Paris Prague Roma Stockholm) 47 GMT+200 Daylight Saving Time (Athens Helsinki Kyiv Tallinn) 48 GMT+300 Daylight Saving Time (Moscow) 49 GMT+300 Daylight Saving Time (St Petersburg)

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 24 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

50 GMT+930 Daylight Saving Time(Adelaide) 51 GMT+1000 Daylight Saving Time(Melbourne Canberra Sydney) 52 GMT+1000 Daylight Saving Time(Hobart) 53 GMT+1200 Daylight Saving Time(Auckland Wellington) 54 Using self-defined Time Zone

deftimezone=ltstringgt Self-defined Time Zone

For example EST+5EDT+4M320M1110 Valid Only when timezone= 54 (Using self-defined Time Zone)

ntpserverenable=ltintgt 0 1 Enable NTP server 0 No 1 Yes ntpserver=ltstringgt NTP server max 255 Bytes

datestyle=ltintgt 1 2 3 OSD date format 1 YYYY-MM-DD 2 MMDDYYYY 3 DD MM YYYY

ntpupdateinterval=ltintgt 5-1440 NTP Update Interval(minutes) Default1440

enable_dst=ltintgt 01 Use Day Light Saving Time 0 ndash No 1-Yes

dst_str=ltstringgt DST Format must in following format GMT+0500GDT+0400M320020000M1110020000 NOTE GMT+0500 current zone must be one of following starting with rdquoGMTrdquo GMT+1200 GMT+1100 GMT+1000 GMT+0900 etc

MDT+0400 Start DST MUST start with MTZ eg M320020000M1110020000 Start M320020000 means 2nd Sun of March 20000 AM

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 25 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example

http192168866goformdate_timecmd=setampupdatemode=1ampyear=2902ampmonth=9ampday=26amphour=22ampminute=22ampsecond=33amptimezone=54ampdeftimezone=MTZ+6MDT+5M410M11111ampntpserver=timenistcom

200 OKrn Successfulrn

NOTE Parameter updatemode is required in each link

Example http192168866goformdate_timecmd=setampupdatemode=1ampyear=2902ampmonth=9ampd

ay=26amphour=22ampminute=22ampsecond=33amptimezone=54ampdeftimezone=EST+5EDT+4M3 20M11111ampntpserver=timenistcom

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 26 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

7 Status

Support cmd = getset (cmd=set can only be used by devicename)

httpltservernamegtgoformsysteminfocmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description productmode=ltstringgt HIS

GXV3504

GXV3601HD

GXV3611_HD GXV3615W

TI GXV3500 GXV3651FHD GXV3662_HDFHD GXV3615WP_HD GXV3611IR_HD GXV3610_HDFHD GXV3672_HDFHD GXV3672_HDFHD_36 GXV3674_HDFHD_VF

Device model may vary

hardwareversion=ltstringgt V02B Hardware version partnumber=ltstringgt PN number bootloaderversion=ltstringgt BOOTLOADER version coreversion=ltstringgt Core version baseversion=ltstringgt Base version firmwareversion=ltstringgt 0-59 Firmware version cameratype=ltstringgt Camera type brand and model ddnsstate=ltintgt 0 1 2 3 4 5 6 DDNS Status

0 Disable 1 Processing 2 Success 3 AccountPassword Error 4 Server blocking 5 Stun Server error 6 Database failed

wifistate=ltintgt 0 1 Wi-Fi Status 0 Disconnected 1 Connected

systemrun=ltstringgt System up time mac=ltstringgt MAC Address

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 27 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

ledstatus=ltintgt 0 1 LED Status( GXV3615 series Only ) 0On 1Off

pppoeip PPPoE IP Default is 0000 pppoestatus 0 1 PPPoE status

0 disconnected 1 connected

ipaddress For display only subnetmask For display only defaultgateway For display only Ircutstatu=ltintgt 12 IR cut1-daytime 2-evening

8 Account Management

Support cmd = addremovesetget

httpltservernamegtgoformusermanagecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description usercount=ltintgt gt=1 Total user numbers userindex=ltintgt 1 2hellip Index of users userlevel=ltintgt 0 1 2 User Privilege

0 administrator 1 user 2 anonymous

username=ltstringgt User name max 23 Bytes userpassword=ltstringgt User password max 63 Bytes anonymousenable =ltintgt 0 1 Allow anonymous login

0 No 1 Yes

Example http1921688943goformusermanagecmd=removeampusername=name 200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 28 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

9 SMTP (E-mail) Settings

Support cmd = setget

httpltservernamegtgoformsmtpcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description enablesmtp=ltintgt 0 1 Enable SMTP

0 No 1 Yes

smtpserver=ltstringgt SMTP Server max 255 Bytes smtpserverport=ltintgt SMTP Server port emailfrom=ltstringgt From E-Mail address max 63 Bytes emailuser=ltstringgt E-mail user name max 63 Bytes emailpassword=ltstringgt E-mail password max 63 Bytes emailto1=ltstringgt To E-Mail address 1 max 63 Bytes emailto2=ltstringgt To E-Mail address 2 max 63 Bytes emailto3=ltstringgt To E-Mail address 3 max 63 Bytes enablessl=ltintgt 0 1 Use SSL

0 No 1 Yes

smtptest=ltintgt 1 To test SMTP uses smtptest=1 Other value does not work Return smtptestresult = 0 test failed with smtp error message smtptestresult = 1 test success

selfdefine_email_title= ltstringgt

Self defined email subject

selfdefine_email_content= ltstringgt

Self defined email content

Example Set SMTP parameters When enablesmtp=1 the Email address format will be checked http1921688666goformsmtpcmd=setampenablesmtp=0

(when enablesmtp=1 basic check will be performed to all the addresses) 200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 29 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

10 FTP Settings

Support cmd = setget httpltservernamegtgoformftpcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description enableftp=ltintgt 0 1 Enable FTP

0 No 1 Yes

ftpserver=ltstringgt FTP server max 255 Bytes ftpserverport=ltintgt FTP server port ftpuser=ltstringgt FTP user name max 23 Bytes ftppassword=ltstringgt FTP password it would not be sent along with

parameters maximum 63 Bytes ftppath=ltstringgt FTP path max 63 Bytes ftptest=ltintgt 1 To test FTP use ftp test =1

Other values do not work

Return ftptestresult = 0 test failed with ftp error message ftptestresult = 1 success

Example Set FTP parameters http192168866goformftpcmd=setampftpserver=123456ampftpserverport=111ampftpuser=a dminampftppath=admin

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 30 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

11 PTZ Settings (Only for GXV3500 and GXV3504)

Support cmd = setget (Only apply to GXV3504 and GXV3500)

httpltservernamegtgoformptzcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description protocol=ltintgt 0 1hellip Select PTZ Protocol

0 PELCO-P 1 PELCO-D

channel=ltintgt 0-3 (Pending) baudrate=ltintgt 1200 2400 4800

9600hellip Baud rate May vary among different device or models

ptzparam=ltintgt 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=ltintgt 0 1hellip PTZ Control 0 Stop 1 Tilt Up 2 Tilt Down 3 Pan Left 4 Pan Right 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

addressid1=ltintgt 0-255 Channel 1 location (PTZ only) default 0

Addressid2=ltintgt 0-255 Channel 2 location (GXV3504) default 1

Addressid3=ltintgt 0-255 Channel 3 location (GXV3504) default 2

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 31 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Addressid4=ltintgt 0-255 Channel 4 location (GXV3504) default 3

Msgtype=ltintgt 01hellip Transmission Type 1- Transparent passing value 2- Other - TBD

Class=ltintgt Op Type 0- Not defined 1- Patrol Scan 2- Pattern Scan 3- Loop across preset

positions Group=ltintgt 0- not defined

1-8 Patrol 1-4 Pattern Scan 1-8 Loop across preset positions

Id=ltidgt Can be ID in database or chip

action_type=ltintgt Action type 1- not defined 2- predefined 3- pattern scan 4- loop across preset positions

action_id=ltintgt Action ID 0 not defined 1-128 predefined 1-8 patrolling 1-4 pattern scan 1-8 loop across preset positions

action_time=ltintgt Operation time in second Group patrolling 1-240s

action_speed=ltintgt 0-128 Speed patrolling among preset positions 1-90 degrees

swing_start_id=ltintgt 1-128 Start position of patrolling

swing_end_id =ltintgt 1-128 Stop position of patrolling

oprate_type=ltintgt

Op command 0- no op 1- tuning 2- stop 3- add 4- edit 5- start record 6- stop record 7- delete record 8- delete classified data

enable_proportional_pan=ltintgt 01 Enable proportional pan

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 32 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

enable_preset_freezing=ltintgt 01 Enable preset freezing

preset_speed=ltintgt 1-8 Preset speed

keyboard_controlpeed=ltintgt 1-3 Keyboard control speed

auto_scan_speed=ltintgt 1-20 Auto scan speed

zoom_status=ltintgt 0-11 Zoom status 0-always close 1-always open

pt_status=ltintgt 0-11 PT Angel 0 ndash close 11- open

preset_status=ltintgt 0-11 Preset title 0- close 11-open

set_resume_time_point=ltintgt 0-600 Set resume time 0-disable

enable_limit=ltintgt 01 Enable Limit

limit_type=ltintgt 0-1 Limit type

limit_type_status=ltintgt 0-1 Limit type status

enable_park_action=ltintgt 01 Enable parking action

park_time=ltintgt 1-10 Parking action time 1min-4hr

park_action_type=ltintgt 0-4 Park action type 0- start 1- preset 2- Patrolling scan 3- Pattern scan 4- Group patrolling Define origin 0-horizon 0-vertical

park_action_type_id=ltintgt 1-8 Park action type ID

enable_scheduled_task=ltintgt 01 Enable scheduled task

scheduled_task_park_time =ltintgt

1-10 Schedule park time

Example Set PTZ parameter http1921688666goformptzcmd=setampptzcontrol=4ampptzparam=31 (rotation and speed have to be used together)

200 OKrn Successfulrn Note ptzcontrol and ptzparam both have to be included in the link

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 33 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

12 Alarm Event

Support cmd = setgetaddremove

httpltservernamegtgoformalarmiocmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description alarmincount=ltintgt 0 1 4hellip Numbers of alarm input

supportted by devices

Vary among models eg IP camera only supports 1 alarm input

GXV3504 supports 4

alarminindex=ltintgt 0 1 2 3 Index of alarm input alarminschedulecount=ltintgt 0 1hellip Numbers of schedules alarminscheduleid=ltintgt 1 2 3hellip ID of schedules alarminscheduledayset=ltintgt 0-7 0 Sunday

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

alarminschedulestarttime=ltintgt 0-86399 Default is 0 (in seconds) Example 1239 starttime = 123600+3960

alarminscheduleendtime=ltintgt 0-86399 Alarm event end time Default is 86399

(in seconds) alarmoutstop=ltstringgt yes Stop alarm output eventrecordpretime=ltintgt 0-160

(videoprimarybitratelt256) 0-100 (videoprimarybitratelt512) 0-50 (videoprimarybitratelt1024) 0-25 (videoprimarybitrategt1024)

Record Video from Pre-Alarm (in seconds) The range varies among different bitrate

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 34 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

eventrecordaftertime=ltintgt 0-320 (videoprimarybitratelt256) 0-200 (videoprimarybitratelt512) 0-100 (videoprimarybitratelt1024) 0-50 (videoprimarybitrategt1024)

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

eventrecordstorage=ltintgt 1 2hellip Alarm record storage method 0 Do not save 1 SD card 2 USB Flash Drive 3 DISK (This may not be available for some device models)

eventrecorduploadftp=ltintgt 0 1 Record Video uploads to FTP Server 0 disable 1 enable

eventsipphoneenable=ltintgt 0 1 Voice Alarm to SIP phone 0 disable 1 enable

eventalarmoutenable=ltintgt 0 1 EnableDisable alarm output 0 disable 1 enable alarm in 1 corresponds alarm out 1 alarm in 2 corresponds alarm out 2 helliphellip

eventuploadcenterenable=ltintgt 0 1 Upload to Alarm Center This option has to be enabled for PC to receive alarm event notification 0 disable 1 enable

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 35 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

eventshotemailenable=ltintgt 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

event_upload_to_alarm_server =ltintgt

01 Upload HTTP alarm server

event_snapshot_prenum=ltintgt 1-5 Snapshot pre number (most)

event_snapshot_endnum=ltintgt 1-5 Snapshot end number (most)

Example Parameter settings

http192168866goformalarmiocmd=addampalarminindex=0ampeventrecordpretime=20 ampeventrecordaftertime=10ampeventrecordstorage=1ampeventrecorduploadftp=1ampeventsip phoneenable=1ampeventalarmoutenable=1ampeventuploadcenterenable=1ampeventshotem ailenable=1

HTTP10 200 OKrn Successfulrn

Add a schedule with rdquoEverydayrdquo as default http192168866goformalarmiocmd=addamp alarminindex=0 HTTP10 200 OKrn Successfulrn

http192168866goformalarmiocmd=addampalarminindex=0ampalarminscheduledayset =4amp alarminschedulestarttime=200amp alarminscheduleendtime=40000

HTTP10 200 OKrn Successfulrn

Delete a schedule with id=111 http192168866goformalarmiocmd=removeampalarminscheduleid =11123hellip

HTTP10 200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 36 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Sample URLs http192168866goformalarmiocmd=get

http192168866goformalarmiocmd=setampalarminindex=0ampeventrecordpretime=10ampeventrecordaftertime=20ampeventrecordstorage=0ampeventrecorduploadftp=0ampeventsipphoneenable=0ampeventalarmoutenable=0ampeventuploadcenterenable=0ampeventshotemailenable=0

http192168866goformalarmiocmd=setampalarminindex=0ampeventrecordpretime=20ampeventrecordaftertime=10ampeventrecordstorage=1ampeventrecorduploadftp=1ampeventsipphoneenable=1ampeventalarmoutenable=1ampeventuploadcenterenable=1ampeventshotemailenable=1

http192168866goformalarmiocmd=setampeventrecordpretime=10ampeventrecordaftertime=20

http192168866goformalarmiocmd=add http192168866goformalarmiocmd=addampalarminindex=0 http192168866goformalarmiocmd=addampalarminindex=0ampalarminscheduledayset=4ampalarminschedulestarttime=200ampalarminscheduleendtime=40000 http192168866goformalarmiocmd=addampalarminindex=0ampalarminscheduledayset=4amp alarminschedulestarttime=9999ampalarminscheduleendtime=999999999 http1921688695goformalarmiocmd=removeampalarminscheduleid=0 http1921688695goformalarmiocmd=removeampalarminscheduleid=1

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 37 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

13 Motion Detection

Support cmd = addremovesetget

httpltservernamegtgoformmotiondetectcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description mdchannelcount=ltintgt 1 4 Number of channels for

motion detection IP camera on ly has 1 channel GXV3504 support 4 channels

mdchannelindex=ltintgt 0 1 2 3 Corresponding index for channels IP camera 1 4 channel GXV3504 0-3

mdactiveenable=ltintgt 0 1 Enable Motion Detection 0 No 1 Yes

mdregnindex=ltintgt 0-15 Motion Detection Region 0-15

mdregnleftup=ltintgt First 2 bytes used for X Last 2 bytes used for Y

mdregnrightdown=ltintgt First 2 bytes used for X Last 2 bytes used for Y If mdregnleftup=0 and mdregnrightdown=0

It means invalid region mdregnsensitivity=ltintgt 0-100 Sensitivity

The higher the value the better the sensitivity

mdregnschedulecount=ltintgt 0 1hellip Total number of schedule

mdregnscheduleid=ltintgt 0 1 2 3hellip Schedule ID (1-n) If ID is set to 0

all the schedules will

be deleted

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 38 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

mdregnscheduledayset=ltintgt 0-7 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday 7 Everyday(default)

mdregnschedulestarttime=ltintgt 0-86399 Default is 0 (in seconds) Example 1239 starttime = 123600+3960

mdregnscheduleendtime=ltintgt 0-86399 Default is 86399 (in seconds) Example 1239 starttime = 123600+3960

mdrecordstorage=ltintgt 0 1 2 3hellip Alarm record storage method 0 Do not save 1 SD card 2 USB Flash Drive 3 DISK (Some models Not applicable)

eventrecordpretime=ltintgt 0-160 (videoprimarybitratelt256) 0-100 (videoprimarybitratelt512) 0-50 (videoprimarybitratelt1024) 0-25 (videoprimarybitrategt1024)

Record Video from Pre-Alarm (in seconds) This may vary among different bitrates

mdrecordaftertime=ltintgt 0-320 (videoprimarybitratelt256) 0-200 (videoprimarybitratelt512) 0-100 (videoprimarybitratelt1024) 0-50 (videoprimarybitrategt1024)

Record Video to

Post-Alarm (in seconds)

This may vary among different bitrates

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 39 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

mdrecorduploadftp=ltintgt 0 1 Record Video and upload to FTP Server 0 enable 1 disable

mdsipphoneenable=ltintgt 0 1 Voice Alarm to

SIP Phone 0 enable 1 disable

mdalarmoutenable=ltintgt 0 1 EnableDisable alarm output 0 enable 1 disable alarm in 1 corresponds alarm out 1 alarm in 2 corresponds alarm out 2

mduploadcenterenable=ltintgt 0 1 Upload to Alarm Center This option has to be enabled for PC to receive alarm event notification 0 enable 1 disable

mdsnapshotenable=ltintgt 0 1 Email snapshot and store it to USB card or SD drive

md_upload_to_alarm_server=ltintgt 01 Upload to HTTP alarm server

md_snapshot_prenum=ltintgt 1-5 Snapshot pre number

(maximum)

md_snapshot_endnum=ltintgt 1-5 Snapshot post number

(maximum)

md_retrigger_interval=ltintgt 1-60 MD Alarm trigger interval (seconds)

Default 1 md_trigger_interval=ltintgt 0-5 Minimum Interval of valid

Motion Detection (second) Default 0 ~ Auto

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 40 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example

Parameter settings Delete a schedule which has id=1 http192168866goformmotiondetectcmd=setampmdrecordstorage=1ampmdrecordafter time=10ampmdrecordpretime=20ampmdrecorduploadftp=1ampmdsipphoneenable=1ampmdala rmoutenable=1ampmduploadcenterenable=1ampmdsnapshotenable=1

HTTP10 200 OKrn Successfulrn

Example (URL) Remark http192168866goformmotiondetectcmd=setampmdactiveenable=2

http192168866goformmotiondetectcmd=setampmdregnindex=0ampmdregnleftup=1amp

http192168866goformmotiondetectcmd=setampmdregnindex=0ampmdregnleftup=1amp

http192168866goformmotiondetectcmd=setamprecordstorage=0

http192168866goformmotiondetectcmd=setampmdrecordstorage=2ampmd

recordaftertime=30ampmdrecordpretime=10ampmdrecorduploadftp=0ampmdsipp

honeenable=0ampmdalar

http192168866goformmotiondetectcmd=setampmdrecordstorage=1ampmd

recordaftertime=10ampmdrecordpretime=20ampmdrecorduploadftp=1ampmdsipp

honeenable=1ampmdalar

http192168866goformmotiondetectcmd=removeampmdregnscheduleid=

http192168866goformmotiondetectcmd=add

http192168866goformmotiondetectcmd=addampmdregnindex=1

http192168866goformmotiondetectcmd=addampmdregnindex=1

http192168866goformmotiondetectcmd=addampmdregnindex=1ampmd channelindex=

192168866goformmotiondetectcmd=setampmdregnindex=0ampmdregn leftup=0ampmdregnrightdown=0ampmdregnsensitivity=1

Delete Alarm Region

Support cmd= get_md_statu

httpltservernamegtgoform motiondetectcmd= get_md_statu

ltparametergt=ltvaluegt Values Description

md_alarm_statu =ltintgt 01 MD Alarm State 0 No Alarm 1 Alarming now

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 41 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

14 System Log

Support cmd = setget

httpltservernamegtgoformsystemlogcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description logserver=ltstringgt Syslog server max 127

Bytes loglevel=ltintgt 0 1 2 3 4 Syslog level

0 NONE 1 DEBUG 2 INFO 3 WARNING 4 ERROR

Example

http192168866goformsystemlogcmd=setamploglevel=1amplogserver=12345464

200 OKrn Successful Need Rebootrn

Example (URL) Remark http192168866goformsystemlogcmd=get http192168866goformsystemlogcmd=setamploglevel=1amplogserver=12345464 http192168866goformsystemlogcmd=setamploglevel=6amplogserver=12345464

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 42 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

15 Live Storage (Only for Supported Models)

Support cmd = removegetformat

httpltservernamegtgoformstoragecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description storagecount=ltintgt 0hellip Total storage equipment

storageindex=ltintgt 1 101 201 1 USB 101 SD 201 DISK

storagecapacity=ltstringgt Total storage capacity storageusedspace=ltstringgt Used space (MB)

storagefreespace=ltstringgt Free Space (MB)

filecount=ltintgt Total number of saved files fileindex=ltintgt 1 2 3 File index filesize=ltstringgt File size (MB) filename=ltstringgt 1921688620_chn0_

2011_09_21_14_43_48jpg

0_2_2011_09_21_13_32 _21_1718_1avi

Filename with the file path can be used to download the file eg httpserverhostportfilename

Image file format ip_channel_date_timejpg AVI file format channel_recordtype_date_time_ filelength_endmarkavi

storage_type=ltintgt 1 2 3 When formatting the storage device use the storage type to specify 1 Flash USB 2 SD Card 3 USB Disk (Reserved)

Example http1921688695goformstoragecmd=removeampstorageindex=101

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 43 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

16 MaintenanceUpgrade

Support cmd = setget httpltservernamegtgoformmaintenancecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description restart=ltstringgt yes Restart the device restore=ltstringgt yes Reset to factory default

updateviatype=ltintgt 1 2 3 Upgrade via 1 TFTP 2 HTTP 3 HTTPS

upgradeserverpath=ltstringgt serverhostportdir Firmware server path upgradecfgserverpath=ltstringgt serverhostportdir Configuration server path

maximum 255 Bytes upgrade_cfg_xml_pwd=ltstringgt XML config file password upgradeautomatic=ltintgt 0 1 Automatic upgrade

0 No 1 Yes

upgradeinterval=ltintgt 60-525600 Automatic upgrade interval (in minutes)

dhcp_option_66=ltintgt 01 0- disable 1- enable DHCP option 66

3cx_auto_provision=ltintgt 01 0- disable 1- enable 3CX auto configure

disable_telnet=ltintgt 01 0- disable (Default) 1- enable Telnet Access

enable_upnp=ltintgt 01 0- disable 1- enable UPnP Discovery

(Default)

Example

Set maintenance and upgrading parameters http192168866goformmaintenancecmd=setampupgradeserverpath=192168861

200 OKrn Successfulrn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 44 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

17 Contrast Saturation Brightness and Chroma

Support cmd = setget

httpltservernamegtgoformvideocontrolcmd=ltvaluegtampltparametergt=ltvaluegt NOTE

Contrast Saturation Brightness have to be set at the same time

Otherwise would be 0 (default) Color may not be available for some models

ltparametergt=ltvaluegt Values Description channel=ltintgt 0 1 2 3 Assigned channel

number Default number for IP Camera is 0

brightness=ltintgt 0-255 (For GXV3504) 0-60 (For GXV36153615W)

0-5 (For GXV3601HD3611HD)

0-255 (For GXV3651FHD

GXV3662 GXV3500

GXV361036723674

GXV3611IR_HD)

Brightness

contrast=ltintgt 0-255 (For GXV3504) 0-7 (For GXV36153615W)

0-3 (GXV3601HD3611HD)

0-255 (For GXV3651FHD

GXV3662 GXV3500

GXV361036723674

GXV3611IR_HD)

Contrast

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 45 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

saturation=ltintgt 0-1255 (For GXV3504) 0-63 (For GXV36153615W)

0-8 (For GXV3601HD3611HD)

0-255 (For GXV3651FHD

GXV3662 GXV3500

GXV361036723674

GXV3611IR_HD)

Saturation

Default=ltintgt 3 4 3 set default value 4 set color-enhancement default value (For GXV3601HD and GXV3611HD only)

Example http192168866goformvideocontrolcmd=setampcontrast=101

200 OKrn Successfulrn

Example (URL) http192168866goformvideocontrolcmd=get

http192168866goformvideocontrolcmd=setampcontrast=101ampbrightness=101ampsaturation=101

http192168866goformvideocontrolcmd=setampcontrast=101

http192168866goformvideocontrolcmd=setampcontrast=101234ampbrightness=101ampsaturation=101

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 46 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

18 WIFI Settings (Only for Supported Models) Support cmd = setgetsearch

httpltservernamegtgoformwirelesscmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description wifiexist=ltintgt 0 1 This is only applicable on GXV3615W and

GXV3615WP_HD 0 WIFI is not supported 1 WIFI is supported

enable=ltintgt 0 1 0 Disable 1 Enable

ssid=ltstringgt SSID authentication=ltintgt 0-6 Security Mode

0NONE 1WEPShared 2WEPOpen 3WPA PSK TKIP 4WPA PSK AES 5WPA2 PSK TKIP 6WPA2 PSK AES

keyindex=ltintgt 1-4 Key index key=ltstringgt Encryption Key

Example Setting WIFI parameter http192168866goformwirelesscmd=setampssid =mywifi

200 OKrn Successful Need Rebootrn

Example (URL) Remark

http192168866goform wirelesscmd=get http192168866goformwirelesscmd=setampssid=widampenable=1ampkeyindex=1ampkey=1234567890

http192168866goformwirelesscmd=search Return Result searchssidindex=1 searchssid=labtest(31) searchssidindex=2 searchssid=LINKSUM(26) searchssidindex=3 searchssid=YYGD(7)

Return wifi ssid List

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 47 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

19 System Settings

Support cmd = setgetsearch

httpltservernamegtgoformdevicecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description devicename=ltstringgt Device name channel=ltintgt 0-3 Channel number alarmintype=ltintgt 01 0Normal Open 2

1Normal Close alarmouttype=ltintgt 01 0Normal Open

1Normal Close alarminstatus=ltintgt 01 Used to get the current status of the alarm in

0 Open 1 Close

alarmoutstatus=ltintgt 01 Used to get the current status of the alarm out 0 Open 1 Close

alarm_output_time=ltintgt 0 515 30 60180 300600 9001800

0 keep alarm until manually turned off N alarm off after N seconds

Example 1 Setting alarm active state http192168866goformdevicecmd=setampalarmouttype=1

200 OKrn Successful rn

2 ldquoNormal Openrdquo and ldquoNormal Closerdquo are respectively refer to the initial Alarm_In or Alarm_Out interface the circuit is normally or initially at ldquoOpenrdquo circuit or at ldquoCloserdquo circuit This could be different based on the 3rd party device (eg Door Strike Siren etc) Please refer to the User Manual of the 3rd party device to configure correctly the Input or Output interface of Grandstream device (IP Camera or Encoder)

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 48 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example 2

Alarm Type Alarm Status Result alarmouttype= NORMAL OPEN

alarmoutstatus=OPEN IDLE no alarm output

alarmouttype= NORMAL OPEN

alarmoutstatus=CLOSE alarm output enabled

alarmouttype= NORMAL CLOSE

alarmoutstatus=OPEN alarm output enabled

alarmouttype= NORMAL CLOSE

alarmoutstatus=CLOSE IDLE no alarm output

alarmintype= NORMAL OPEN

alarminstatus=OPEN IDLE no alarm input

alarmintype= NORMAL OPEN

alarminstatus=CLOSE alarm input detected

alarmintype= NORMAL CLOSE

alarminstatus=OPEN alarm input detected

alarmintype= NORMAL CLOSE

alarminstatus=CLOSE IDLE no alarm input

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 49 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

20 PPPoE Settings

Support cmd = setget

httpltservernamegtgoformpppoecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description pppoeuser=ltstringgt PPPoE username password=ltstringgt PPPoE password

(Not show when using get) pppoestatus=ltintgt 0 1 PPPoE status (read only)

0 disconnected 1 connected

pppoeip=lt string gt PPPoE IP (read only)

Example Set PPPoE parameter http192168866goformpppoecmd=setampalarmouttype=1

200 OKrn Successful rn

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 50 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

21 Snapshot

httpltservernamegtsnapshotview0jpg

ltparametergt=ltvaluegt Values Description view0jpg view1jpg view2jpg view3jpg view4jpg view5jpg view6jpg view7jpg

Capture view0jpg in primary stream Capture view4jpg in 2nd stream Capture view0jpg ndash view7jpg in 4 channels with 1st and 2nd stream respectively (GXV3504 Only)

Example Capture a snapshot httpltservernamegtsnapshotview0jpg

Capture a snapshot of 2nd stream

http19216886146snapshotview4jpg

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 51 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

22 Web GUI Language

httpltservernamegtgoformlanguagecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description language=ltintgt 0 1 2 0 English (default)

1 Chinese (Simplified) 2 Russian

Example httpltservernamegtgoformlanguagecmd=setlanguage=1

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 52 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

23 Decode Settings (For GXV3500 Only)

httpltservernamegtgofromdecodecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description decode_source=ltintgt 0 1 Decode source

0RTSP 1SIPphone

default_decode=ltintgt 0-7 Default decode channel enable_patrol=ltintgt 0 1 Enable patrol

0Disable 1Enable

video_ouput_type 0-3 0Auto or NTSC 1Auto or PAL 2NTSC 3PAL

start_patrol=ltintgt 0 1 Start patrol 0 Stop patrol 1 Start patrol

channel[i]=ltintgt 0-4 Video channel Use i=0-7 to specify the 8 patrol decode devices

port[i]=ltintgt Port i=0-7 time[i]=ltintgt i=0-7 host[i]=ltstringgt i=0-7 user[i]=ltstringgt i=0-7 password[i]=ltstringgt i=0-7 description[i]=ltstringgt i=0-7

Example httpltservernamegtgoformdecodecmd=setchannel=1

Example (URL) Remark http19216886146 goformdecodecmd=setchannel=1 Set channel 1

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 53 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

24 Stream Acquiring (MJPEG Only)

httpltservernamegtgofromstreamcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description channel=ltintgt 0-7 For IP Camera the primary is 0 (default is 0)

2nd stream is 4 For GXV3504 the channel number and streams mapping is equal to n+4

Example http1921688625goformstreamcmd=getampchannel=0

http1921688625goformstreamcmd=getampchannel=4

NOTE This streaming acquiring command only works when the video codec is configured using

MJPEG For IP Cameras the primary stream is using digit ldquo0rdquo the 2nd stream is using digit ldquo4rdquo

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 54 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

25 CMOS Settings (Only for Supported Models)

Support cmd = setget NOTE This setting only applies to GXV3500 GXV3651FHD GXV3662 GXV3615WP_HD

GXV3610 GXV3672 GXV3674 GXV3611IR_HD models

httpltservernamegtgoformcmoscmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description flip=ltintgt 0 1 0off

1on lris=ltintgt 0 1 2 IRIS setting

0 Mech_Manual 1 DC_Auto 2 DC_Manual

iris_open=ltintgt 1 2 3 4 5 IRIS aperture open range 1100 280 360 440 520

up_bias=ltintgt 6000-11000 IRIS aperture bias up range Default value is 8160 (For GXV3662HD only)

down_bias=ltintgt 6000-11000 IRIS bias down range Default value is 8150 (For GXV3662HD only)

shutter_speed=ltintgt 0 30 60 125 250 500 1000

Shutter speed 0Auto N1N

ir_cut_setting=ltintgt 0 123 IR CUT setting 0 Manual_Mode 1 Automatic_Mode (IR sensor control) 2 Autotatic Mode (Algorithm control) 3 Time Schedule Mode

daytime_start=ltintgt 0-86399 Only for Time Schedule Mode (second) eg 1239 start time is 123600 + 3960 default is 0

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 55 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

daytime_end=ltintgt 0-86399 Only for Time Schedule Mode (second) eg 1239 end time is 123600 + 3960 default is 0

ir_cut_sensitivity=ltintgt 1 2 3 4 5 IR_CUT sensitivity d_n_mod=ltintgt 0 1 DayNight mode

0 day 1 night

color_mod=ltintgt 0 1 2 Color mode 0 color 1 black-white 2 auto

ir_led_setting=ltintgt 012 V2 Model IR_LED control 0- Auto 1- On 2- Off

privacymask=ltstringgt Privacy Masks String GET Format dddddd eg IDEX1Y1X2Y2 SET Format 1 AEAX1AY1AX2AY2 BEBX1BY1BX2BY2 CECX1CY1CX2CY2DEDX1DY1DX2DY2 AE Region (A)

0 ndash disable 1 ndash enable

AX1 Region (A) X1 (0lt=X1lt=704) AY1 Region (A) Y1 (0ltY1lt=576) AX2 Region (A) X2 (0lt=X2lt=704) AY2 Region (A) Y2 (0ltY2lt=576) Region (BCD) same as Region (A) Format 2 IDEX1Y1X2Y2 ID Region ID E 0-disable 1-enable X1 x1(0lt=X1lt=704) Y1 y1(0ltY1lt=576) X2 x2(0lt=X2lt=704) Y2 y2(0ltY1lt=576)

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 56 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Example Set CMOS parameters http192168866goformcmoscmd=setamplris =1

200 OKrn Successful rn

Example (URL) Remark http192168866goform cmoscmd=get

http192168866goformcmoscmd=setamplris=1ampshutter_spee

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 57 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

26 4D1 Settings (For GXV3504 Only)

httpltservernamegtgofromfourdonecmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description enable=ltintgt 0 1 0 No

1 Yes ntscpaltype=ltintgt 0 1 0 PAL

1 NTSC Read only To identity the type for display

ptions=ltintgt 1-8 H264 14704480 2048kbps15fps

+ no secondary stream 24704480 1536kbps19fps + no secondary stream 34704480 1536kbps15fps + secondary stream 4QCIF (176112) 128kbps10fps 44704576 2048kbps13fps + no secondary stream 54704576 1536kbps16fps + no secondary stream 64704576 1536kbps10fps + secondary stream 4QCIF (176144) 128kbps10fps MJPEG 74704480 4096kbps15fps + no secondary stream 84704576 4096kbps13fps + no secondary stream

Example http1921688625goformfourdonecmd=get

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 58 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

27 Alarm HTTP Servers Settings

Support cmd=setget

httpltservernamegtgoformevent_servercmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description server_name=ltstringgt Server name server_url=ltstringgt Server URL server_username=ltstring gt Username server_user_password=ltstring gt Password

channel=ltintgt 0-4 Channel(GXV3504)

Example Set Alarm HTTP Servers parameters http192168866goformevent_servercmd=setampserver_name=servernameampserver_ur l=httphellip

200 OKrn Successful rn

Example (URL) Remark http192168866goformevent_servercmd=get http192168866goformevent_servercmd=setampserver_name=servernameampserver_url=ser

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 59 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

28 Record Settings Support cmd = setget

httpltservernamegtgoformsdrecordcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description channel=ltintgt 0-3 Channel number

(Single channel device could skip this)

state_record=ltintgt 0-4 0 No record 1 Manual record 2 Auto record 3 Alarm record 4 No storage device

enable_time_table=ltintgt 0 1 Enable record schedule 0 No 1 Yes

record_time_table=ltstringgt Record schedule This is a 168-character string with possible values 0 and 1 0 No 1 Yes

record_full_handle=ltintgt 1 2 When the record is full 1 Override the oldest record 2 Stop recording (Use channel 0 record only)

start_record=ltintgt 0 1 For record manually 3 0 Stop 1 Start Manual record will fail if auto-record or alarm-record has started already

Example Set Record parameters

http192168866goformsdrecordcmd=setamp channel =0amp enable_time_table =1amp record_time_table=010111hellip111

200 OKrn Successful rn

Example (URL) http192168866goformsdrecordcmd=get http192168866goformsdrecordcmd=setampchannel=0amp enable_time_table=1amprecord_time_table=010111hellip111

http192168866goformsdrecordcmd=setamprecord_full_handle=0

http192168866goformsdrecordcmd=setamp channel=0amprecord_start=1

3 This command is used for manually start or stop the recording It will fail if conflicting with pre-configured recording schedule or other events

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 60 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

29 Time Lapse Photography

Support cmd = setget

httpltservernamegtgoform periodic_snapshotcmd=ltvaluegtampltparametergt=ltvaluegt

ltparametergt=ltvaluegt Values Description

periodic_snapshot_enable=ltintgt 01 0-disable 1-enable

periodic_snapshot_interval=ltintgt 1-999 Periodic snapshot interval (minute）

periodic_snapshot_uploadsd =ltintgt 01 Save to SD card 0-No 1-Yes

periodic_snapshot_uploadftp =ltintgt 01 FTP upload0-No1-Yes

periodic_snapshot_uploademail =ltintgt

01 Email upload0-No1-Yes

Example

http192168866goformperiodic_snapshotcmd=setamp periodic_snapshot_enable =1amp periodic_snapshot_interva =30 200 OKrn Successful rn

Example (URL)

http192168866goformperiodic_snapshotcmd=get http192168866goformperiodic_snapshotcmd=setamp periodic_snapshot_enable =1amp periodic_snapshot_interva =30

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 61 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Table 1

Device Alarm Recording Time Table

Model Memory(M) Bit Rate(bps)

Pre_Record MaxTime (s)

Post_Record MaxTime (s)

Theoritical MaxTime(s)

GXV3662 GXV3651 GXV3601HD GXV3611HD

24 lt=512 100 200 384

lt=1024 50 100 192 lt=1536 45 60 128 lt=2048 30 60 96 lt=3072 20 40 64

lt=4096 15 30 48 lt=6144 10 20 32

gt6144 10 10 24 GXV3672HD 8 lt=512 50 70 128

lt=1024 20 40 64 lt=1536 15 25 42

lt=2048 10 20 32 lt=3072 5 15 21 lt=4096 5 10 16 lt=6144 4 5 10

gt6144 3 4 8 GXV3500 8 lt=256 90 120 256

lt=512 50 70 128 lt=1024 20 40 64 lt=1536 15 25 42

lt=2048 10 20 32 GXV3504 GXV3601HD GXV3611HD GXV3615(W) GXV3615WP_HD

24 lt=256 160 320 768

lt=512 100 200 384

lt=1024 50 100 192

lt=1536 45 60 128

lt=2048 30 60 96

Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 62 of 62 wwwgrandstreamcom Version 10054 Last Updated 102015

Table 1

Device Alarm Recording Time Table

Model Memory(M) Bit Rate(bps)

Pre_Record MaxTime (s)

Post_Record MaxTime (s)

Theoritical MaxTime(s)

GXV3610 GXV3672 GXV3674 GXV3611IR_HD

3 lt=512 15 25 48

lt=1024 10 10 24 lt=1536 5 8 16 lt=2048 5 5 12 lt=3072 3 3 8

lt=4096 2 3 6 lt=6144 1 2 4

gt6144 1 1 3 GXV3672HD 8 lt=512 50 70 128

lt=1024 20 40 64 lt=1536 15 25 42

lt=2048 10 20 32 lt=3072 5 15 21 lt=4096 5 10 16 lt=6144 4 5 10

gt6144 3 4 8