HTTP API
Contents
1. 0 1 2 3 Channel 0 3 motion detection channel 0 used Some parameters require assigned channel e g audio video setting and If no channel assigned the default For GXV3504 channel is 0 3 IP Camera no need to set this parameter Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 8 of 62 Last Updated 10 2015 Common URL Format GRANDSTREAM CONNECTIN Format Description Corresponding Format Devices with multiple channels GXV3504 will use channel number as separators when getting parameters All parameters organized by levels Index used as mark when multiple parameters with same level are applied e g 16 Motion Detection Regions in Channel 0 channel O0 r n lt param gt lt value gt r n channel 1 r n lt param gt lt value gt r n channel a r n lt param gt lt value gt r n channel 3 r n lt param gt lt value gt r n md regn index O r n lt param gt lt value gt r n md regn index 1 r n lt param gt lt value gt r n md regn index 2 r n lt param gt lt value gt r n md regn index 3 r n lt param gt lt value gt r n count and id used to differentiate unidentified parameters format at the same level e g Schedule of Motion Detect Region md regn schedule count 3 r n md regn schedule id 1 md regn index 0 md regn schedule dayset 7 md regn schedule starttime 0 md2. Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 53 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 25 CMOS Settings Only for Supported Models Support cmd set get NOTE This setting only applies to GXV3500 GXV3651FHD GXV3662 GXV3615WP HD GXV3610 GXV3672 GXV3674 GXV36111R HD models http lt servername gt goform cmos cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description flip lt int gt 0 1 O off 1 on lris lt int gt 0 1 2 IRIS setting 0 Mech_Manual 1 DC_Auto 2 DC_Manual iris_open lt int gt 1 2 3 4 5 IRIS aperture open range 1 100 2 80 3 60 4 40 5 20 up_bias lt int gt 6000 11000 IRIS aperture bias up range Default value is 8160 For GXV3662HD only down_bias lt int gt 6000 11000 IRIS bias down range Default value is 8150 For GXV3662HD only shutter_speed lt int gt 0 30 60 125 250 500 Shutter speed 1000 0 Auto N 1 N ir_cut_setting lt int gt 0 1 2 3 IR CUT setting 0 Manual Mode 1 Automatic Mode IR sensor control 2 Autotatic Mode Algorithm control 3 Time Schedule Mode daytime start int 0 86399 Only for Time Schedule Mode second e g 12 39 start time is 12 3600 39 60 default is 0 Grandstream Networks Inc Grandstream Video Surveillance HTTP
3. 1 Audio output audio microphone volume lt int gt 1 10 Valid for Audio input volume GXV3601HD 36 HIS 1 10 11HD 3501 350 4 3615 3615W 1 5 Valid for Th 1 5 GXV3651FHD 3662HD 3615 WP HD 3500 36 10 3672 3674 Series Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 13 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD audio speaker volume lt int gt Audio output volume 1 10 Valid for GxvaeotHp ae PIS 17 10 11HD 3501 350 4 3615 3615W 1 5 Valid for GXV3651FHD TE 175 3662HD 3615 WP HD 3500 36 10 3672 3674 Series audio chip type lt int gt 0 1 OxFF Audio chip type Read Only non writable 0 AIC33 default 1 AIC3104 OxFF None ntscpal type lt int gt 0 1 Video format Read Only non writable 0 PAL 1 NTSC power frequency lt int gt 50 60 61 Power frequency Indoor 50 50 Europe China Indoor 60 60 US LATAM Outdoor 61 For models like GXV3651 FHD GXV3611IR HD 3662 3610 3672 3674 Only tv output type sint 0 1 0 NTSC default 1 PAL video_statu lt string gt x0 x1 x2 x3 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 14 of 62 www grandstream com Version 1 0 0
4. 6 Date amp Time Support cmd set get GRANDSTREAM CONNECTING THE WORLD http lt servername gt goform date_time cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description updatemode lt int gt 1 2 Update mode 1 Update via NTP time server Default 2 Self defined year lt int gt Greater than 1900 Current year month lt int gt 1 12 Current month day lt int gt 0 31 Current day hour lt int gt 0 23 Current hour minute lt int gt 0 59 Current minute second lt int gt 0 59 Current second timezone lt int gt 1 54 1 GMT 12 Eniwetok Kwajalein 2 GMT 11 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 Midway Isl Samoa Israel 21 GMT 02 Lebanon 22 GMT 02 Syria Grandstream Networks Inc www grandstream com Grandst
5. gzip deflate User Agent Mozilla 4 0 compatible MSIE 8 0 Windows NT 5 1 Trident 4 0 NET CLR 2 0 50727 NET CLR 1 1 4322 CIBA NET CLR 3 0 04506 648 NET CLR 3 0 4506 2152 NET CLR 3 5 30729 Host 192 168 86 11 Connection Keep Alive Authorization Basic YWRtaW46YWRtaW4 Authentication Information encrypted via BASE64 with Format Authorization Basic info n n Info User ID Password separated via encrypted via BASE64 encryption strings e g admin admin is YWRtaW46YWRtaW4 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 5 of 62 www grandstream com Version 1 0 0 54 Last Updatea 10 2015 GRANDSTREAM CONNECTING THE WORLD 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 Server Client HTTP 1 0 HTTP code HTTP text gt r n Example 3 Get Device Status GET goform smtp cmd get HTTP 1 1 Accept Accept Language zh cn Referer http 192 168 86 11 Pages smtp html If Modified Since 0 Accept Encoding gzip deflate User Agent Mozilla 4 0 compatible MSIE 8 0 Windows NT 5 1 Trident 4 0 NET CLR 2 0 50727 NET CLR 1 1 4322 CIBA NET CLR 3 0 04506 648 NET CLR 3 0 4506 2152 NET CLR 3 5 30729 Host 192 168 86 11 Connection Keep Alive Authorization Basic YWRtaW46YWRtaW4 h
6. www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD OVERVIEW Grandstream Video Surveillance HTTP API Application Programming Interface supports RFC1945 HTTP 1 0 and RFC3550 RTP This document explains in details the parameters of functions in client side via the supported GET POST 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 http username password Software Version Requirement All current official firmware of the Grandstream surveillance products are supported URL Format Client Server http username password lt servername gt goform lt param gt cmd lt value gt amp lt parameter gt lt value gt amp NOTE lt param gt is used to identify the different module of functions Example 1 GET Get device status http lt servername gt goform systeminfo cmd get GET goform smtp cmd set amp enablesmtp 0 amp smtpserver amp smtpserverport 25 amp emailfrom amp emailto1 amp email to2 amp emailto3 amp emailuser amp enablessl 0 HTTP 1 1 Accept Accept Language zh cn context type text xml charset utf 8 Referrer http 192 168 86 11 Pages smtp html Cache Control no cache Content Type application x www form encodeURIComponent If Modified Since 0 Accept Encoding
7. 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 int 0 1 Enable proportional pan Grandstream Networks Inc www grandstream com Version 1 0 0 54 Grandstream Video Surveillance HTTP API Page 31 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE enable_preset_freezing lt int gt 0 1 Enable preset freezing preset_speed lt int gt 1 8 Preset speed keyboard_controlpeed lt int gt 1 3 Keyboard control speed auto_scan_speed lt int gt 1 20 Auto scan speed zoom_status lt int gt 0 11 Zoom status O always close 1 always open pt_status lt int gt 0 11 PT Angel 0 close 11 open preset status int 0 11 Preset title 0 close 11 open set resume time point int 0 600 Set resume time O disable enable_limit lt int gt 0 1 Enable Limit limit_type lt int gt 0 1 Limit type limit_type_status lt int gt 0 1 Limit type status enable_park_action lt int gt 0 1 Enable parking action park_time lt int gt 1 10 Parking action time 1min 4hr park_action_type lt int gt 0 4 Park action type 0 start 1 preset 2 Patrolling scan 3 Pattern scan 4 Group patrolling Define origin O horizon O vertical park action type id int 1 8 Park action type ID enable scheduled task int 0 1 Enable scheduled task scheduled task p
8. 3 WPA PSK TKIP 4 WPA PSK AES 5 WPA2 PSK TKIP 6 WPA2 PSK AES keyindex lt int gt 1 4 Key index key lt string gt Encryption Key Example Setting WIFI parameter http 192 168 86 6 goform wireless cmd set8ssid mywifi 200 OK r n Successful Need Reboot r n Example URL Remark http 192 168 86 6 goform wireless cmd get http 192 168 86 6 goform wireless cmd set amp ssid wid amp enable 1 amp key index 1 amp key 1234567890 http 192 168 86 6 goform wireless cmd search Return Result search ssid index 1 search ssid labtest 31 Return search ssid index 2 wifi ssid List search ssid LINKSUM 26 search ssid index 3 search ssid YYGD 7 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 46 of 62 www grandstream com Version 1 0 0 54 Last Updatea 10 2015 GRANDSTREAM CONNECTING THE WORLD 19 System Settings Support cmd set get search http lt servername gt goform device cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description devicename lt string gt Device name channel lt int gt 0 3 Channel number alarmin type lt int gt 0 1 0 Normal Open 1 Normal Close alarmout type int 0 1 0 Normal Open 1 Normal Close alarmin status lt int gt 0 1 Used to get the current status of the alarm in 0 Open 1 Close alarmout status l
9. 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Example Set Audio Video parameters http 192 168 86 6 goform audio video cmd set8channel Ogvideo primary encoder 96 200 OK rn Successful r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 15 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 2 OSD Settings Support method cmd z set get GRANDSTREAM CONNECTING THE http lt servername gt goform osd cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description channel lt int gt 0 1 2 3 Channel numbers in integer Default 0 for IP Camera WORLD osdposition lt int gt 0 1 Time OSD position 0 top 1 bottom osdtimeshow lt int gt 0 1 Display the time OSD 0 Not display 1 Display osdtextshow lt int gt OSD text 0 Not display 1 Display osdopacity lt int gt osdcolor lt string gt 0 10 20 100 HIS GXV3601HD GXV 3611HD GXV3501 GXV3504 GXV361 5 3615W Only OSD Opaque lever HIS Model GXV3601 HD 361 1 HD 3504 3615 3615W Only OSD color OxFFFFFE Auto OxFFFFFF White OxFF0000 Red 0x800080 Purple OxFF6100 Orange 0x0000FF Blue OxFFFFOO Yellow 0x008000 Green OxOOFFFF Cyan 0x000000 Black osdtext lt string gt OSD maximum 63 bytes osdtextindex lt int gt OSD index number
10. cmos cmd set amp lris 1 200 OK r n Successful r n Example URL Remark http 192 168 86 6 goform cmos cmd get http 192 168 86 6 goform cmos cmd set amp lris 1 amp shutter_spee Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 56 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 26 4 D1 Settings For GXV3504 Only http lt servername gt gofrom fourdone cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description enable lt int gt 0 1 0 No 1 Yes ntscpal type lt int gt 0 1 0 PAL 1 NTSC Read only To identity the type for display ptions lt int gt 1 8 H 264 1 4 704 480 2048kbps 15fps no secondary stream 2 4 704 480 1536kbps 19fps no secondary stream 3 4 704 480 1536kbps 2 15fps secondary stream 4 QCIF 176 112 128kbps 1Ofps 4 4 704 576 2048kbps 13fps no secondary stream b 4 704 576 1536kbps 16fps no secondary stream 6 4 704 576 1536kbpsQ10ips secondary stream 4 QCIF 176 144 128kbps 1 Ofps MJPEG 4 704 480 4096kbps 15fps no secondary stream 8 4 704 576 4096kbps 13fps L no secondary stream Example http 192 168 86 25 goform fourdone cmd get Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 57 of 62 www grandstream com Version 1 0 0 54 L
11. lt 1024 0 50 video primary bitrate gt 1024 Record Video to Post Alarm in seconds This may vary among different bitrates Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 38 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD md record uploadftp lt int gt 0 1 Record Video and upload to FTP Server 0 enable 1 disable md sipphone enable lt int gt 0 1 Voice Alarm to SIP Phone 0 enable 1 disable md alarmout enable lt int gt 0 1 Enable Disable alarm output 0 enable 1 disable alarm in 1 corresponds alarm out 1 alarm in 2 corresponds alarm out 2 md uploadcenter enable lt int gt 0 1 Upload to Alarm Center This option has to be enabled for PC to receive alarm event notification 0 enable 1 disable md snapshot enable lt int gt 0 1 Email snapshot and store it to USB card or SD drive md upload to alarm server int 0 1 Upload to HTTP alarm server md snapshot prenum int 1 5 Snapshot pre number maximum md snapshot endnum int 1 5 Snapshot post number maximum md_retrigger_interval lt int gt 1 60 MD Alarm trigger interval seconds Default 1 md_trigger_interval lt int gt 0 5 Minimum Interval of valid Motion Detection second Default 0 Auto Grandstream Networks Inc Grandstream Video Surveillance HTTP A
12. lt int gt alarmout stop lt string gt 0 86399 yes Alarm event end time Default is 86399 in seconds Stop alarm output event record pretime lt int gt 0 160 video primary bitrate lt 256 0 100 video primary bitrate lt 51 2 0 50 video primary bitrate lt 1024 0 25 video primary bitrate gt 1024 Record Video from Pre Alarm in seconds The range varies among different bitrate Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 33 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD event record aftertime lt int gt event record storage lt int gt event record uploadftp lt int gt 0 320 video primary bitrate lt 256 0 200 video primary bitrate lt 51 2 0 100 video primary bitrate lt 1024 0 50 video primary bitrate gt 1024 152 Record Video to Post Alarm in seconds The range varies among different bitrate 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 Record Video uploads to FTP Server 0 disable 1 enable event sipphone enable lt int gt 0 1 Voice Alarm to SIP phone 0 disable 1 enable event alarmout enable lt int gt 0 1 Enable Disable alarm output 0 disable 1 enable alarm in 1 corresponds alarm out 1 alarm in 2 corresponds al
13. no use reserved Example 200 OK r n Successful r n http 192 168 86 6 goform osd cmd set amp osdposition 1 amp osdtimeshow 0 amp osdtextshow 0 amp osdopacity 20 amp osdcolor OxFFFFFE amp osdtext 12345 Page 16 of 62 Last Updated 10 2015 Grandstream Video Surveillance HTTP API Version 1 0 0 54 Grandstream Networks Inc www grandstream com GRANDSTREAM CONNECTING THE WORLD 3 Network Parameters Support cmd set get will take effect after the reboot http lt servername gt goform network cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description httpport lt int gt HTTP port enabledhcp lt int gt 0 1 DHCP 0 disable 1 enable ipaddress lt string gt 192 168 1 123 IP Address Not valid when using DHCP subnetmask lt string gt 255 255 255 0 Subnet mask defaultgateway lt string gt 192 168 1 1 Default gateway autodns lt int gt 0 1 0 Preferred DNS server 1 Automatically obtain DNS server dnsserver primary lt string gt Primary DNS server dnsserver standby lt string gt Backup secondary DNS server Example http 192 168 86 6 goform network cmd set amp channel 0 amp autodns 1 amp ipadress 192 168 86 145 200 OK r n Successful Need Reboot r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 17 of 62 www grandstream com Version 1 0 0 54 Last Up
14. 0000 http 1 92 168 86 6 goform alarmio cmd add amp alarmin index 0 amp alarmin schedule dayset 4 amp alarmin schedule starttime 9999 amp alarmin schedule endtime 999999999 http 192 168 86 95 goform alarmio cmd removeg alarmin schedule id O http 192 168 86 95 goform alarmio cmd zremove amp alarmin schedule id 1 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 36 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 13 Motion Detection Support cmd add remove set get http lt servername gt goform motiondetect cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description md channel count lt int gt 1 4 Number of channels for motion detection IP camera only has 1 channel GXV3504 support 4 channels md channel index lt int gt 0 1 2 3 Corresponding index for channels IP camera 1 4 channel GXV3504 0 3 md active enable lt int gt 0 1 Enable Motion Detection 0 No 1 Yes md regn index lt int gt 0 15 Motion Detection Region 0 15 md regn leftup lt int gt First 2 bytes used for X Last 2 bytes used for Y md regn rightdown lt int gt First 2 bytes used for X Last 2 bytes used for Y If md regn leftup 0 and md regn rightdown 0 It means invalid region md regn sensitivity lt int gt 0 100 Sensitivity The higher the valu
15. 1 test success selfdefine_email_title lt string gt Self defined email subject selfdefine_email_content lt string gt Self defined email content Example Set SMTP parameters When enablesmtp 1 the Email address format will be checked http 192 168 86 66 goform smtp cmd set amp enablesmtp 0 when enablesmtp 1 basic check will be performed to all the addresses 200 OK r n Successful r n Grandstream Video Surveillance HTTP API Version 1 0 0 54 Grandstream Networks Inc www grandstream com Page 28 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 10 FTP Settings Support cmd set get http lt servername gt goform ftp cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description enableftp lt int gt 0 1 Enable FTP 0 No 1 Yes ftpserver lt string gt FTP server max 255 Bytes ftpserverport lt int gt FTP server port ftpuser string FTP user name max 23 Bytes ftppassword lt string gt FTP password it would not be sent along with parameters maximum 63 Bytes ftppath lt string gt FTP path max 63 Bytes ftptest lt int gt 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 http 192 168 86 6 goform ftp cmd set
16. 3 PAL start_patrol lt int gt 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 2 int Port i 0 7 time i int i 0 7 host iJ lt string gt i 0 7 user i string i 0 7 password i string i 0 7 description i lt string gt i 0 7 Example http lt servername gt goform decode cmd set channel 1 Example URL Remark http 192 168 86 146 goform decode cmd set channel 1 Set channel 1 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 52 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 24 Stream Acquiring MJPEG Only http lt servername gt gofrom stream cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description channel lt int gt 0 7 For IP Camera the primary is 0 default is 0 2 stream is 4 For GXV3504 the channel number and streams mapping is equal to n 4 Example http 192 168 86 25 goform stream cmd get amp channel 0 http 192 168 86 25 goform stream cmd get8channel 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 0 the 2 stream is using digit 4
17. 6 95 goform storage cmd remove amp storage index 1 01 Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 42 of 62 Last Updated 10 2015 16 Maintenance Upgrade Support cmd z set get GRANDSTREAM CONNECT NG THE WORLD http lt servername gt goform maintenance cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description restart lt string gt yes Restart the device restore lt string gt yes Reset to factory default update viatype lt int gt 1 2 3 Upgrade via 1 TFTP 2 HTTP 3 HTTPS upgrade serverpath lt string gt serverhost port dir Firmware server path upgrade cfgserverpath lt string gt serverhost port dir Configuration server path maximum 255 Bytes upgrade_cfg_xml_pwd lt string gt XML config file password Example Set maintenance and upgrading parameters http 192 168 86 6 goform maintenance cmd set amp upgrade serverpath 192 168 86 1 200 OK r n Successful r n upgrade automatic lt int gt 0 1 Automatic upgrade 0 No 1 Yes upgrade interval int 60 525600 Automatic upgrade interval in minutes dhcp option 66 int 0 1 0 disable 1 enable DHCP option 66 3cx auto provision int 0 1 0 disable 1 enable 3CX auto configure disable telnet int 0 1 0 disable Default 1 enable Teln
18. API Page 54 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD daytime_end lt int gt 0 86399 Only for Time Schedule Mode second e g 12 39 end time is 12 3600 4 39 60 default is 0 ir_cut_sensitivity lt int gt 1 2 3 4 5 IR_CUT sensitivity d_n_mod lt int gt 0 1 Day Night mode 0 day 1 night color mod int 0 1 2 Color mode 0 color 1 black white 2 auto ir led setting int 0 1 2 V2 Model IR LED control 0 Auto 1 On 2 Off privacymask lt string gt Privacy Masks String GET Format Md Vd 96d VA d d e g ID E X1 Y1 X2 Y2 SET Format 1 AE AX1 AY1 AX2 AY2 BEQBX1QBY1QBX2QBY2 QCEQCX1 QCY1QCcX2ocYvYa2qo DE DX1 DY1 DX2 DY2 AE Region A 0 disable 1 enable AX1 Region AY1 Region AX2 Region AY2 Region X1 0 X1 704 Y1 0 lt Y1 lt 576 X2 0 X2 704 Y2 Y2 0 lt Y 2 lt 576 gt gt gt Region B C D same as Region A Format 2 ID E X1 Y1 X2 Y2 ID Region ID E O disable 1 enable X1 x1 0 lt X1 lt 704 Y1 y1 0 lt Y1 lt 576 X2 x2 0 lt X2 lt 704 Y2 y2 0 Y1 576 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 55 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Example Set CMOS parameters http 192 168 86 6 goform
19. GRANDSTREAM CON NEG TING THE WorRrL D Grandstream Networks Inc Grandstream Video Surveillance HTTP API Version 1 0 0 54 www grandstream com GRANDSTREAM CONNECTING THE WORLD This page intentionally left blank Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 2 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD TABLE OF CONTENTS Grandstream Video Surveillance HTTP API OVERVIEW d ere 5 SOFTWARE VERSION REQUIREMENT isses ener ener en nnn sienne rris innen r siint resi siters sienne iren nensi en nnns 5 URL PARAMETER DEFINITIONS areis eraros annen E EEEE EER EE AREE EEA E TEA 8 COMMONIURL To uM 9 RESPONSES FROM THE DEVICE eerste ctr ar des nose saa ka akou TORRE SUE TERR loa YR EGER a EENS ERU as TELA RETE ke 10 Xs zat 12 1 AUDIOVIDEO ME 12 Pe asit didan aw au ane T E TE E E T SE ER 16 3 NETWORK PARAME TER Surne ai n thue swa sat 08 adan EE A E A AEN 17 4 DYNAMIC DNS DDNS e vekse ss atenn i E EA T AS 18 HH ce Ee 19 SM ize TIME oe EE E A RI e E EN 22 TAU ER 26 8 ACCOUNT MANAGEMENT condire a ess a an pwale E R TE T aaa d on du pies de aaa od 27 9 SMTP E MAIL SETTINGS ss 2455 vi asa ge Ee Ee 28 LIEGE TP SETTINGS fois kwe vast S 29 11 PTZ SETTINGS ONLY FOR GXV3500 AND OGXN
20. HD 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 gt 6144 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 24 lt 256 160 320 768 GXV3601HD GXV3611HD lt 512 100 200 384 GXV3615 W GXV3615WP_HD lt 1024 50 100 192 lt 1536 45 60 128 lt 2048 30 60 96 Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 61 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Table 1 Device Alarm Recording Time Table Bit Pre_Record Post_Record Theoritical Model Memory M Rate bps Max Time s Max Time s Max Time s ep 3 512 15 25 48 GXV3674 lt 1024 10 10 24 GXV3611IR_HD 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 gt 6144 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 gt 6144 3 4 8 Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 62 of 62 Last Updated 10 2015
21. MAL OPEN alarmin type alarmin status OPEN alarm input detected NORMAL CLOSE alarmin type alarmin status CLOSE IDLE no alarm input NORMAL CLOSE Grandstream Networks Inc www grandstream com Version 1 0 0 54 Grandstream Video Surveillance HTTP API Page 48 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 20 PPPoE Settings Support cmd set get http lt servername gt goform pppoe cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description pppoe user lt string gt PPPoE username password lt string gt PPPoE password Not show when using get pppoe status lt int gt 0 1 PPPoE status read only 0 disconnected 1 connected pppoe ip lt string gt PPPoE IP read only Example Set PPPoE parameter http 192 168 86 6 goform pppoe cmd set amp alarmout type 1 200 OK r n Successful r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 49 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 21 Snapshot http lt servername gt snapshot view0 jpg lt parameter gt lt value gt Values Description viewO jpg view jpg Capture viewO jpg in primary stream view2 jpg view3 jpg Capture view4 jpg in 2 stream view4 jpg view5 jpg Capture viewO jpg view7 jpg in 4 channels wi
22. PI Page 39 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Example Parameter settings Delete a schedule which has id 1 http 192 168 86 6 goform motiondetect cmd set amp md record storage 1 amp md record after time 10 amp md record pretime 20 amp md record uploadftp 1 amp md sipphone enable 1 amp md ala rmout enable 1 amp md uploadcenter enable 1 amp md snapshot enable 1 HTTP 1 0 200 OK r n Successful r n Example URL Remark http 192 168 86 6 goform motiondetect cmd set amp md active enable 2 http 192 168 86 6 goform motiondetect cmd set amp md regn index 0 amp md regn leftup 1 amp http 192 168 86 6 goform motiondetect cmd set amp md regn index 0 amp md regn leftup 1 amp http 192 168 86 6 goform motiondetect cmd set amp record storage 0 http 192 168 86 6 goform motiondetect cmd set amp md record storage 2 amp md record aftertime 30 amp md record pretime 10 amp md record uploadftp 0 amp md sipp hone enable 0 amp md alar http 192 168 86 6 goform motiondetect cmd set amp md record storage 1 amp md record aftertime 10 amp md record pretime 20 amp md record uploadftp 1 amp md sipp hone enable 1 amp md alar http 192 168 86 6 goform motiondetect cmd remove amp md regn schedule id http 192 168 86 6 goform motiondetect cmd add http 192 168 86 6 goform motiondetect cmd add amp md regn index 1 http 192 168 86 6 goform mot
23. Page 23 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 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 lt string gt 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 lt int gt 0 1 Enable NTP server 0 No 1 Yes ntpserver lt string gt NTP server max 255 Bytes datestyle lt int gt 1 2 3 OSD date format 1 YYYY MM DD 2 MM DD YYYY 3 DD MM YYYY ntpupdateinterval lt int gt 5 1440 NTP Update Interval minutes Default 1440 enable_dst lt int gt 0 1 Use Day Light Saving Time 0 No 1 Yes dst_str lt string gt DST Format must in following format GMT 05 00GDT 04 00 M3 2 0 02 00 00 M11 1 0 02 00 00 NOTE GMT 05 00 current zone must be one of following starting with GMT GMT 12 00 GMT 11 00 GMT 10 00 GMT 09 00 etc MDT 04 00 Start DST MUST start with MTZ e g M3 2 0 02 00 00 M11 1 0 02 00 00 Start M3 2 0 02 00 00 means 2nd Sun of March 2 00 00 AM Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 24 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WO
24. RLD Example http 192 168 86 6 goform date_time cmd set amp updatemode 1 amp year 2902 amp month 9 amp day 26 amp hour 22 amp minute 22 amp second 33 amp timezone 54 amp deftimezone MTZ 6MDT 5 M4 1 0 M11 1 118ntpserver time nist com 200 OK r n Successful r n NOTE gt Parameter updatemode is required in each link Example http 192 168 86 6 goform date_time cmd set amp updatemode 1 amp year 2902 amp month 9 amp d ay 26 amp hour 22 amp minute 22 amp second 33 amp timezone 54 amp deftinezone EST 5EDT 4 M3 2 0 M11 1 11 amp ntpserver time nist com 200 OK r n Successful r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 25 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 7 Status Support cmd geleet cmd set can only be used by devicename http lt servername gt goform systeminfo cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description productmode lt string gt HIS Device model may vary GXV3504 GXV3601HD GXV3611_HD GXV3615 W TI GXV3500 GXV3651FHD GXV3662_HD FHD GXV3615WP_HD GXV3611IR HD GXV3610 HD FHD GXV3672 HD FHD GXV3672 HD FHD 36 GXV3674 HD FHD VF hardwareversion lt string gt VO 2B Hardware version partnumber lt string gt P N number bootloaderversion lt string gt BOOTLOADER version coreve
25. TTP API Page 20 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Support cmd add remove get Phonebook settings lt parameter gt lt value gt Values Description phone count lt int gt Total phonebook entries phone index lt int gt 1 2 5 Index of phonebook entries phone number lt string gt Phone number maximum 15 Bytes phone name lt string gt Name Note of phone number max 127 Bytes white_list_phone lt string gt Phone numbers of incoming call white list audio_warning_mode lt int gt 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 gt Phonebook entries could be added one at a time Example Add phone number http 192 168 86 6 goform sip cmd add8phone name 60068phone number 5003 200 OK nin Successful Need Reboot r n Example URL Notes http 192 168 89 19 goform sip cmd set8unregister 18accountname xk owengsipserver 192 168 89 2078userid 30288authenticateid 30288acc ountpassword 123456 http 192 168 89 19 goform sip cmd add amp white list phone 2222 http 192 168 89 19 goform sip cmd remove amp Delete phone white list phone 2222 3333 4444 numbers in white list Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 21 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015
26. V3bOA eene nennen nennen 30 TZALARM EVENT M od a kat ka aa n ek n a ak n a ki B a a ak kk kk 33 13 de uge d RR EE 37 p Iosuddkoc M 41 15 LIVE STORAGE ONLY FOR SUPPORTED MopEL Sg 42 16 MAINTENANGE UPGRADE ki a wal 43 17 CONTRAST SATURATION BRIGHTNESS AND CHROMA s sssssssssssssssnsrsrsnsnsnnnsnnnnnnnnnnnnnn nanena nananana anneanne nenna 44 18 WIFI SETTINGS ONLY FOR SUPPORTED MODELS ssssssssssseseneeneenene enne en nennen nnne nennen 46 19 SVSTEM Eeiznic mom 47 20 PP POE SETTINGS eenegen mw ata mot ta mta id natal n dal wa lw nat ik lalin ok mt ERNER 49 21ZSNAPSHOT WE 50 22 WEB GUI LANGUAGE E Z 51 23 DECODE SETTINGS FOR GXV3500 ONLY 52 24 STREAM ACQUIRING MJPEG ONGe 53 25 CMOS SETTINGS ONLY FOR SUPPORTED MODELS sss enne 54 26 4 D1 SETTINGS FOR GXV3504 ONG 57 27 ALARM HTTP SERVERS SETTINGS eene enne enne EARE AA EEE ANERER EAA 58 28 RECORD SETTINGS awstea datt vo at ott dl et vate Rode P ee e PV Fade FA dE a dee n De e FR Fade FR DERE A Ide ma 59 20 TIME LAPSE PHOTOGRAPHY MM 60 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 3 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD This page intentionally left blank Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 4 of 62
27. amp ftpserver 123456 amp ftpserverport 1 11 amp ftpuser a dmin amp ftppath admin 200 OK r n Successful r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 29 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 11 PTZ Settings Only for GXV3500 and GXV3504 Support cmd set get Only apply to GXV3504 and GXV3500 http lt servername gt goform ptz cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description protocol lt int gt 0 1 Select PTZ Protocol 0 PELCO P 1 PELCO D channel lt int gt 0 3 Pending baudrate lt int gt 1200 2400 4800 Baud rate 9600 May vary among different device or models ptzparam lt int gt 0 63 Speed PTZ speed or default position 0 127 Default position For default position values certain values between 0 to 127 have been already used ptzcontrol lt int gt 0 1 PTZ Control 0 Stop Tilt Up Tilt Down Pan Left Pan Right Pan to upper left corner Pan to lower left corner Pan to upper right corner ONonnkR WD Pan to lower right corner ce 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 lt int gt 0 255 Channel 1 location PTZ
28. ark time 1 10 Schedule park time lt int gt WORLD Example Set PTZ parameter http 192 168 86 66 goform ptz cmd set amp ptzcontrol 4 amp ptzparam 31 rotation and speed have to be used together 200 OK r n Successful r n Note ptzcontrol and ptzparam both have to be included in the link Grandstream Video Surveillance HTTP API Version 1 0 0 54 Grandstream Networks Inc www grandstream com Page 32 of 62 Last Updated 10 2015 12 Alarm Event Support cmd set get add remove GRANDSTREAM CONNECT NG THE WORLD http lt servername gt goform alarmio cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description alarmin count lt int gt 0 1 4 Numbers of alarm input supportted by devices Vary among models e g IP camera only supports 1 alarm input GXV3504 supports 4 alarmin index lt int gt 0 1 2 3 Index of alarm input alarmin schedule count lt int gt 0 1 Numbers of schedules alarmin schedule id lt int gt 1 2 3 ID of schedules alarmin schedule dayset lt int gt 0 7 0 Sunday Monday Tuesday Wednesday Thursday Friday Saturday Everyday default NO oO Ff WD alarmin schedule starttime lt int gt 0 86399 Default is 0 in seconds Example 12 39 starttime 12 3600 39 60 alarmin schedule endtime
29. arm out 2 event uploadcenter enable lt int gt Upload to Alarm Center This option has to be enabled for PC to receive alarm event notification 0 disable 1 enable Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 34 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD event shotemail enable lt int gt 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 0 1 Upload HTTP alarm lt int gt server event_snapshot_prenum lt int gt 1 5 Snapshot pre number most event_snapshot_endnum lt int gt 1 5 Snapshot end number most Example Parameter settings http 192 168 86 6 goform alarmio cmd add amp alarmin index 0 amp event record pretime 20 amp event record aftertime 10 amp event record storage 1 amp event record uploadftp 1 amp event sip phone enable 1 amp event alarmout enable 1 amp event uploadcenter enable 1 amp event shotem ail enable 1 HTTP 1 0 200 OK r n Successful r n Add a schedule with Everyday as default http 192 168 86 6 goform alarmio cmd add amp alarmin index 0 HTTP 1 0 200 OK r n Successful r n http 192 168 86 6 goform alarmio cmd add amp alarmin index 0 amp alarmin schedule dayset 4 amp alarmin schedule starttime 200 amp a
30. ast Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 27 Alarm HTTP Servers Settings Support cmdzsetget http lt servername gt goform event_server cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description server_name lt string gt Server name server_url lt string gt Server URL server username string gt Username server user password string Password channel lt int gt 0 4 Channel GXV3504 Example Set Alarm HTTP Servers parameters http 192 168 86 6 goform event server cmd set8server name servername amp server ur l http 200 OK r n Successful r n http 192 168 86 6 goform event_server cmd get EE http 192 168 86 6 goform event_server cmd set amp server_name servername amp server_url ser Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 58 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 28 Record Settings Support cmd set get http lt servername gt goform sdrecord cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description channel lt int gt 0 3 Channel number Single channel device could skip this state_record lt int gt 0 4 0 No record 1 Manual record 2 Auto record 3 Alarm record 4 No storage device enabl
31. dated 10 2015 4 Dynamic DNS DDNS Support cmd set get GRANDSTREAM CONNECTING THE WORLD http lt servername gt goform ddns cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description enableddns lt int gt isptype lt int gt 0 1 0 6 DDNS 0 disable 1 enable ISP type 0 dyndns org noip com ActiveDNS cn99 com ipkan net ipkan cn oat WN ipkan com cn sitename lt string gt Site name maximum 255 Bytes ddnsip lt string gt Custom DDNS site account lt string gt DDNS account maximum 23 Bytes password lt string gt stunserver lt string gt Example DDNS password maximum 63 Bytes STUN Server maximum 255 Bytes http 192 168 86 6 goform ddns cmd set amp enableddns 1 200 OK r n Successful r n Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Page 18 of 62 Version 1 0 0 54 Last Updated 10 2015 5 SIP GRANDSTREAM CONNECTING THE Support cmd set get will take effect immediately after saving WORLD http lt servername gt goform sip cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description registeredstate lt int gt 0 1 Registration state 0 Offline 1 Online unregister l
32. deo secondary iframe int video primary bitrate lt int gt 16 32 64 Video bit rate video secondary bitrate lt int gt 1024 Varies among different device or models video primary brtype lt int gt 6 1 0 VBR Variable bitrate video secondary brtype lt int gt 1 CBR Constant bitrate video primary framerate lt int gt 1 30 Frame rate video secondary framerate lt int gt Varies among different device or models NTSC PAL format video primary iframe lt int gt 1 100 frame interval Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 12 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD video primary imagequality int 1 5 Image quality video secondary imagequality lt int gt Level 1 5 The lower the value the greater the image quality only valid with VBR configuration audio primary encoder lt int gt 0 1 2 3 4 Audio codec audio secondary encoder lt int gt 0 PCMU 1 PCMA 2 G726 valid only for HIS GXV3601 HD 3504 361 1HD 36 15 3615W 3 disabled Some models may only support audio primary encoder share audio primary encoder audio primary bitrate int 16 32 Audio bitrate audio secondary bitrate lt int gt Some models may only support audio primary encoder share audio primary encoder audio linein lt int gt 0 1 Audio input audio lineout int 0
33. dic_snapshot cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description 0 disable 1 enable periodic_snapshot_enable lt int gt Periodic snapshot interval minute periodic snapshot interval int Save to SD card 0 No 1 Yes periodic snapshot uploadsd lt int gt FTP upload 0 No 1 Yes periodic snapshot uploadftp lt int gt periodic snapshot uploademail lt int gt Email upload 0 No 1 Yes Example http 192 168 86 6 goform periodic_snapshot cmd set amp periodic_snapshot_enable 1 amp periodic_snapshot_interva 30 200 OK r n Successful r n Example URL http 192 168 86 6 goform periodic_snapshot cmd get http 192 168 86 6 goform periodic_snapshot cmd set amp periodic_snapshot_enable 1 amp periodic_snapshot_interva 30 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 60 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Table 1 Device Alarm Recording Time Table Bit Pre_Record Post_Record Theoritical Model Memory M Rate bps Max Time s Max Time s Max Time s GXV3662 24 512 100 200 384 GXV3651 lt 1024 50 100 192 GXV3601HD lt 1536 45 60 128 GXV3611HD lt 2048 30 60 96 lt 3072 20 40 64 lt 4096 15 30 48 lt 6144 10 20 32 gt 6144 10 10 24 GXV3672
34. e the better the sensitivity md regn schedule count lt int gt 9 1 Total number of schedule md regn schedule id lt int gt 0 1 2 3 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 37 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECT NG THE WORLD md regn schedule dayset lt int gt 0 7 Sunday Monday Tuesday Wednesday Thursday Friday Saturday Everyday default N Of WMP o md regn schedule starttime lt int gt 0 86399 Default is 0 in seconds Example 12 39 starttime 12 3600 39 60 md regn schedule endtime lt int gt 0 86399 Default is 86399 in seconds Example 12 39 starttime 12 3600 39 60 md record storage lt int gt 0 1 2 3 Alarm record storage method 0 Do not save 1 SD card 2 USB Flash Drive 3 DISK Some models Not applicable event record pretime lt int gt 0 160 video primary bitrate lt 256 0 100 video primary bitrate lt 51 2 0 50 video primary bitrate lt 1024 0 25 video primary bitrate gt 1024 Record Video from Pre Alarm in seconds This may vary among different bitrates md record aftertime lt int gt 0 320 video primary bitrate lt 256 0 200 video primary bitrate lt 51 2 0 100 video primary bitrate
35. e_time_table lt int gt 0 1 Enable record schedule 0 No 1 Yes record time table string Record schedule This is a 168 character string with possible values 0 and 1 0 No 1 Yes record full handle lt int gt 1 2 When the record is full 1 Override the oldest record 2 Stop recording Use channel 0 record only start record 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 http 192 168 86 6 goform sdrecord cmd set amp channel 0 amp enable time table 1 amp record time table 010111 111 200 OK nin Successful Wn Example URL http 192 168 86 6 goform sdrecord cmd get http 192 168 86 6 goform sdrecord cmd set8channel 08 enable time table 18record time table 010111 111 http 192 168 86 6 goform sdrecord cmd set amp record full handlezO http 192 168 86 6 goform sdrecord cmd set amp channel 0 amp record_start 1 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 59 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 29 Time Lapse Photography Support cmd set get http lt servername gt goform perio
36. et Access enable_upnp lt int gt 0 1 0 disable 1 ll Delen enable UPnP Discovery Grandstream Networks Inc www grandstream com Version 1 0 0 54 Grandstream Video Surveillance HTTP API Page 43 of 62 Last Updated 10 2015 17 Contrast Saturation Brightness and Chroma Support cmd z set get GRANDSTREAM NG THE WORLD CONNECT http lt servername gt goform videocontrol cmd lt value gt amp lt parameter gt lt value gt NOTE gt Contrast Saturation Brightness have to be set at the same time Otherwise would be 0 default Color may not be available for some models lt parameter gt lt value gt Values Description channel lt int gt 0 1 2 3 Assigned channel number Default number for IP Camera is 0 brightness lt int gt contrast lt int gt 0 255 For GXV3504 0 60 For GXV3615 3615W 0 5 For GXV3601HD 3611HD 0 255 For GXV3651FHD GXV3662 GXV3500 GXV3610 3672 3674 GXV3611IR_HD 0 255 For GXV3504 0 7 For GXV3615 3615W 0 3 GXV3601HD 361 1HD 0 255 For GXV3651FHD GXV3662 GXV3500 GXV3610 3672 3674 GXV3611IR HD Brightness Contrast Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 44 of 62 Last Updatea 10 2015 GRANDSTREAM CONNECTING THE WORLD saturation lt int gt 0 1255 For GXV3504 Saturation 0 63 Fo
37. evel 6 amp logserver 12345464 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 41 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 15 Live Storage Only for Supported Models Support cmd z remove get format GRANDSTREAM CONNECTING THE WORLD http lt servername gt goform storage cmd lt value gt amp lt parameter gt lt value gt file name lt string gt 192 168 86 20 chn0 2011 09 21 14 43 4 8 jpg 0 2 2011 09 21 13 32 parameter z value Values Description storage count lt int gt 0 Total storage equipment storage index lt int gt 1 101 201 1 USB 101 SD 201 DISK storage capacity lt string gt Total storage capacity storage usedspace lt string gt Used space MB storage freespace string Free Space MB file count lt int gt Total number of saved files file index lt int gt 1 2 3 File index file size lt string gt File size MB Filename with the file path can be used to download the file e g http serverhost port file name Image file format ip channel date time jpg Example 21 1718 1 avi AVI file format channel recordtype date time filelength 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 Reserved 200 OK r n Successful r n http 192 168 8
38. iondetect cmd add amp md regn index 1 http 192 168 86 6 goform motiondetect cmd add amp md regn index 1 amp md channel index 192 168 86 6 goform motiondetect cmd set amp md regn index 0 amp md regn Delete Alarm leftup 0 amp md regn rightdown 0 amp md regn sensitivity 1 Region Support cmd get md statu http lt servername gt goform motiondetect cmd get md statu parameter value Values Description MD Alarm State 0 No Alarm 1 Alarming now md alarm statu lt int gt Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 40 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 14 System Log Support cmd set get http lt servername gt goform systemlog cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description logserver lt string gt Syslog server max 127 Bytes loglevel lt int gt 0 1 2 3 4 Syslog level 0 NONE 1 DEBUG 2 INFO 3 WARNING 4 ERROR Example http 192 168 86 6 goform systemlog cmd set amp loglevel 1 amp logserver 12345464 200 OK r n Successful Need Reboot r n Example URL Remark http 192 168 86 6 goform systemlog cmd get http 192 168 86 6 goform systemlog cmd set amp loglevel 1 amp logserver 12345464 http 192 168 86 6 goform systemlog cmd set amp logl
39. larmin schedule endtime 40000 HTTP 1 0 200 OK r n Successful r n Delete a schedule with id 111 http 192 168 86 6 goform alarmio cmd removegalarmin schedule id 111 2 3 HTTP 1 0 200 OK r n Successful r n Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 35 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Sample URLs http 192 168 86 6 goform alarmio cmd get http 192 168 86 6 goform alarmio cmd set amp alarmin index 0 amp event record pretime 10 amp event reco rd aftertime 20 amp event record storage 0 amp event record uploadftp 0 amp event sipphone enable 0 amp event alarmout enable 0 amp event uploadcenter enable 0 amp event shotemail enable 0 http 1 92 168 86 6 goform alarmio cmd set amp alarmin index 0 amp event record pretime 20 amp event reco rd aftertime 10 amp event record storage 1 amp event record uploadftp 1 amp event sipphone enable 1 amp event alarmout enable 1 amp event uploadcenter enable 1 amp event shotemail enable 1 http 192 168 86 6 goform alarmio cmd set amp event record pretime 10 amp event record aftertime 20 http 1 92 168 86 6 goform alarmio cmd add http 192 168 86 6 goform alarmio cmd add amp alarmin index 0 http 192 168 86 6 goform alarmio cmd add amp alarmin index 0 amp alarmin schedule dayset 4 amp alarmin schedule starttime 200 amp alarmin schedule endtime 4
40. ministrator 1 user 2 anonymous user name string User name max 23 Bytes user password string User password max 63 Bytes anonymous enable lt int gt 0 1 Allow anonymous login 0 No 1 Yes Example 200 OK r n Successful r n http 192 168 89 43 goform usermanage cmd remove amp user name name Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 27 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECT NG THE WORLD 9 SMTP E mail Settings Support cmd set get http lt servername gt goform smtp cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description enablesmtp lt int gt 0 1 Enable SMTP 0 No 1 Yes smtpserver string SMTP Server max 255 Bytes smtpserverport lt int gt SMTP Server port emailfrom lt string gt From E Mail address max 63 Bytes emailuser lt string gt E mail user name max 63 Bytes emailpassword lt string gt 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 lt int gt 0 1 Use SSL 0 No 1 Yes smiptest lt int gt To test SMTP uses smiptest 1 Other value does not work Return smiptestresult 0 test failed with smtp error message smiptestresult
41. only default 0 Addressid2 lt int gt 0 255 Channel 2 location GXV3504 default 1 Addressid3 lt int gt 0 255 Channel 3 location GXV3504 default 2 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 30 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE W Addressid4 lt int gt 0 255 Channel 4 location GXV3504 default 3 Msgtype lt int gt 0 1 Transmission Type 1 Transparent passing value 2 Other TBD Class lt int gt Op Type O Not defined 1 Patrol Scan 2 Pattern Scan 3 Loop across preset positions Group lt int gt 0 not defined 1 8 Patrol 1 4 Pattern Scan 1 8 Loop across preset positions Id lt id gt action_type lt int gt Can be ID in database or chip Action type 1 not defined 2 predefined 3 pattern scan 4 loop across preset positions action_id lt int gt action_time lt int gt Action ID 0 not defined 1 128 predefined 1 8 patrolling 1 4 pattern scan 1 8 loop across preset positions Operation time in second Group patrolling 1 240s action_speed lt int gt 0 128 Speed patrolling among preset positions 1 90 degree s swing_start_id lt int gt 1 128 Start position of patrolling swing_end_id lt int gt 1 128 Stop position of patrolling oprate_type lt int gt Op command
42. r GXV 3615 3615W 0 8 For GXV3601HD 3611HD 0 255 For GXV3651FHD GXV3662 GXV3500 GXV3610 3672 3674 GXV3611IR_HD Default lt int gt 3 4 3 set default value 4 set color enhancement default value For GXV3601HD and GXV3611HD only Example http 192 168 86 6 goform videocontrol cmd set amp contrast 101 200 OK r n Successful r n Example URL http 192 168 86 6 goform videocontrol cmd get http 192 168 86 6 goform videocontrol cmd set amp contrast 101 amp brightness 101 amp saturation 101 http 192 168 86 6 goform videocontrol cmd set amp contrast 101 http 192 168 86 6 goform videocontrol cmd set amp contrast 101234 amp brightness 101 amp saturation 101 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 45 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 18 WIFI Settings Only for Supported Models Support cmd set get search http lt servername gt goform wireless cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description wifiexist lt int gt 0 1 This is only applicable on GXV3615W and GXV3615WP HD 0 WIFI is not supported 1 WIFI is supported enable lt int gt 0 1 0 Disable 1 Enable ssid lt string gt SSID authentication lt int gt 0 6 Security Mode 0 NONE 1 WEP Shared 2 WEP Open
43. ream Networks Inc Grandstream Video Surveillance HTTP API Page 10 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD This page intentionally left blank Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 11 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 PARAMETERS 1 Audio Video Parameters Support method cmd z set get GRANDSTREAM CONNECTING THE WORLD If devices support 2 streams they are called primary stream and secondary stream respectively http lt servername gt goform audio_video cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description channel lt int gt 0 1 2 3 Channel numbers in integer Default 0 for IP Camera video primary encoder lt int gt 96 26 Video codec video secondary encoder lt int gt 96 H264 26 MJPEG not supported by some models This parameter needs to be set along with the parameter of bitrate video_primary_profile lt int gt Profile video_secondary_profile lt int gt 0 baseline 0 1 2 1 main profile pe 2 high profile video primary resolution lt int gt video secondary resolution lt int gt 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 vi
44. ream Video Surveillance HTTP API Version 1 0 0 54 Page 22 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 23 GMT 03 Moscow Riyadh 24 GMT 03 Iraq 25 GMT 03 30 lran 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 35 GMT 10 Hobart 36 GMT 10 Canberra Melbourne Sydney 37 GMT 11 Solomon Island 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 Portugal 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 St Petersburg Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54
45. regn schedule endtime 86399 md regn schedule id 2 md regn index 0 md regn schedule dayset 1 md regn schedule starttime 0 md regn schedule endtime 4879 md regn schedule id 3 md regn index 1 md regn schedule dayset 7 md regn schedule starttime 0 md regn schedule endtime 86399 Grandstream Networks Inc www grandstream com Grandstream Video Surveillance HTTP API Version 1 0 0 54 G THE WORLD Page 9 of 62 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Responses from the Device HTTP 1 0 HTTP code HTTP text gt r n HTTP Code HTTP Text Description 200 OK Request is successful Successful r n indicate configuration is successful It does not mean set delete add successful until receiving Successful r n Successful Need Reboot r n configure successful but it need reboot in order for parameters taking effect No Privilege r n indicate incorrect privilege used lt param gt Invalid r n invalid parameter used lt param gt Missing Wn 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 This message returned when the server busy or Unavailable unavailable e g retrieve set add delete failed or busy Example Request includes invalid file names HTTP 1 0 404 Not Found r n Grandst
46. rsion lt string gt Core version baseversion lt string gt Base version firmwareversion lt string gt 0 59 Firmware version cameratype lt string gt Camera type brand and model ddnsstate lt int gt 0 1 2 3 4 5 6 DDNS Status 0 Disable 1 Processing 2 Success 3 Account Password Error 4 Server blocking 5 Stun Server error 6 Database failed wifistatez int 0 1 Wi Fi Status 0 Disconnected 1 Connected systemrun lt string gt System up time mac lt string gt MAC Address Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 26 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD ledstatus lt int gt 0 1 LED Status GXV3615 series Only 0 On 1 Off pppoe ip PPPoE IP Default is 0 0 0 0 pppoe status 0 1 PPPoE status 0 disconnected 1 connected ipaddress For display only subnetmask For display only defaultgateway For display only Ircutstatu lt int gt 1 2 IR cut 1 daytime 2 evening 8 Account Management Support cmd add remove set get http lt servername gt goform usermanage cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description user count lt int gt gt 1 Total user numbers user index lt int gt 1 2 Index of users user level lt int gt 0 1 2 User Privilege 0 ad
47. t int gt 0 1 Unregister on reboot 0 No 1 Yes accountname lt string gt Account name maximum 127 Bytes sipserver lt string gt SIP server maximum 255 Bytes proxyserver lt string gt Proxy server domain or IP address userid lt string gt SIP user ID maximum 255 Bytes authenticateid lt string gt Authenticate ID Could be the same or different with SIP UserlD maximum 127 Bytes accountpassword lt string gt Account password maximum 127 Bytes Only used for setting password not for acquiring password stunserver lt string gt STUN server URI or IP PORT maximum 127 Bytes sipstream lt int gt 0 1 0 Secondary 1 Primary audioencoder lt int gt 0 1 0 PCMU 1 PCMA Default is 0 PCMU regexpiration lt int gt Default is 3600 in second maximum 45 days localsipport lt int gt Local SIP port Default is 5060 localrtpport lt int gt 1024 30000 Local RTP port 1024 30000 autohooktimer lt int gt 0 65535 Auto hook timer in second 0 Never onhook Default is 0 disable_audio lt int gt 0 1 0 No 1 Yes enable_keep_alive lt int gt 0 1 0 No 1 Yes direct ip call int 0 1 0 No 1 Yes Grandstream Video Surveillance HTTP API Version 1 0 0 54 Page 19 of 62 Last Updated 10 2015 Grandstream Networks Inc www grandstream com GRANDSTREAM CONNECTING THE WORLD sip proxy compatibility mode 0 1 SIP Server Compatibility O No 1 Yes means l
48. t int gt 0 1 Used to get the current status of the alarm out 0 Open 1 Close alarm_output_time lt int gt 0 5 15 0 keep alarm until manually turned off 30 60 180 N alarm off after N seconds 300 600 900 1800 Example 1 Setting alarm active state http 192 168 86 6 goform device cmd set amp alarmout type 1 200 OK r n Successful r n Normal Open and Normal Close are respectively refer to the initial Alarm_In or Alarm_Out interface the circuit is normally or initially at Open circuit or at Close circuit This could be different based on the 3 party device e g Door Strike Siren etc Please refer to the User Manual of the 3 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 47 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Example 2 Alarm Type Alarm Status Result alarmout type alarmout status OPEN IDLE no alarm output NORMAL OPEN alarmout type alarmout status CLOSE alarm output enabled NORMAL OPEN alarmout type alarmout status OPEN alarm output enabled NORMAL CLOSE alarmout type alarmout status CLOSE IDLE no alarm output NORMAL CLOSE alarmin type alarmin status OPEN IDLE no alarm input NORMAL OPEN alarmin type alarmin status CLOSE alarm input detected NOR
49. t int gt compatible to more SIP servers but may consume more network bandwidth enable_white_list lt int gt 0 1 0 No 1 Yes sipdoorenable lt int gt 0 1 Enable SIP open door 0 No 1 Yes sipdoorpwd lt string gt Number SIP open door password 0to9 Valid length 1 to 8 numeric digits sipdoortime lt int gt Open door timer timer before relay reset accessuploadaudiofile lt int gt 0 1 Chek uploaded audio file existence O No not exist 1 Yes exist only GET tel uri int 0 1 2 TEL URI 0 forbidden 1 User Phone 2 Enable sip_enable_tls lt int gt 0 1 2 SIP Transport Method 0 UDP 1 TCP 2 TLS TCP sip tls certificate string SIP TLS Certificate maximum 8192 byte sip tls private key string SIP TLS Key maximum 8192 byte sip tls private key password SIP TLS Key Password accesstlscrtfile int 0 1 Check TLS Certificate existence 0 Not exist 1 Yes exist only GET 0 1 accesstlskeyfile lt int gt Check TLS Key Existence 0 Not exist 1 Yes exist only GET Support cmd upload del e g Upload delete self defined audio files TLS certificate and TLS keys Will take effect upon next reboot file_type lt int gt Upload Del file 0 self defined file 1 SIP TLS certificate 2 SIP TLS private key 0 Default No file type http 192 168 86 6 goform sip cmd del delete uploaded files Grandstream Networks Inc Grandstream Video Surveillance H
50. th st nd A view6 jpg view jpa 1 and 2 stream respectively GXV3504 Only Example Capture a snapshot http lt servername gt snapshot view0 jpg Capture a snapshot of 2 stream http 192 168 86 146 snapshot view4 jpg Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 50 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 22 Web GUI Language http lt servername gt goform language cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description language lt int gt 0 1 2 0 English default 1 Chinese Simplified 2 Russian Example http servername goform language cmd set language 1 Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 51 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD 23 Decode Seitings For GXV3500 Only http lt servername gt gofrom decode cmd lt value gt amp lt parameter gt lt value gt lt parameter gt lt value gt Values Description decode_source lt int gt 0 1 Decode source 0 RTSP 1 SIPphone default decode int 0 7 Default decode channel enable_patrol lt int gt 0 1 Enable patrol 0 Disable 1 Enable video ouput type 0 3 0 Auto or NTSC 1 Auto or PAL 2 NTSC
51. ttp 1 0 200 OK r n productmode XXXxX r n hardwareversion V0 2B r n partnumber 9670000302B r n bootloaderversion 1 0 2 5 r n coreversion 1 2 0 1 r n baseversion 1 2 0 5 r nq firmwareversion 1 2 0 5 r n systemrun 641 r n mac 000B821EA32F r n TIPS of HTTP API Usage gt In most situation parameters fetched by using GET can be revised by using SET unless Status or Display parameter information gt When using SET sometimes there are inter action or restrictions among those related parameters all parameters must SET or configure correctly together before the device taking effect Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 6 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 GRANDSTREAM CONNECTING THE WORLD Please refer to related WebGUI page for reference if unsure about the HTTP API Grandstream Networks Inc Grandstream Video Surveillance HTTP API Page 7 of 62 www grandstream com Version 1 0 0 54 Last Updated 10 2015 URL Parameter Definitions GRANDSTREAM CONNECTING THE WORLD lt parameter gt lt value gt Values Description cmd lt string gt add remove set get Operation command type Required search reg add add client parameter remove delete client parameter set configure client parameter get fetch client parameter search search parameter e g Wi Fi ID reg register DDNS account channel lt int gt
Download Pdf Manuals
Related Search