This document provides an overview of the HTTP API for Grandstream video surveillance devices. It describes the URL formats, parameters, and responses that can be used to retrieve and set various device settings like audio, video, network, motion detection, and account management settings over HTTP. The API supports GET and POST methods and requires administrator privilege for authentication.
This document provides an overview of the HTTP API for Grandstream video surveillance devices. It describes the URL formats, parameters, and responses that can be used to retrieve and set various device settings like audio, video, network, motion detection, and account management settings over HTTP. The API supports GET and POST methods and requires administrator privilege for authentication.
Grandstream Video Surveillance API (Application Programming Interface) supports HTTP 1.0 protocol (RFC1945). This document explains in detail the parameter of functions in client side, via the supported GET/POST method. Users will require administrator privilege to retrieve or set the parameters. Software Version Requirement The current official firmwares from Grandstream about the surveillance products are all supported.
URL format: ClientServer http://<servername>/goform/<param>?cmd=<value>&<parameter>=<value>&... Note: <param> is used to mark the different function modules
Example 1: Get device status. http://<servername>/goform/systeminfo?cmd=get
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
- 4 - URL Parameter Definitions <parameter>=<value> Values Description cmd=<string> add/remove/set/get /search/reg Operation command type (Required). add: adding client parameter remove: deleting client parameter set: setting client parameter get: getting client parameter search: searching Wi-Fi SSID reg: registering DDNS account channel=<int> 0, 1, 2, 3 Channel 0-3: Some parameters require the assigned channel: e.g. audio/video setting and motion detection. If the channel is not assigned, the default channel 0 will be returned. For DVS, channel is: 0-3. This parameter not applied to IPCamera
Common URL Format Format Description The Corresponding Format Devices with multiple channels (GXV3504) will use channel number as separators when getting parameters. All the parameters are ordered by level. channel=0\r\n <param>=<value>\r\n
channel=1\r\n <param>=<value>\r\n
channel=2\r\n <param>=<value>\r\n
channel=3\r\n <param>=<value>\r\n
Index is used as mark when multiple parameters with same lever are applied.
e.g.: 16 motion detection regions in channel 0 channel=0\r\n . md.regn.index=0\r\n <param>=<value>\r\n
md.regn.index=1\r\n <param>=<value>\r\n
md.regn.index=2\r\n <param>=<value>\r\n
- 5 - md.regn.index=3\r\n <param>=<value>\r\n
count and id are used to differentiate when same lever of parameters with uncertain number of format used.
e.g.: Schedule of motion detect region md.regn.schedule.count=3\r\n md.regn.schedule.id=1 md.regn.index=0 md.regn.schedule.dayset=7 md.regn.schedule.starttime=0 md.regn.schedule.endtime=86399 md.regn.schedule.id=2 md.regn.index=0 md.regn.schedule.dayset=1 md.regn.schedule.starttime=0 md.regn.schedule.endtime=4879 md.regn.schedule.id=3 md.regn.index=1 md.regn.schedule.dayset=7 md.regn.schedule.starttime=0 md.regn.schedule.endtime=86399 . Responses from the Device HTTP/1.0 <HTTP code><HTTP text>\r\n
HTTP Code HTTP Text Description 200 OK Request successful. It does not mean set/delete/add successful until receiving Successful\r\n. Successful Need Reboot\r\n: configure successful but it would take effect after reboot. No Privilege\r\n: incorrect privilege. <param>Invalid\r\n: invalid parameter. <param>Missing\r\n: missing parameter. 400 Bad Request Bad request or request failed. 401 Unauthorized Authorization failed. 404 Not Found Not found due to incorrect command format or incorrect data. 503 Service Unavailable This message returned when the server busy or unavailable (e.g.: retrieve/set/add/delete failed or busy)
Example: Request includes invalid file names. HTTP/1.0 404 Not Found\r\n
- 6 - PARAMETERS 1. Audio/Video Parameters Support method: cmd = set/get If devices support 2 streams, they are called primary stream and secondary stream, e.g.:
<parameter>=<value> Values Description channel=<int> 0, 1, 2, 3 Channel numbers in integer. Default 0 for IP Camera. video.primary.encoder=<int> video.secondary.encoder=<int> 96, 26 Video codec: 96: H264 26: MJ PEG (not supported by some models) This parameter needs to be set along with the parameter of bitrate. video.primary.resolution=<int> video.secondary.resolution=<int> width(2 bytes)| height(2 bytes) First 2 bytes for width of pixels; Last 2 bytes for height of pixels. Video resolution. Varies among different device models and the NTSC/PAL format used. video.primary.bitrate=<int> video.secondary.bitrate=<int> 16, 32, 64, 1024 Video bit rate. Varies among different device models. video.primary.brtype=<int> video.secondary.brtype=<int> 0, 1 0: VBR(Variable bitrate) 1: CBR(Constant bitrate) video.primary.framerate=<int> video.secondary.framerate=<int> 1-30 Frame rate. Varies among different device models and NTSC/PAL format. video.primary.iframe=<int> video.secondary.iframe=<int> 1-100 I frame interval. video.primary.imagequality=<int> video.secondary.imagequality=<int> 1-5 Image quality: Level 1-5. The lower the value the greater the image quality (only valid with VBR configuration) audio.primary.encoder=<int> audio.secondary.encoder=<int> 0, 1, 2, 3, 4 Audio codec. 0: pcmu 1: pcma 2: g726 (valid only for - 7 - GXV3601/350x/3611LL/3611H D/3615/3615W) 3. disabled 4. AAC (valid only for GXV3651FHD/3662HD/3615W P_HD/3500) Some device models may only support audio.primary.encoder (share "audio.primary.encoder") audio.primary.bitrate=<int> audio.secondary.bitrate=<int> 16, 32 Audio bitrate. Some device models may only support audio.primary.encoder (share audio.primary.encoder") audio.linein=<int> 0, 1 Audio input audio.lineout=<int> 0, 1 Audio output audio.microphone.volume=<int> (1-10) Valid for: GXV3601/3601 LL/3601HD/361 1LL/3611HD/35 01/3504/3615/3 615W
<parameter>=<value> Values Description channel=<int> 0, 1, 2, 3 Channel numbers in integer. Default 0 for IP Camera. osdposition=<int> 0, 1 Time OSD position. 0: top 1: bottom osdtimeshow=<int> 0, 1 Display the time OSD 0: Not display 1: Display osdtextshow=<int> 0, 1 OSD text: 0: Not display 1: Display osdopacity=<int> 0, 10, 20100.
OSD Opaque lever (%) (GXV3601/3601LL/3601HD/3611LL/3611 HD/3501/3504/3615/3615W Only) osdcolor =<string> (GXV3601/3601L L/3601HD/3611L OSD color 0xFFFFFE: Auto - 9 - L/3611HD/3501/3 504/3615/3615W Only) 0xFFFFFF: White 0xFF0000: Red 0x800080: Purple 0xFF6100: Orange 0x0000FF: Blue 0xFFFF00: Yellow 0x008000: Green 0x00FFFF: Cyan 0x000000: Black osdtext=<string> OSD; maximum 63 bytes. osdtextindex=<int> 0, 1, 2 OSD index number (pending)
<parameter>=<value> Values Description httpport=<int> HTTP port enabledhcp=<int> 0, 1 DHCP. 0: disable 1: enable ipaddress=<string> 192.168.1.123 IP Address. Not valid when starting DHCP. subnetmask=<string> 255.255.255.0 Subnet mask defaultgateway=<string> 192.168.1.1 Default gateway autodns=<int> 0, 1 0: Preferred DNS server 1: Automatically obtain DNS server dnsserver.primary=<string> Primary DNS server dnsserver.standby=<string> Backup/secondary DNS server
Example - 10 - http://192.168.86.6/goform/network?cmd=set&channel=0&autodns=1&ipadress=192.168. 86.145
200 OK\r\n Successful Need Reboot\r\n 4. Dynamic DNS (DDNS) Support cmd = set/get
<parameter>=<value> Values Description registeredstate=<int> 0, 1 Registration state. 0: Offline - 11 - 1: Online unregister=<int> 0, 1 Unregister on reboot. 0: No 1: Yes accountname=<string> Account name, max 127 Bytes. sipserver=<string> SIP server, max 255 Bytes. proxyserver=<string> Proxy server or IP address. userid=<string> SIP user ID, max 255 Bytes. authenticateid=<string> Authenticate ID. Could be the same or different as SIP UserID, max 127 Bytes. accountpassword=<string> Account password, max 127 Bytes. Only used for setting password, not for acquiring password. stunserver=<string> STUN server URI or IP: PORT, max 127 Bytes. sipstream=<int> 0, 1 0: Secondary 1: Primary audioencoder=<int> 0, 1 0: PCMU 1: PCMA Default is 0, PCMU. regexpiration=<int> Default is 3600 (in second), max 45 days. localsipport=<int> Local SIP port. Default is 5060. localrtpport=<int> 1024-30000 Local RTP port, 1024~30000 autohooktimer=<int> 0-65535 Auto hook timer, in second. 0: Never onhook. Default is 0. disable_audio=<int> 0, 1 0: No 1: Yes enable_keep_alive=<int> 0, 1 0: No 1: Yes direct_ip_call=<int> 0, 1 0: No 1: Yes enable_white_list=<int> 0, 1 0: No 1: Yes sipdoorenable=<int> 0, 1 Enable SIP open door. 0: No 1: Yes sipdoorpwd=<string> Number 0 to 9 SIP open door password. Valid length between 4 to 8 characters. sipdoortime=<int> SIP open door time (delay timer before close)
Phonebook settings. Support cmd = add/remove/get. - 12 -
<parameter>=<value> Values Description phone.count=<int> Total phonebook entries. phone.index=<int> 1, 2. Index of phonebook entries. phone.number=<string> Phone number, max 15 Bytes. phone.name=<string> Name/Note of phone number, max 127 Bytes. white_list_phone=<string> Phone numbers of incoming call white list. audio_warning_mode=<int> 0, 1 Audio warning mode. 0: No. Play alarm audio to the other party. 1: Yes. Establish 2-way audio. Default value is 1.
Example (URL) http://192.168.89.19/goform/sip?cmd=set&unregister=1&accountname=xkowen&sipserve r=192.168.89.207&userid=3028&authenticateid=3028&accountpassword=123456
http://192.168.89.19/goform/sip?cmd=add& white_list_phone=2222 http://192.168.89.19/goform/sip?cmd=remove& white_list_phone=2222,3333,4444, Delete phone numbers in white list
<parameter>=<value> Values Description productmode=<string> GXV3501, GXV3504, GXV3601, GXV3601HD/LL, GXV3611HD/LL, GXV3615W/P, GXV3651FHD, GXV3662HD, GXV3615WP_HD GXV3500 Device model may vary. hardwareversion=<string> V0.2B... Hardware version partnumber=<string> P/N number bootloaderversion=<string> BOOTLOADER version coreversion=<string> Core version baseversion=<string> Base version firmwareversion=<string> 0-59 Firmware version cameratype=<string> Camera type: brand and model. ddnsstate=<int> 0, 1, 2, 3, 4, 5, 6 DDNS Status 0 :Disable - 16 - 1 :Processing 2 :Success 3 :Account/Password Error 4 :Server blocking 5 :Stun Server error 6 :Database failed wifistate=<int> 0, 1 Wi-Fi Status 0: Disconnected 1: Connected systemrun=<string> System up time mac=<string> MAC Address ledstatus=<int> 0, 1 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
8. Account Management Support cmd = add/remove/set/get
<parameter>=<value> Values Description user.count=<int> >=1 Total user numbers user.index=<int> 1, 2 Index of users user.level=<int> 0, 1, 2 User Privilege. 0: administrator 1: user 2: anonymous user.name=<string> User namemax 23 Bytes user.password=<string> User password, max 63 Bytes anonymous.enable =<int> 0, 1 Allow anonymous login. 0: No 1: Yes
<parameter>=<value> Values Description enablesmtp=<int> 0, 1 Enable SMTP: 0: No 1: Yes smtpserver=<string> SMTP Server, max 255 Bytes smtpserverport=<int> SMTP Server port emailfrom=<string> From E-Mail address, max 63 Bytes emailuser=<string> E-mail user name, max 63 Bytes emailpassword=<string> E-mail password, max 63 Bytes emailto1=<string> To E-Mail address 1, max 63 Bytes emailto2=<string> To E-Mail address 2, max 63 Bytes emailto3=<string> To E-Mail address 3, max 63 Bytes enablessl=<int> 0, 1 Use SSL. 0: No 1: Yes smtptest=<int> 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
Example: Set SMTP parameters. When enablesmtp=1, the Email address format will be checked. http://192.168.86.66/goform/smtp?cmd=set&enablesmtp=0 (when enablesmtp=1, basic check will be performed to all the addresses) 200 OK\r\n Successful\r\n
<parameter>=<value> Values Description enableftp=<int> 0, 1 Enable FTP. 0: No 1: Yes ftpserver=<string> FTP server, max 255 Bytes ftpserverport=<int> FTP server port ftpuser=<string> FTP user name, max 23 Bytes ftppassword=<string> FTP password; it would not be sent along with parameters, max 63 Bytes ftppath=<string> FTP path, max 63 Bytes ftptest=<int> 1 To test FTP use ftptest =1. Other values do not work.
Return: ftptestresult =0: test failed with ftperrormessage ftptestresult =1: success
Example: Set FTP parameters. http://192.168.86.6/goform/ftp?cmd=set&ftpserver=123456&ftpserverport=111&ftpuser=a dmin&ftppath=admin
200 OK\r\n Successful\r\n
11. PTZ Settings Support cmd = set/get (Only available to GXV3501/3504/3500)
<parameter>=<value> Values Description protocol=<int> 0, 1 Select PTZ Protocal 0: PELCO-P 1: PELCO-D channel=<int> 0-3 (pending) baudrate=<int> 1200, 2400, 4800, 9600 Baud rate. May vary among different device models. - 19 - ptzparam=<int> 0-63 (Speed) 0-127 (Default position) PTZ speed or default position. For default position values, certain values between 0 to 127 have been already used. ptzcontrol=<int> 0, 1 PTZ Control. 0: Stop 1: Tilt Up 2: Tilt Down 3: Pan Left 4: Pan Rigjt 5: Pan to upper left corner 6: Pan to lower left corner 7: Pan to upper right corner 8: Pan to lower right corner 9: Zoom in 10: Zoom out 11: Focus near 12: Focus far 13: IRIS open 14: IRIS close 15: Turn to default position 16: Clear default position 17: Set default position 18: Auto Pan 19: Stop Auto Pan
Example: Set PTZ parameter. http://192.168.86.66/goform/ptz?cmd=set&ptzcontrol=4&ptzparam=31 (rotation and speed have to be used together)
200 OK\r\n Successful\r\n Note: ptzcontrol and ptzparam would both need to be included in the link
<parameter>=<value> Values Description alarmin.count=<int> 0, 1, 4 Numbers of alarm input supported by devices. - 20 - May vary among models. For example, IP camera supports 1 alarm input, GXV3504 supports 4. alarmin.index=<int> 0, 1, 2, 3 Index of alarm input alarmin.schedule.count=<int> 0, 1 Numbers of schedules alarmin.schedule.id=<int> 1, 2, 3 ID of schedules alarmin.schedule.dayset=<int> 0-7 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday 7: Everyday(default) alarmin.schedule.starttime=<int> 0-86399 Default is 0 (in seconds). Example: 12:39, starttime = 12*3600+39*60 alarmin.schedule.endtime=<int> 0-86399 Alarm event end time. Default is 86399 (in seconds). alarmout.stop=<string> yes Stop alarm output event.record.pretime=<int> 0-160 (video.primary.bitrate<256) 0-100 (video.primary.bitrate<512) 0-50 (video.primary.bitrate<1024) 0-25 (video.primary.bitrate>1024) Record Video From Pre-Alarm (in seconds). The range varies among different bitrate. event.record.aftertime=<int> 0-320 (video.primary.bitrate<256) 0-200 (video.primary.bitrate<512) 0-100 (video.primary.bitrate<1024) 0-50 (video.primary.bitrate>1024) Record Video to Post-Alarm (in seconds). The range varies among different bitrate. event.record.storage=<int> 1, 2 Alarm record storage method. 0: Do not save 1: SD card - 21 - 2: USB Flash Drive 3: DISK (This may not be available for some device models) event.record.uploadftp=<int> 0, 1 Record Video uploads to FTP Server. 0: disable 1: enable event.sipphone.enable=<int> 0, 1 Voice Alarm to SIP phone. 0: disable 1: enable event.alarmout.enable=<int> 0, 1 Enable/Disable alarm output. 0: disable. 1: enable. alarm in 1 corresponds alarm out 1; alarm in 2 corresponds alarm out 2;
event.uploadcenter.enable=<int> 0, 1 Upload to Alarm Center. This option has to be enabled for PC to receive alarm event notification 0: disable 1: enable event.shotemail.enable=<int> 0, 1 Email snapshot and store it to SD drive. Note: e-mail and storage devices have to be existed and enabled. 0: disable 1: enable
<parameter>=<value> Values Description md.channel.count=<int> 1, 4 Number of channels for motion detection. IP camera has only 1 channel; GXV3504 support 4 channels. md.channel.index=<int> 0, 1, 2, 3 Corresponding index for channels. IP camera: 1. 4 channel DVS: 0-3. md.active.enable=<int> 0, 1 Enable Motion Detection 0: No - 23 - 1: Yes md.regn.index=<int> 0-15 Motion Detection Region 0-15 md.regn.leftup=<int> First 2 bytes used for X; Last 2 bytes used for Y md.regn.rightdown=<int> 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=<int> 0-100 Sensitivity. The higher the value the greater the sensitivity md.regn.schedule.count=<int> 0, 1 Total number of schedule. md.regn.schedule.id=<int> 0, 1, 2, 3 Schedule ID (1-n). If ID is set to 0, all the schedules will be deleted. md.regn.schedule.dayset=<int> 0-7 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday 7: Everyday(default) md.regn.schedule.starttime=<int> 0-86399 Default is 0 (in seconds). Example: 12:39, starttime = 12*3600+39*60 md.regn.schedule.endtime=<int> 0-86399 Default is 86399 (in seconds). Example: 12:39, starttime = 12*3600+39*60 md.record.storage=<int> 0, 1, 2, 3 Alarm record storage method: 0: Do not save 1: SD card 2: USB Flash Drive 3: DISK (This may not be - 24 - available for some device model) event.record.pretime=<int> 0-160 (video.primary.bitrate<256) 0-100 (video.primary.bitrate<512) 0-50 (video.primary.bitrate<1024) 0-25 (video.primary.bitrate>1024) Record Video From Pre-Alarm (in seconds). This may vary among different bitrates. md.record.aftertime=<int> 0-320 (video.primary.bitrate<256) 0-200 (video.primary.bitrate<512) 0-100 (video.primary.bitrate<1024) 0-50 (video.primary.bitrate>1024) Record Video to Post-Alarm (in seconds). This may vary among different bitrates. md.record.uploadftp=<int> 0, 1 Record Video and upload to FTP Server. 0: enable 1: disable md.sipphone.enable=<int> 0, 1 Voice Alarm to SIP Phone. 0: enable 1: disable md.alarmout.enable=<int> 0, 1 Enable/Disable alarm output. 0: enable. 1: disable. alarm in 1 corresponds alarm out 1; alarm in 2 corresponds alarm out 2; md.uploadcenter.enable=<int> 0, 1 Upload to Alarm Center. This option has to be enabled for PC to receive alarm event notification. 0: enable 1: disable md.snapshot.enable=<int> 0, 1 Email snapshot and store it to USB card or SD drive. - 25 - Note: e-mail and storage devices have to be existed and enabled. 0: enable 1: disable Example Parameter settings. Delete a schedule which has id=1. http://192.168.86.6/goform/motiondetect?cmd=set&md.record.storage=1&md.record.after time=10&md.record.pretime=20&md.record.uploadftp=1&md.sipphone.enable=1&md.ala rmout.enable=1&md.uploadcenter.enable=1&md.snapshot.enable=1
HTTP/1.0 200 OK\r\n Successful\r\n
Example (URL) Note http://192.168.86.6/goform/motiondetect?cmd=set&md.active.enable=2 http://192.168.86.6/goform/motiondetect?cmd=set&md.regn.index=0&md.regn.leftup=1& md.regn.rightdown=26214800&md.regn.sensitivity=1
<parameter>=<value> Values Description storage.count=<int> 0 Total number of storage equipments storage.index=<int> 1, 101, 201 1: USB 101: SD 201: DISK storage.capacity=<string> Total storage capacity storage.usedspace=<stri ng> Used space (MB) - 27 - storage.freespace=<strin g> Free Space (MB) file.count=<int> Total numbers of saved files. file.index=<int> 1, 2, 3 File index file.size=<string> File size (MB) file.name=<string> 192.168.86.20_chn0_201 1_09_21_14_43_48.jpg
0_2_2011_09_21_13_32 _21_1718_1.avi File Name with path. It can be used to download that particular file. e.g. http://serverhost:port/file.name
Image file format: ip_channel_date_time.jpg AVI file format: channel_recordtype_date_time_f ilelength_endmark.avi storage_type=<int> 1, 2, 3 When formatting the storage device, use the storage type to specify. 1: Flash USB 2: SD Card 3: USB Disk (Pending)
Example: Delete a file from USB/SD card. http://192.168.86.95/goform/storage?cmd=remove&file.name=/mnt/sd/192.168.86.95_ch n1_2010_01_13_09_21_58.jpg
200 OK\r\n Successful\r\n
16. Maintenance/Upgrade Support cmd = set/get http://<servername>/goform/maintenance?cmd=<value>&<parameter>=<value>...
<parameter>=<value> Values Description restart=<string> yes Restart the device restore=<string> yes Reset settings to factory default update.viatype=<int> 1, 2, 3 Upgrade via: 1: TFTP 2: HTTP 3: HTTPS - 28 - upgrade.serverpath=<string> serverhost:port/dir Firmware Server path upgrade.cfgserverpath=<string> serverhost:port/dir Configuration server path, max 255 Bytes upgrade_cfg_xml_pwd=<string> XML config file password upgrade.automatic=<int> 0, 1 Automatic upgrade: 0: No 1: Yes upgrade.interval=<int> 60-525600 Automatic upgrade interval (in minutes)
Example: Set maintenance and upgrading parameters. http://192.168.86.6/goform/maintenance?cmd=set&upgrade.serverpath=192.168.86.1
200 OK\r\n Successful\r\n
17. Contrast, Saturation, Brightness and Chroma Support cmd = set/get
Note: Contrast, saturation, brightness and chroma have to be set at the same time. Otherwise, it would be 0(default). Color may not be available for some models.
<parameter>=<value> Values Description channel=<int> 0, 1, 2, 3 Assigned channel number. Default number for IP Camera is 0 brightness=<int> For GXV3501/3504/3600/3601/3612, (0-255)
For GXV3601LL/3611LL/3615/3615W , (0-60)
For GXV3601HD/3611HD, (0-5)
For GXV3651HD/3651FHD/3662HD/ 3500/ip1200/ip5150, (0-255) Brightness - 29 - contrast=<int> For GXV3501/3504/3600/3601/3612, (0-255)
For GXV3601LL/3611LL/3615/3615W , (0-7)
For GXV3601HD/3611HD, (0-3)
For GXV3651HD/3651FHD/3662HD/3 500/ip1200/ip5150, (0-255) Contrast saturation=<int> For GXV3501/3504/3600/3601/3612, (0-255)
For GXV3601LL/3611LL/3615/3615W , (0-63)
For GXV3601HD/3611HD, (0-8)
For GXV3651HD/3651FHD/3662HD/3 500/ip1200/ip5150, (0-255) Saturation chroma=<int> 0-255 Chroma (Chroma may not be available for some models) Default=<int> 3, 4 3: set default value 4: set color-enhancement default value (For GXV3601HD/3611HD only)
<parameter>=<value> Values Description devicename=<string> Device name channel=<int> 0-3 Channel number alarmin.type=<int> 0,1 0:Normal Open 1:Normal Close - 31 - alarmout.type=<int> 0,1 0:Normal Open 1:Normal Close alarmin.status=<int> 0,1 This is used to get the current state of the alarm in. 0: Open 1: Close alarmout.status=<int> 0,1 This is used to get the current state of the alarm in. 0: Open 1: Close alarm_output_time=<int> 0, 5,15, 30, 60, 180, 300, 600, 900,1800 0: keep alarm until manually turned off N: alarm off after N seconds gpio_pin_multiplex=<int> 0, 1 Extension port mode. 0: control mode (RS485) (default) 1: alarm input/output mode. (For IP960/IP1200/IP5150 only)
Example 1: Setting alarm active state. http://192.168.86.6/goform/device?cmd=set&alarmout.type=1
200 OK\r\n Successful \r\n
Example 2:
Alarm Type Alarm Status Result alarmout.type=NORMAL OPEN alarmout.status=OPEN IDLE, no alarm output alarmout.type=NORMAL OPEN alarmout.status=CLOSE alarm output enabled alarmout.type=NORMAL CLOSE alarmout.status=OPEN alarm output enabled alarmout.type=NORMAL CLOSE alarmout.status=CLOSE IDLE, no alarm output alarmin.type=NORMAL OPEN alarmin.status=OPEN IDLE, no alarm input alarmin.type=NORMAL OPEN alarmin.status=CLOSE alarm input detected alarmin.type=NORMAL alarmin.status=OPEN alarm input detected - 32 - CLOSE alarmin.type=NORMAL CLOSE alarmin.status=CLOSE IDLE, no alarm input
<parameter>=<value> Values Description channel=<int> 0-3 Channel number. (For single channel device, this could be skipped) state_record=<int> 0-4 0: No record 1: Manual record 2: Auto record 3: Alarm record 4: No storage device enable_time_table=<int> 0, 1 Enable record schedule. 0: No 1: Yes record_time_table=<string> Record schedule. This is a 168-character string with possible values 0 and 1. 0: No 1: Yes record_full_handle=<int> 1, 2 When the record is full, 1: Override the oldest record. 2: Stop recording. (Use channel 0 record only) - 38 - start_recort=<int> 0, 1 For record manually. 0: Stop 1: Start Manual record will fail if auto-record or alarm-record has started already.
Example: Set Record parameters. http://192.168.86.6/goform/sdrecord?cmd=set& channel =0& enable_time_table =1& record_time_table=010111111