Page 9
Auth Edit date Changes 1.0.0 XiaoJinsheng 2012-11-21 V1.0.0 1.0.1 Houzhen 2012-12-09 Add the following CGI command to set PT startup position: 1) setPTZSelfTestMode 2) getPTZSelfTestMode 3) setPTZPrePointForSelfTest 4) getPTZPrePointForSelfTest 1.0.2 XiaoJinsheng 2013-01-29 1. Add a snap CGI(snapPicture2) which retrun jpeg image data directly but a image url 2.
Page 11
Foscam IPCamera CGI User Guide 2.The example description command-setMotionDetectConfig, setScheduleSnapConfig, setIOAlarmConfig 1.0.8 Houzhen 2014-1-17 1.Add commmad: getRecordList2,reloadRecordindex 1.0.9 Houzhen 2014-3-15 1.Add command: getRatio, setRatio 2.Modify command: 1) The example of command: setCruisePrePointLingerTime, getCruisePrePointLingerTime. 2) The return discription of command: getProductWpsFlag.
Page 12
1.Add command: getDeFrameLevel, setDeFrameLevel 1.0.12 Houzhen 2014-7-9 1.Modify: 1) The parameter description of command setContrast. 1.0.13 PengMengjia 2014-11-24 integrate the CGI on all platforms and add new command 1.0.14 LeeJunliang 2015-5-10 1.Del command: 1)setMusicPlayPath,getMusicPlayPath 2.Modify command: 1)getMotionDetectConfig,setMotionDetectCon fig,setIOAlarmConfig,getIOAlarmConfig,getTe mperatureAlarmConfig.setTemperatureAlarmC onfig,getHumidityAlarmConfig,setHumidityAl armConfig,addMusicList,delMusicList 1.0.15...
Page 13
Foscam IPCamera CGI User Guide utoAdaptability;getAudioSendMethod;getNet Mode;wifiTest; 1.0.19 BaiShiYi 2016-12-08 Add command: setFtpConfigNew;testFtpServerNew;setSMT PConfigNew;smtpTestNew This document is for latest version.if you use this document for develop, your camera’s version must be latest. Copyright@ Shenzhen Foscam Intelligent Technology Limited...
We only support GET and POST method. Only importConfig and fwUpgrade can support POST method. The cgi request string must be encode in url format. URL encode rule: The following chars will not be encoded: [A~Z] [a~z] [0~9] + @ * / The other chars will be encoded into hex format.
Foscam IPCamera CGI User Guide 2. All Platform CGI AV Function getImageSetting Function Get color attribute of video privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getImageSetting Param None brightness Return 0~100 contrast 0~100 0~100 saturation 0~100 sharpness 0~100 denoiseLevel Not use Note Example /cgi-bin/CGIProxy.fcgi?cmd=getImageSetting&usr=admin&pwd=...
Foscam IPCamera CGI User Guide Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setContrast&constrast=50&usr=admin&pwd= setHue Function Set hue of video privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setHue Param 0~100 Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setHue&hue=50&usr=admin&pwd= setSaturation Function Set saturation of video privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setSaturation Param saturation 0~100...
Foscam IPCamera CGI User Guide privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setSharpness Param DenoiseLevel 0~100 Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setDenoiseLevel&level=50&usr=admin&pwd= resetImageSetting Function Reset color parameters to default value privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=resetImageSetting Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=resetImageSetting&usr=admin&pwd= getMirrorAndFlipSetting Function Get mirror and flip attribute of video...
Foscam IPCamera CGI User Guide 1 Mirror Return None Note Example isMirror=1 &usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=mirrorVideo& flipVideo Function Flip video privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=flipVideo Param isFlip 0 Not flip 1 Flip Return None Note Example isFlip=1 &usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=flipVideo& getRatio Function Get value for image distortion correction...
Foscam IPCamera CGI User Guide Usage /cgi-bin/CGIProxy.fcgi?cmd=getScheduleRecordStreamChn Param None Return 0 main stream 1 sub stream Note Example /cgi-bin/CGIProxy.fcgi?cmd=getScheduleRecordStreamChn&usr=admin&pwd= setScheduleRecordStreamChn Function Set stream channel for schedule record privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setScheduleRecordStreamChn Param 0 main stream 1 sub stream Return None...
Foscam IPCamera CGI User Guide Param None resolutionN Return Resolution of stream type N bitRateN Bit rate of stream type N (20480~2097152) frameRateN Frame rate of stream type N GOPN P frames between I frame of stream type N isVBRN...
Foscam IPCamera CGI User Guide isVBRN Not in use currentlly Note N means streamType [0~3] Example /cgi-bin/CGIProxy.fcgi?cmd=getSubVideoStreamParam&usr=admin&pwd= setSubVideoStreamParam Function Set the sub video stream param of stream N privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setSubVideoStreamParam Param streamType resolution Resolution of stream type N...
Motion Jpeg, then stream command: /cgi-bin/CGIStream.cgi?cmd=GetMJStream, but when you login as a sub stream user, the stream data will be same as main stream. Example /cgi-bin/CGIProxy.fcgi?cmd=setSubStreamFormat&format=0&usr=admin&pwd= GetMJStream...
Foscam IPCamera CGI User Guide Return Motion jpeg stream data Note 1) Motion jpeg stream data is returned from https server by a serverpush mode 2) MJ stream is VGA resolution @ 15fps 3) For some version of Firefox browse, the Firefox will crash when use “GetMJStream”...
Foscam IPCamera CGI User Guide privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setOSDSetting Param isEnableTimeStamp Time stamp will display on screen or not isEnableDevName Camera name will display on screen or not dispPos OSD display position, currently can only be 0 Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setOSDSetting&isEnableTimeStamp=1&isEnableD...
Foscam IPCamera CGI User Guide getOSDMask Function Get OSD mask status privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getOSDMask Param None isEnableTimeStamp Return Time stamp will display on screen or not isEnableDevName Camera name will display on screen or not dispPos OSD display position, currently can only be 0...
The time of which motion detect alaram can trigger again when a motion detection has happened.P.s.The true value of triggerInterval time is the value of the cgi get add 5s. isMovAlarmEnable Is enable motion alarm detect isPirAlarmEnable Is enable Passive Infrared alarm detect...
Page 28
Foscam IPCamera CGI User Guide triggerInterval The time of which motion detect alaram can trigger again when a motion detection has happened.P.s.The true value of triggerInterval time is the value of the cgi set add 5s. isMovAlarmEnable Disable Enable isPirAlarmEnable...
40 41 42 43 44 45 46 47 Foscam IPCamera CGI User Guide Each grid of a row presents half of an hour of one day. For example, 40 presents 20:00 ~20:30. The bit 40 set to “1” means the motion detection is effective between 20:00 to 20:30...
Foscam IPCamera CGI User Guide isEnableLocalAlar Return Disable mRecord Enable localAlarmRecordS Recording time Note Example /cgi-bin/CGIProxy.fcgi?cmd=getLocalAlarmRecordConfig&usr=admin&pwd= getSnapConfig Function Get snap config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getSnapConfig Param None snapPicQuality Return Low quality Normal quality High quality saveLocation Save to sd card...
Foscam IPCamera CGI User Guide getScheduleSnapConfig Function Get schedule snap config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getScheduleSnapConfig Param None isEnable Return Is enable motion detect alarm snapInterval The interval time to snap picture again scheduleN The motion alaram schedule of one week,...
40 41 42 43 44 45 46 47 Foscam IPCamera CGI User Guide Wednesday Tuesday Friday Saturday Sunday Each grid of a row presents half of an hour of one day. For example, 40 presents 20:00 ~20:30. The bit 40 set to “1” means the snap is effective between 20:00 to 20:30...
Foscam IPCamera CGI User Guide endTime End time for research recordType Recort type startNo Start no totalCnt Return Total record count curCnt Current record count recordN N(0-9), Record information Note Example /cgi-bin/CGIProxy.fcgi?cmd=getRecordList&usr=admin&pwd= getRecordList2 Function Get record list privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getRecordList2...
Foscam IPCamera CGI User Guide getAlarmRecordConfig Function Get alarm record config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getAlarmRecordConfig Param None isEnablePreRecord Return Preview record state preRecordSecs Preview record time alarmRecordSecs Alarm record time Note Example /cgi-bin/CGIProxy.fcgi?cmd=getAlarmRecordConfig&usr=admin&pwd= setAlarmRecordConfig Function Set alarm record config privilege...
Foscam IPCamera CGI User Guide setRecordPath Function Set record path for storage privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setRecordPath Param path 0-SD card,2-FTP server 3-SD card and cloud setResult Return success Sd card is not exist Share direction is not set Not enough space...
Foscam IPCamera CGI User Guide setScheduleRecordConfig Function Set schedule recordconfig privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setScheduleRecordConfig isEnable Param Schedule-Record enable status, 0-disable,1-enable recordLevel Level for drop frame,0-30/30,1-24/30,2-15/30,3-8/30, 4-4/30,5-1/30; spaceFullMode The process method when SD card is full,0-cover the oldest video and continue record,1-stop record...
Alarm level,0-Low,1-high,trigger alarm snapInterval Interval for snap picture triggerInterval Interval for trigger alarm again,P.s.The true value of triggerInterval time is the value of the cgi set add 5s. scheduleN N(0-6), alarm schedule Return Set result(0-success,-1-error) Note Example /cgi-bin/CGIProxy.fcgi?cmd=setIOAlarmConfig&usr=admin&pwd=&isEnable=1 snapInterval=2 &...
Foscam IPCamera CGI User Guide Note Example /cgi-bin/CGIProxy.fcgi?cmd=getPCAudioAlarmCfg&usr=admin&pwd= getMultiDevList Function Get multi device list privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getMultiDevList Param None Return devN N(0-8), device information Note Example /cgi-bin/CGIProxy.fcgi?cmd=getMultiDevList&usr=admin&pwd= getMultiDevDetailInfo Function Get multi device information privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getMultiDevDetailInfo Param chnnl...
Foscam IPCamera CGI User Guide Device Ip port Web port mediaPort Media port userName User name passWord Password devName Device name Return Add result(0-success,-1-error) Note Example chnnl =2& product /cgi-bin/CGIProxy.fcgi?cmd=addMultiDev&usr=admin&pwd=& Type =H264& ip=192.168.1.3 & port=88 & mediaPort =88 &userName=admin&pass Word=&devName=FI9805W...
Foscam IPCamera CGI User Guide Usage /cgi-bin/CGIProxy.fcgi?cmd=getDeframeLevel Param None Return level 0 -Disable the status of enhance 1 -Enable the status of enhance Note Example /cgi-bin/CGIProxy.fcgi?cmd=getDeframeLevel&usr=admin&pwd= getNetworkAutoAdaptability Function Network Auto Adaptability flag Get status of privilege operator Usage NetworkAutoAdaptability /cgi-bin/CGIProxy.fcgi?cmd=get...
Foscam IPCamera CGI User Guide Note 类似格式: "HD816P V2":[{ "MSRL": "1280*720", "MSRLV": "MSFR": 30, "MSBR": "4M" Example /cgi-bin/CGIProxy.fcgi?cmd=getMainStreamCapabilities&usr=admin&pwd= getSubStreamCapabilities Function Network Auto Adaptability flag Get status of privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getSubStreamCapabilities Param None Return Json 格式数据 Note getMainStreamCapabilities 返回格式 同...
Foscam IPCamera CGI User Guide User account addAccount Function Add user account privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=addAccount Param usrName user name usrPwd user password privilege Visitor Operator Administrator Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=addAccount&usrName=test&usrPwd=test&privileg e=0& usr=admin&pwd= delAccount Function Delete user account privilege...
Foscam IPCamera CGI User Guide Example /cgi-bin/CGIProxy.fcgi?cmd=getPassword&usrName=test&usr=admin&pwd= changePassword Function Change password privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=changePassword Param usrName The user you want to change password oldPwd old password newPwd new password Return None Note Admin can change every user’s password, visitor and operator can only change...
Foscam IPCamera CGI User Guide newUsrName New user name oldPwd old password newPwd new password Return None Note Admin can change every user’s name, visitor and operator can only change their own name Example /cgi-bin/CGIProxy.fcgi?cmd=changeUserNameAndPwdTogether&usrName=ad min&newUsrName=newname&oldPwd=&newPwd=newpwd&usr=admin&pwd= logIn Function User log in to camera...
Foscam IPCamera CGI User Guide logOut Function User log out to camera privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=logOut Param usrName User name Access IP groupId An id use to distinguish different users,can be set to current cpu tick Return logOutResult Note Example /cgi-bin/CGIProxy.fcgi?cmd=logOut&usrName=admin&ip=192.168.1.12&groupI...
Foscam IPCamera CGI User Guide usrBeatHeart Function user checks connection with camera privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=usrBeatHeart Param usrName User name remoteIp Access IP groupId An id use to distinguish different users,can be set to current cpu tick Return checkResult(0-success,-1-error) Note Example /cgi-bin/CGIProxy.fcgi?cmd=usrBeatHeart&usrName=admin&ip=192.168.1.13...
Foscam IPCamera CGI User Guide ptzMoveLeft Function Move to left privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveLeft Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveLeft&usr=admin&pwd= ptzMoveRight Function Move to right privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveRight Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveRight&usr=admin&pwd= ptzMoveTopLeft Function Move to top left...
Foscam IPCamera CGI User Guide Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveTopRight&usr=admin&pwd= ptzMoveBottomLeft Function Move to bottom left privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveBottomLeft Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveBottomLeft&usr=admin&pwd= ptzMoveBottomRight Function Move to bottom right privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzMoveBottomRight Param None Return...
Foscam IPCamera CGI User Guide privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzReset Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzReset&usr=admin&pwd= getPTZSpeed Function Get the speed of PT privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=getPTZSpeed Param None Return speed Very slow Slow Normal speed Fast Very fast Note Example /cgi-bin/CGIProxy.fcgi?cmd=getPTZSpeed&usr=admin&pwd=...
Foscam IPCamera CGI User Guide getPTZPresetPointList Function Get all preset point privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=getPTZPresetPointList Param None Return Current preset point count pointN The name of point N Note Our device can support at most 16 preset point We have 4 point default:LeftMost\RightMost\TopMost\BottomMost Example /cgi-bin/CGIProxy.fcgi?cmd=getPTZPresetPointList&usr=admin&pwd=...
Foscam IPCamera CGI User Guide ptzGotoPresetPoint Function Goto preset position privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzGotoPresetPoint Param name Preset point name Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzGotoPresetPoint&name=test&usr=admin&pwd ptzGetCruiseMapList Function Get all cruise map list privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzGetCruiseMapList Param None Return Current cruise map point count...
Foscam IPCamera CGI User Guide ptzSetCruiseMap Function Add a cruise map privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzSetCruiseMap Param name Name of the cruise map pointN The name of preset point N Return None Note Our device can support at most 8 preset point one cruise map Example /cgi-bin/CGIProxy.fcgi?cmd=ptzSetCruiseMap&name=test&point0=test0&point...
Foscam IPCamera CGI User Guide Usage /cgi-bin/CGIProxy.fcgi?cmd=ptzStopCruise Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=ptzStopCruise&usr=admin&pwd= setCruiseTime Function Set time for continue cruise privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=setCruiseTime Param time Time for continue cruise Return None Note Example time =5&usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=setCruiseTime& getCruiseTime Function...
Foscam IPCamera CGI User Guide getCruiseTimeCustomed Function Set time for continue cruise by costomer privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=getCruiseTimeCustomed Param time Return Customed time for continue cruise customed Customed enable state-0-no,1-yes Note Example /cgi-bin/CGIProxy.fcgi?cmd=getCruiseTimeCustomed&usr=admin&pwd= setCruiseLoopCnt Function Set counts for continue cruise...
Foscam IPCamera CGI User Guide Param mode Control mode-0:by time,1:by loop count Return None Note Example mode =0&usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=setCruiseCtrlMode& getCruiseCtrlMode Function Get control mode for continue cruise, by time or count privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=getCruiseCtrlMode Param Return mode Control mode-0:by time,1:by loop count...
Foscam IPCamera CGI User Guide dmin&pwd= zoomIn Function Zoom in privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=zoomIn Param None Return None Note Only supported by the device has zoom lens Example /cgi-bin/CGIProxy.fcgi?cmd=zoomIn&usr=admin&pwd= zoomOut Function Zoom out privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=zoomOut Param None Return...
Foscam IPCamera CGI User Guide Param None Return speed Slow Normal Fast Note Only supported by the device has zoom lens Example /cgi-bin/CGIProxy.fcgi?cmd=getZoomSpeed&usr=admin&pwd= setZoomSpeed Function Set the speed of PTZ privilege operator Usage /cgi-bin/CGIProxy.fcgi?cmd=setZoomSpeed Param speed Slow Normal Fast Return...
Foscam IPCamera CGI User Guide Usage /cgi-bin/CGIProxy.fcgi?cmd= getPTZSelfTestMode Param None Return mode No selftest Normal selftest After normal selftest, then goto presetpoint-appointed Return None Note Only supported by ipc that can enable ptz-selftest Example /cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=getPTZSelfTestMode setPTZPrePointForSelfTest Function Set presetpoint for selftest of PTZ...
Foscam IPCamera CGI User Guide Param rs485Protocol Protocol rs485Addr Address rs485Baud Baud rate rs485DataBit DataBit rs485StopBit StopBit rs485Check Parity Return None Note Only supported by ipc that can enable 485 Example /cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=set485Info&rs485Protocol =0&rs485Addr=1&rs485Baud=1200&rs485DataBit=7&rs485StopBit=1&rs 485Check=0 get485Info Function Get informations of 485...
The first dns server addr dns2 The second dns server addr Return None Note System will reboot automatically to take effect after call this CGI command Example /cgi-bin/CGIProxy.fcgi?cmd=setIpInfo&isDHCP=0&ip=192.168.1.88&gate=192 .168.1.1&mask=255.255.255.0&dns1=192.168.1.1&dns2=192.168.1.1&usr=a dmin&pwd= refreshWifiList Function Start scan the aps around privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=refreshWifiList...
Foscam IPCamera CGI User Guide getWifiList Function Get the aps around after refreshWifiList privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getWifiList Param startNo The start NO of the ap list you want to get. For example:The are 30 aps around you, you want to look at the...
Foscam IPCamera CGI User Guide The psk of WPA WPA2 authMode Open mode Shared key Auto mode keyFormat ASIC defaultKey key1 key2 key3 key4 key1Len 64 or 128 key2Len 64 or 128 key3Len 64 or 128 key4Len 64 or 128...
Foscam IPCamera CGI User Guide Ad-hoc Not supported yet encryptType Open mode WPA2 WPA/WPA2 The psk of WPA WPA2(url encoded) authMode Open mode Shared key Auto mode keyFormat ASIC defaultKey key1 key2 key3 key4 key1Len 64 or 128 key2Len 64 or 128...
Foscam IPCamera CGI User Guide connected Connedted ap ssid AP name encryptTyp Open mode WPA2 WPA/WPA2 The psk of WPA WPA2 authMode Open mode Shared key Auto mode keyFormat ASIC defaultKey key1 key2 key3 key4 key1Len 64 or 128 key2Len...
Onvif Port( default value is 888 ) Note .You can call this CGI command without usr or pwd section onvifPort param only for onvif camera, the camra which does not has onvif function does not have this param Example /cgi-bin/CGIProxy.fcgi?cmd=getPortInfo&usr=admin&pwd=...
Foscam IPCamera CGI User Guide password password Return None Note This command can only be used to set the third party ddns Example /cgi-bin/CGIProxy.fcgi?cmd=setDDNSConfig&isEnable=1&hostName=test.dyn dns.org&ddnsServer=4&user=test&password=test&usr=admin&pwd= setFtpConfig Function Set FTP config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setFtpConfig ftpAddr Param FTP server address, you can contain sub directory in it...
Foscam IPCamera CGI User Guide Note Example /cgi-bin/CGIProxy.fcgi?cmd=setFtpConfigNew&ftpAddr=ftp://192.168.1.2/sbuD ir&ftpPort=21&mode=0&userName=test&password=49,50,51,38&usr=admin& pwd= getFtpConfig Function Get FTP config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getFtpConfig Param None ftpAddr Param FTP server address, you can contain sub directory in it ftpPort FTP port mode PASV mode PORT mode...
Foscam IPCamera CGI User Guide tpPort=21&mode=0&fptuserName=test&ftppassword=test&usr=admin&pwd= testFtpServerNew Function Password to support special characters ) Test FTP server ( privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=testFtpServerNew ftpAddr Param FTP server address, you can contain sub directory in it ftpPort FTP port mode PASV mode...
Foscam IPCamera CGI User Guide STARTTLS user user name password password sender reciever Use “,” between 2 senders, for exapler: aaa@123.com,bbb@456.com Note Example /cgi-bin/CGIProxy.fcgi?cmd=getSMTPConfig&usr=admin&pwd= setSMTPConfig Function set mail config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setSMTPConfig Param isEnable is enable camera send mail?
Foscam IPCamera CGI User Guide Param isEnable is enable camera send mail? server SMTP server address port smtp port isNeedAuth Need auth user account or not None STARTTLS user user name password Encoded password Eg: if your password is “123&” ,you must use “49,50,51,38”...
Foscam IPCamera CGI User Guide Return testResult Success Fail Note Example smtpServer =smtp.gmail.com&port=587 /cgi-bin/CGIProxy.fcgi?cmd=smtpTest& &isNeedAuth=1&user=test&password=test&sender=test@gmail.com&usr=ad min&pwd= smtpTestNew Function Password to support special characters ) Test mail setting ( privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=smtpTestNew Param smtpServer SMTP server address port smtp port...
Foscam IPCamera CGI User Guide Usage /cgi-bin/CGIProxy.fcgi?cmd=setP2PEnable enable Disable Enable Return None Note Example enable =1&usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=setP2PEnable& getP2PEnable Function Get p2p status privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getP2PEnable Param None enable Disable Enable Note Example /cgi-bin/CGIProxy.fcgi?cmd=getP2PEnable&usr=admin&pwd= setP2PPort Function Set p2p port privilege...
Foscam IPCamera CGI User Guide Param None Return netMode 0:wired 1:wireless Note Example getNetMode &usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd= wifiTest Function Wifi connect test privilege admin Usage wifiTest /cgi-bin/CGIProxy.fcgi?cmd= Param isEnable Enable state isUseWifi Use wifi or not ssid AP name netType Infra net...
Foscam IPCamera CGI User Guide password.if you are old platform you need not use it. Eg: using this param ,if your password is “123&”,you must use “49,50,51,38” instead it .(Each character must use ASCCI code conversion, and separated by commas characters)
Foscam IPCamera CGI User Guide hour minute Return None Note This command can only be used to set the third party ddns Example /cgi-bin/CGIProxy.fcgi?cmd=setSystemTime&timeSource=1&ntpServer=&date Format=0&timeFormat=0&timeZone=0&isDst=0&dst=0&year=2012&mon=1& day=6&hour=9&minute=35&sec=0&usr=admin&pwd= getSystemTime Function Get system time privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getSystemTime Param None Return timeSource Get time from NTP server...
Foscam IPCamera CGI User Guide minute Note This command can only be used to set the third party ddns Example /cgi-bin/CGIProxy.fcgi?cmd=getSystemTime&usr=admin&pwd= openInfraLed Function Force open infra led privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=openInfraLed Param None ctrlResult Return Success Fail Note Example /cgi-bin/CGIProxy.fcgi?cmd=openInfraLed&usr=admin&pwd=...
Foscam IPCamera CGI User Guide setInfraLedConfig Function Set infra led config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setInfraLedConfig&mode=0 mode Param Auto mode Manual mode Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setInfraLedConfig&mode=&usr=admin&pwd= getScheduleInfraLedConfig Function Get config for infra led switch schedule privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getScheduleInfraLedConfig Param...
Foscam IPCamera CGI User Guide getDevState Function Get all device state privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getDevState Param None IOAlarm Return Disabled No alaram Detect alarm motionDetectAlar Disabled No alarm Detect alarm soundAlarm Disabled No alarm Detect alarm record Not in recording...
Foscam IPCamera CGI User Guide Note Example /cgi-bin/CGIProxy.fcgi?cmd=getDevState&usr=admin&pwd= getDevName Function Get camera name privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getDevName Param None devName Return Camera name Note Example /cgi-bin/CGIProxy.fcgi?cmd=getDevName&usr=admin&pwd= setDevName Function Set camera name privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setDevName devName Param Camera name Return...
Foscam IPCamera CGI User Guide hour timeZone Time zone firmwareVer Firmware version hardwareVer Hardware version Note Example /cgi-bin/CGIProxy.fcgi?cmd=getDevInfo&usr=admin&pwd= getDevAttr Function Get camera dev attr privilege visitor Usage getDevAttr /cgi-bin/CGIProxy.fcgi?cmd= Param None alarmAttr Return Bit[0]:motion;Bit[1]:sound;Bit[2]:io;Bit[3]:temperature;Bit[4]: humidiy; Note Example getDevAttr &usr=admin&pwd= /cgi-bin/CGIProxy.fcgi?cmd=...
Foscam IPCamera CGI User Guide Param None modelName Return Camera model name Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductModelName&usr=admin&pwd= getProductLanguage Function Get camera main language privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductLanguage Param None language Return Camera main language Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductLanguage&usr=admin&pwd= getProductSensorType Function Get camera sensor type number...
Foscam IPCamera CGI User Guide getProductSdFlag Function Whether camera support sd card privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductSdFlag Param None sdFlag Return Camera flag to support sd card-0:no,1:yes Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductSdFlag&usr=admin&pwd= getProductOutdoorFlag Function Whether camera is outdoor machine privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductOutdoorFlag...
Foscam IPCamera CGI User Guide zoomFlag Return 0:no,1:yes Whether camera is zoom machine- Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductZoomFlag&usr=admin&pwd= getProductRs485Flag Function Whether camera support rs485 privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductRs485Flag Param None rs485Flag Return 0:no,1:yes Whether camera support rs485- Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductRs485Flag&usr=admin&pwd= getProductIoAlarmFlag Function...
Foscam IPCamera CGI User Guide getProductP2pFlag Function Whether camera support P2p privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductP2pFlag Param None p2pFlag Return 0:no,1:yes Whether camera support p2p- Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductP2pFlag&usr=admin&pwd= getProductWpsFlag Function Whether camera support Wps privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductWpsFlag Param None wpsFlag...
Foscam IPCamera CGI User Guide talkFlag Return 0:no,1:yes Whether camera support audio for talk- Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductTalkFlag&usr=admin&pwd= getProductAppVer Function Get camera application version privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getProductAppVer Param None appVer Return camera application version Note Example /cgi-bin/CGIProxy.fcgi?cmd=getProductAppVer&usr=admin&pwd= getProductAllInfo Function Get camera Information...
Foscam IPCamera CGI User Guide Note Only Lan net use Example language=0 & talkFlag=1& &usr /cgi-bin/CGIProxy.fcgi?cmd=setProductAllInfo& =admin&pwd= getNVRApSigQuality Function Get camera application version privilege visitor Usage getNVRApSigQuality /cgi-bin/CGIProxy.fcgi?cmd= Param ssid Check ssid name NVRApSigQu Return Ssid signal value ality Note...
Foscam IPCamera CGI User Guide Note Example setVoiceEnableState &isEnable=1&usr=admin&pwd /cgi-bin/CGIProxy.fcgi?cmd= getGeneratePubKey Function Get public key generated by camera for software reset privilege visitor Usage /cgi-bin/CGIProxy.fcgi?cmd=getGeneratePubKey Param None genResult Return The result that camera generate public key for software reset genPubLen...
Foscam IPCamera CGI User Guide MISC getFirewallConfig Function Get firewall config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getFirewallConfig Param None Return isEnable Use firewall or not rule The ip list can’t access Only allow the ip list to access ipListN The ip address(Network address) of list N...
Note We can have 1000 record of log at most. We can get 10 log at most one time Example /cgi-bin/CGIProxy.fcgi?cmd=getLog&offset=0&count=20&usr=admin&pwd= 3. All platform except 3518A add cgi getAudioVolume Function Get Audio Volume privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getAudioVolume...
Top temperature lowerLimit Lower temperature snapInterval Interval for snap picture triggerInterval Interval for trigger alarm again,P.s.The true value of triggerInterval time is the value of the cgi get add 5s. scheduleN N(0-6), alarm schedule Note Example /cgi-bin/CGIProxy.fcgi?cmd=getTemperatureAlarmConfig&usr=admin&pwd= setTemperatureAlarmConfig Function...
Top temperature lowerLimit Lower temperature snapInterval Interval for snap picture triggerInterval Interval for trigger alarm again,P.s.The true value of triggerInterval time is the value of the cgi set add 5s. scheduleN N(0-6), alarm schedule Return None Note Example isEnable=1&linkag /cgi-bin/CGIProxy.fcgi?cmd=setTemperatureAlarmConfig&...
Get music start from startNo musicNum Expect to get music numbers Return getResult Sucess Faild Musics number of current m usic l ist hadGet Current CGI had get music numbers music0 Music0 name music1 Music1 name music2 Music2 name music3 Music3 name...
Foscam IPCamera CGI User Guide music4 Music4 name music5 Music5 name music6 Music6 name music7 Music7 name music8 Music8 name music9 Music9 name music10 Music10 name music11 Music11 name music12 Music12 name music13 Music13 name music14 Music14 name music15 Music15 name...
Foscam IPCamera CGI User Guide Fail,music list had alaready exist Fail,music number had exceed max number Fail,music list had not exist Cgi param_error List number curListName Current list name list0 List0 name list1 List1 name list2 List2 name Note Example /cgi-bin/CGIProxy.fcgi?cmd=addMusicList&name=1&music0=1.wav&music1=...
Foscam IPCamera CGI User Guide setMusicPlayMode Function Set Musics Play Mode privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayMode&mode=1 Param mode order One loop List loop Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayMode&mode=1&usr=admin&pwd= getMusicPlayMode Function Get Musics Play Mode privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getMusicPlayMode Param None Return...
Foscam IPCamera CGI User Guide setMusicPlayPre Function Play Precede Music privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayPre Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayPre&usr=admin&pwd= getMusicPlayState Function Get Music Play State privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getMusicPlayState Param None retResult Return Success Faild Music total number...
Foscam IPCamera CGI User Guide List loop index Music number index name List name Return None Note Example mode=1&index=0&name=defa /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayStart& ult &usr=admin&pwd= setMusicPlayStop Function Stop Play Music privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayStop Param None Return None Note Example /cgi-bin/CGIProxy.fcgi?cmd=setMusicPlayStop&usr=admin&pwd= setMusicDormantTime Function...
Foscam IPCamera CGI User Guide iProperty For record (default = 1) isEnableAudio Audio is enable(yes = 1 no = 0) isMainStream Is main stream(main = 1 sub = 0) szStreamId Stream id,get from baidu register interface szPublishToken Have defaults,get from embed szGuid Have defaults,get from embed...
Foscam IPCamera CGI User Guide GetOnlineUpgradeState Function Get online upgrade state privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=GetOnlineUpgradeState Param None Return state normal upgrading fail File check ok (fosbaby_P1 use) progress Errno normal Net error File error Internal error Note Example /cgi-bin/CGIProxy.fcgi?cmd=GetOnlineUpgradeState&usr=admin&pwd= 5. FosBaby_P1 CGI(Only)
Foscam IPCamera CGI User Guide snapInterval Interval for snap picture triggerInterval Interval for trigger alarm again,P.s.The true value of triggerInterval time is the value of the cgi get add 5s. scheduleN N(0-6), alarm schedule Note Example /cgi-bin/CGIProxy.fcgi?cmd=getHumidityAlarmConfig&usr=admin&pwd= setHumidityAlarmConfig Function Set Humidity Alarm Config...
Foscam IPCamera CGI User Guide getHumidityState Function Get Humidity Value privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getHumidityState Param None humidity Return Humidity % ! Note Example /cgi-bin/CGIProxy.fcgi?cmd=getHumidityState&usr=admin&pwd= setNightLightState Function Set Night Light State privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setNightLightState Param state Nightlight Off Nightlight On...
Foscam IPCamera CGI User Guide Disable Timing Reboot intervalDay One week One month Note Example /cgi-bin/CGIProxy.fcgi?cmd=getTimingRebootConfig&usr=admin&pwd= SetTimingRebootConfig Function Set Timing Reboot Config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setTimingRebootConfig Param isEnable Enable One Key Alarm Disable One Key Alarm One Week intervalDay One month...
Foscam IPCamera CGI User Guide Param ssid SoftAp’s ssid authMode Open SHARED WEPAUTO WPAPSK WPA2PSK encryptType None None Password key Return None Note Ssid/pwd support special character; Example setSoftApConfigNew &ssid=FosBaby_HAHA& aut /cgi-bin/CGIProxy.fcgi?cmd= hMode=4&encryptType=4&psk=123456789 &usr=admin&pwd= changeNetMode Function Change Net Mode privilege...
Foscam IPCamera CGI User Guide isEnableAudio Audio is enable(yes = 1 no = 0) isMainStream Is main stream(main = 1 sub = 0) szStreamId Stream id,get from foscam register interface szPublishToken Have defaults,get from embed szGuid Have defaults,get from embed szDevId Device id.
Foscam IPCamera CGI User Guide setSnapToFtpFilenameConfig Function Set snapPicture filename privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setSnapToFtpFilenameConfig Return Param isEnableSetFilename setSnapToFtpFilenameConfig is enable filename File name Note Example /cgi-bin/CGIProxy.fcgi?cmd=setSnapToFtpFilenameConfig&usr=admin&pwd= isEnableSetFilename=1&filename=picture & getSnapToFtpFilenameConfig Function get snapPicture filename information privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getSnapToFtpFilenameConfig Param None...
Foscam IPCamera CGI User Guide getLedEnableState Function Get Led Enable State privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getLedEnableState Param None Return isEnable Sys and Net LED Off Sys and Net LED Note Example /cgi-bin/CGIProxy.fcgi?cmd=getLedEnableState&usr=admin&pwd= *logID: 0:System power on 1:Detect motion alarm 2:user login...
Foscam IPCamera CGI User Guide setHdrMode Function Set HDR Mode privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setHdrMode Param mode Close HDR Open HDR Return None Note Example cgi-bin/CGIProxy.fcgi?cmd=setHdrMode&mode=1&usr=admin&pwd= getWdrMode Function Get WDR mode privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getWdrMode Param None mode Return WDR closed...
Foscam IPCamera CGI User Guide privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=getVideoStreamParam Param None resolutionN Return Resolution of stream type N bitRateN Bit rate of stream type N (20480~2097152) frameRateN Frame rate of stream type N GOPN P frames between I frame of stream type N...
Foscam IPCamera CGI User Guide Param None resolutionN Return Resolution of stream type N bitRateN Bit rate of stream type N (20480~2097152) frameRateN Frame rate of stream type N GOPN P frames between I frame of stream type N isVBRN...
Page 127
4: Lowest triggerInterval The time of which motion detect alaram can trigger again when a motion detection has happened.P.s.The true value of triggerInterval time is the value of the cgi get add 5s. isMovAlarmEnabl Is enable motion alarm detect isPirAlarmEnable...
Foscam IPCamera CGI User Guide setMotionDetectConfig1 Function Set motion detect config privilege admin Usage /cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig isEnable Param Is enable motion detect alarm linkage Motion alarm bit0:Ring linkage bit1:Send mail ( bit7 | bit6 | bit5 | bit2:Snap picture bit4 bit3:Record...
Page 129
Foscam IPCamera CGI User Guide Return None Note ·The min unit of schedule is half an hour, scheduleN value range (N[0-48]) Example /cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig1&isEnable=1&linkage=15& snapInterval=2&triggerInterval=6&isMovAlarmEnable=1&isPirAlarmEnable=1& schedule0=281474976710655&schedule1=281474976710655&schedule2=281 474976710655&schedule3=281474976710655&schedule4=281474976710655 &schedule5=281474976710655&schedule6=281474976710655&x1=0&y1=0& width1=300&height1=300&sensitivity1=1&valid1=1&x2=1220&y2=234&width2= 1000&height2=2000&sensitivity2=2&valid2=1&x3=0&y3=3456&width3=9000&h eight3=2340&sensitivity3=3&valid3=0&x4=0&y4=0&width4=9000&height4=900 0&sensitivity4=3&valid4=0&usr=admin&pwd= Copyright@ Shenzhen Foscam Intelligent Technology Limited...
Need help?
Do you have a question about the CGI and is the answer not in the manual?
Questions and answers