Foscam IPCamera CGI User Guide
1
Foscam IPCamera CGI User Guide
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
2
Contents
1. General description....................................................................................................................14
2. All Platform CGI.......................................................................................................................... 15
AV Function...............................................................................................................................15
getImageSetting.................................................................................................................15
setBrightness..................................................................................................................... 15
setContrast.........................................................................................................................15
setHue................................................................................................................................16
setSaturation......................................................................................................................16
setSharpness...................................................................................................................... 16
setDenoiseLevel (not use).................................................................................................16
resetImageSetting..............................................................................................................17
getMirrorAndFlipSetting.................................................................................................. 17
mirrorVideo....................................................................................................................... 17
flipVideo............................................................................................................................18
getRatio............................................................................................................................. 18
setRatio..............................................................................................................................18
getH264FrmRefMode....................................................................................................... 19
setH264FrmRefMode........................................................................................................19
getScheduleRecordStreamChn......................................................................................... 19
setScheduleRecordStreamChn..........................................................................................20
setPwrFreq.........................................................................................................................20
getVideoStreamParam.......................................................................................................20
setVideoStreamParam.......................................................................................................21
getSubVideoStreamParam................................................................................................ 21
setSubVideoStreamParam.................................................................................................22
getMainVideoStreamType.................................................................................................22
getSubVideoStreamType...................................................................................................22
setMainVideoStreamType.................................................................................................23
setSubStreamFormat......................................................................................................... 23
GetMJStream.....................................................................................................................23
getOSDSetting...................................................................................................................24
setOSDSetting...................................................................................................................24
getOsdMaskArea...............................................................................................................25
setOsdMaskArea............................................................................................................... 25
getOSDMask.....................................................................................................................26
setOSDMask......................................................................................................................26
getMotionDetectConfig.................................................................................................... 26
setMotionDetectConfig.....................................................................................................27
setLocalAlarmRecordConfig............................................................................................ 29
getLocalAlarmRecordConfig............................................................................................29
getSnapConfig...................................................................................................................30
setSnapConfig................................................................................................................... 30
getScheduleSnapConfig.................................................................................................... 31
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
3
setScheduleSnapConfig.................................................................................................... 31
snapPicture........................................................................................................................ 32
snapPicture2...................................................................................................................... 32
getRecordList.................................................................................................................... 32
getRecordList2.................................................................................................................. 33
reloadRecordindex............................................................................................................ 33
getAlarmRecordConfig.....................................................................................................34
setAlarmRecordConfig..................................................................................................... 34
getRecordPath................................................................................................................... 34
setRecordPath....................................................................................................................35
getScheduleRecordConfig................................................................................................ 35
setScheduleRecordConfig.................................................................................................36
setIOAlarmConfig.............................................................................................................37
getIOAlarmConfig............................................................................................................ 37
clearIOAlarmOutput......................................................................................................... 38
setAudioAlarmConfig.......................................................................................................38
getAudioAlarmConfig...................................................................................................... 39
setPCAudioAlarmCfg....................................................................................................... 39
getPCAudioAlarmCfg.......................................................................................................39
getMultiDevList................................................................................................................ 40
getMultiDevDetailInfo......................................................................................................40
addMultiDev......................................................................................................................40
delMultiDev...................................................................................................................... 41
setDeFrameLevel.............................................................................................................. 41
getDeFrameLevel..............................................................................................................41
getNetworkAutoAdaptability............................................................................................42
setNetworkAutoAdaptability............................................................................................ 42
getMainStreamCapabilities...............................................................................................42
getSubStreamCapabilities................................................................................................. 43
getAudioSendMethod....................................................................................................... 43
User account..............................................................................................................................44
addAccount........................................................................................................................44
delAccount........................................................................................................................ 44
getPassword.......................................................................................................................44
changePassword................................................................................................................ 45
changeUserName.............................................................................................................. 45
changeUserNameAndPwdTogether..................................................................................45
logIn...................................................................................................................................46
logOut................................................................................................................................47
getSessionList................................................................................................................... 47
getUserList........................................................................................................................ 47
usrBeatHeart......................................................................................................................48
PTZ Control...............................................................................................................................48
ptzMoveUp........................................................................................................................48
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
4
ptzMoveDown...................................................................................................................48
ptzMoveLeft......................................................................................................................49
ptzMoveRight....................................................................................................................49
ptzMoveTopLeft................................................................................................................49
ptzMoveTopRight..............................................................................................................49
ptzMoveBottomLeft..........................................................................................................50
ptzMoveBottomRight........................................................................................................50
ptzStopRun........................................................................................................................50
ptzReset.............................................................................................................................50
getPTZSpeed.....................................................................................................................51
setPTZSpeed......................................................................................................................51
getPTZPresetPointList...................................................................................................... 52
ptzAddPresetPoint.............................................................................................................52
ptzDeletePresetPoint......................................................................................................... 52
ptzGotoPresetPoint............................................................................................................53
ptzGetCruiseMapList........................................................................................................ 53
ptzGetCruiseMapInfo........................................................................................................53
ptzSetCruiseMap...............................................................................................................54
ptzDelCruiseMap.............................................................................................................. 54
ptzStartCruise....................................................................................................................54
ptzStopCruise.................................................................................................................... 54
setCruiseTime....................................................................................................................55
getCruiseTime...................................................................................................................55
setCruiseTimeCustomed................................................................................................... 55
getCruiseTimeCustomed...................................................................................................56
setCruiseLoopCnt..............................................................................................................56
getCruiseLoopCnt............................................................................................................. 56
setCruiseCtrlMode............................................................................................................ 56
getCruiseCtrlMode............................................................................................................57
setCruisePrePointLingerTime...........................................................................................57
getCruisePrePointLingerTime...........................................................................................57
zoomIn...............................................................................................................................58
zoomOut............................................................................................................................58
zoomStop...........................................................................................................................58
getZoomSpeed...................................................................................................................58
setZoomSpeed...................................................................................................................59
setPTZSelfTestMode.........................................................................................................59
getPTZSelfTestMode........................................................................................................ 59
setPTZPrePointForSelfTest...............................................................................................60
getPTZPrePointForSelfTest.............................................................................................. 60
set485Info..........................................................................................................................60
get485Info......................................................................................................................... 61
Network.....................................................................................................................................61
getIPInfo............................................................................................................................61
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
5
setIpInfo............................................................................................................................ 62
refreshWifiList.................................................................................................................. 62
getWifiList.........................................................................................................................63
setWifiSetting....................................................................................................................63
setWifiSettingNew............................................................................................................ 64
getWifiConfig....................................................................................................................65
getPortInfo.........................................................................................................................66
setPortInfo.........................................................................................................................67
getUPnPConfig................................................................................................................. 67
setUPnPConfig..................................................................................................................67
getDDNSConfig................................................................................................................68
setDDNSConfig................................................................................................................ 68
setFtpConfig......................................................................................................................69
setFtpConfigNew.............................................................................................................. 69
getFtpConfig......................................................................................................................70
testFtpServer......................................................................................................................70
testFtpServerNew..............................................................................................................71
getSMTPConfig................................................................................................................ 71
setSMTPConfig.................................................................................................................72
setSMTPConfigNew......................................................................................................... 72
smtpTest.............................................................................................................................73
smtpTestNew.....................................................................................................................74
setP2PEnable.....................................................................................................................74
getP2PEnable.................................................................................................................... 75
setP2PPort......................................................................................................................... 75
getP2PPort.........................................................................................................................75
getP2PInfo.........................................................................................................................76
getPPPoEConfig................................................................................................................76
setPPPoEConfig................................................................................................................ 76
EnableOnvifAgent.............................................................................................................77
DisableOnvifAgent........................................................................................................... 77
GetOnvifAgentStat............................................................................................................77
getNetMode.....................................................................................................................77
wifiTest..............................................................................................................................78
Device manage..........................................................................................................................79
setSystemTime.................................................................................................................. 79
getSystemTime..................................................................................................................80
openInfraLed.....................................................................................................................81
closeInfraLed.....................................................................................................................81
getInfraLedConfig.............................................................................................................81
setInfraLedConfig............................................................................................................. 82
getScheduleInfraLedConfig..............................................................................................82
setScheduleInfraLedConfig.............................................................................................. 82
getDevState....................................................................................................................... 83
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
6
getDevName......................................................................................................................84
setDevName...................................................................................................................... 84
getDevInfo.........................................................................................................................84
getDevAttr.........................................................................................................................85
getProductModel...............................................................................................................85
getProductModelName..................................................................................................... 85
getProductLanguage..........................................................................................................86
getProductSensorType.......................................................................................................86
getProductWifiType.......................................................................................................... 86
getProductSdFlag.............................................................................................................. 87
getProductOutdoorFlag.....................................................................................................87
getProductPtFlag...............................................................................................................87
getProductZoomFlag.........................................................................................................87
getProductRs485Flag........................................................................................................ 88
getProductIoAlarmFlag.....................................................................................................88
getProductOnvifFlag.........................................................................................................88
getProductP2pFlag............................................................................................................ 89
getProductWpsFlag...........................................................................................................89
getProductAudioFlag........................................................................................................ 89
getProductTalkFlag........................................................................................................... 89
getProductAppVer.............................................................................................................90
getProductAllInfo..............................................................................................................90
setProductAllInfo.............................................................................................................. 91
getNVRApSigQuality....................................................................................................... 92
getVoiceEnableState..........................................................................................................92
setVoiceEnableState..........................................................................................................92
getGeneratePubKey...........................................................................................................93
toolRestoreToFactory........................................................................................................93
System....................................................................................................................................... 93
rebootSystem.....................................................................................................................93
restoreToFactorySetting....................................................................................................94
exportConfig......................................................................................................................94
ImportConfig.....................................................................................................................94
FwUpgrade........................................................................................................................95
removePatch......................................................................................................................95
MISC......................................................................................................................................... 96
getFirewallConfig............................................................................................................. 96
setFirewallConfig..............................................................................................................96
getLog................................................................................................................................96
3. All platform except 3518A add cgi............................................................................................... 97
getAudioVolume................................................................................................................97
setAudioVolume................................................................................................................ 97
getWifiMode..................................................................................................................... 97
getTemperatureAlarmConfig............................................................................................ 98
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
7
setTemperatureAlarmConfig.............................................................................................98
getTemperatureState..........................................................................................................99
Music......................................................................................................................................... 99
setMusicDefaultListRefresh..............................................................................................99
getMusicListsName.........................................................................................................100
getMusicsNameOfList.................................................................................................... 100
addMusicList...................................................................................................................101
delMusicList....................................................................................................................102
setMusicPlayMode..........................................................................................................103
getMusicPlayMode......................................................................................................... 103
setMusicPlayNext........................................................................................................... 103
setMusicPlayPre..............................................................................................................104
getMusicPlayState...........................................................................................................104
setMusicPlayStart............................................................................................................104
setMusicPlayStop............................................................................................................105
setMusicDormantTime....................................................................................................105
getMusicDormantTime................................................................................................... 105
Cloud....................................................................................................................................... 106
getCloudConfig...............................................................................................................106
setCloudConfig............................................................................................................... 106
selectCloudServer........................................................................................................... 107
getCloudToken................................................................................................................ 107
getCloudQuota................................................................................................................ 108
testCloudServer...............................................................................................................108
getPushConfig.................................................................................................................108
setPushConfig................................................................................................................. 109
testPushServer.................................................................................................................109
setRichMediaPushConfig................................................................................................110
setFosPushConfig............................................................................................................110
setFosPushServer............................................................................................................ 110
pushOperate.....................................................................................................................111
SetOnlineUpgrade........................................................................................................... 111
setCloudStreamLevel...................................................................................................... 112
getCloudStreamLevel......................................................................................................112
4. FosBaby_Baidu CGI(Only).........................................................................................................112
getBaiduRtmp..................................................................................................................112
setBaiduRtmp.................................................................................................................. 113
GetOnlineUpgradeState.................................................................................................. 114
5. FosBaby_P1 CGI(Only)..............................................................................................................114
getHumidityAlarmConfig............................................................................................... 114
setHumidityAlarmConfig................................................................................................115
getHumidityState.............................................................................................................116
setNightLightState...........................................................................................................116
getNightLightState.......................................................................................................... 116
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
8
setOneKeyAlarmConfig..................................................................................................116
getOneKeyAlarmConfig................................................................................................. 117
getTimingRebootConfig..................................................................................................117
SetTimingRebootConfig................................................................................................. 118
6. 3518E+Fosbaby+Fosbaby_P1+Fosbaby_Baidu.........................................................................118
getSoftApConfig............................................................................................................. 118
setSoftApConfig..............................................................................................................119
setSoftApConfigNew...................................................................................................... 119
changeNetMode.............................................................................................................. 120
setFoscamRtmp...............................................................................................................120
getFoscamRtmp...............................................................................................................121
setSnapToFtpFilenameConfig.........................................................................................122
getSnapToFtpFilenameConfig........................................................................................ 122
7. Fosbaby_P1+3518E.................................................................................................................... 122
setLedEnableState........................................................................................................... 122
getLedEnableState...........................................................................................................123
8. Amba S2L(Only).........................................................................................................................123
getHdrMode.................................................................................................................... 123
setHdrMode.....................................................................................................................124
getWdrMode....................................................................................................................124
setWdrMode....................................................................................................................124
getVideoStreamParam.....................................................................................................124
setVideoStreamParam..................................................................................................... 125
getSubVideoStreamParam.............................................................................................. 125
setSubVideoStreamParam...............................................................................................126
getMotionDetectConfig1................................................................................................ 126
setMotionDetectConfig1.................................................................................................128
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
9
History
Ver
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. Add MotionJpeg stream support
1.0.3
Houzhen
2013-6-5
Check and Modify CGI command
document
1.0.4
Limaike
2013-6-8
CGI command check
1.0.5
Houzhen
2013-9-25
1.Add note for GetMJStream, defects of
Firefox;
2.Modify Command:
setContrast、mirrorVideo、flipVideo、logIn、
setSnapConfig 、 setPTZSpeed 、
setInfraLedConfig 、 setSubStreamFormat 、
setPortInfo、getPortInfo；
3.Add command:
getLocalAlarmRecordConfig ；
setLocalAlarmRecordConfig；
getP2PEnable ； setP2PEnable ； getP2PPort；
setP2PPort ； setOSDMask ； getOSDMask ；
getScheduleSnapConfig ；
setScheduleSnapConfig；
1.0.6
Houzhen
2013-12-12
1.Add command:
-changeUserNameAndPwdTogether；
-getPCAudioAlarmCfg；
-setPCAudioAlarmCfg；
-setH264FrmRefMode；
-getH264FrmRefMode；
-setCruiseTime；
-getCruiseTime；
Copyright@ Shenzhen Foscam Intelligent Technology Limited
10
-setSubVideoStreamParam；
-getSubVideoStreamParam；
-setCruiseTimeCustomed；
-getCruiseTimeCustomed；
-setCruiseLoopCnt；
-getCruiseLoopCnt；
-setCruiseCtrlMode；
-getCruiseCtrlMode；
-setCruisePrePointLingerTime；
-getCruisePrePointLingerTime；
-getScheduleRecordStreamChn；
-setScheduleRecordStreamChn；
-getProductModel；
-getProductModelName；
-getProductLanguage；
-getProductSensorType；
-getProductWifiType；
-getProductSdFlag；
-getProductOutdoorFlag；
-getProductPtFlag；
-getProductZoomFlag；
-getProductRs485Flag；
-getProductIoAlarmFlag；
-getProductOnvifFlag;
-getProductP2pFlag;
-getProductWpsFlag;
-getProductAudioFlag;
-getProductTalkFlag;
-getProductAppVer;
-getProductAllInfo;
-getGeneratePubKey;
-toolResetToFactory;
-setScheduleInfraLedConfig;
-getScheduleInfraLedConfig;
2.Modify Login error code-5、-7;
1.0.7
Houzhen
2013-12-14
Modify Command:
1.The usage of command-setSubStreamFormat,
getSnapConfig, setSnapConfig.
Foscam IPCamera CGI User Guide
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
11
2.The example and description of
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.
3）The Param of command:smtpTest.
1.0.10
Houzhen
2014-4-2
1.Add commmad:getPPPoEConfig,
setPPPoEConfig,getRecordPath,getScheduleRe
cordConfig,getP2PInfo;
2.Modify the priviage of command for security:
changePassword,changeUserName,changeUser
NameAndPwdTogether,getSessionList,getUser
List,getImageSetting,getMirrorAndFlipSetting,
getMotionDetectConfig,getScheduleSnapConfi
g,getVideoStreamParam,getSubVideoStreamPa
ram,getMainVideoStreamType,getSubVideoStr
eamType,getH264FrmRefMode,getSnapConfig
,getOsdMaskArea,getOSDSetting,getOSDMas
k,getPTZSpeed,get485Info,getPTZPresetPoint
List,ptzGetCruiseMapList,ptzGetCruiseMapInf
o,getPTZSelfTestMode,getPTZPrePointForSelf
Test,getCruiseTime,getCruiseTimeCustomed,g
etCruiseLoopCnt,getCruiseCtrlMode,getCruise
PrePointLingerTime,getZoomSpeed,getSMTP
Config,getIPInfo,getPortInfo,getUPnPConfig,g
etDevInfo,getDevName,getFirewallConfig,getS
ystemTime,getFtpConfig,testFtpServer,getDD
NSConfig,getLog,getRecordList,getRecordList
2,reloadRecordindex,getScheduleRecordStrea
mChn,getAlarmRecordConfig,getLocalAlarmR
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
12
ecordConfig,getPCAudioAlarmCfg,getIOAlar
mConfig,getDevState,getInfraLedConfig,getSc
heduleInfraLedConfig,getP2PEnable,getP2PPo
rt
1.0.11
Houzhen
2014-6-27
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
ZhangWei
2015-6-9
Add command of amba platform:
getHdrMode,setHdrMode,getWdrMode,setWdr
Mode,getVideoStreamParam,setVideoStreamPa
ram,getSubVideoStreamParam,setSubStreamPa
ram,getMotionDetectConfig1,setMotionDetecC
onfig1
1.0.16
PengMengjia
2015-10-12
Add command:
setFoscamRtmp;getFoscamRtmp;setSnapToFtp
FilenameConfig;getSnapToFtpFilenameConfig;
getCloudStreamLeve;setCloudStreamLevel;s
etWifiSettingNew;
1.0.17
QiYongkun
2016-6-2
Add command:
setNetworkAutoAdaptability:
getsetNetworkAutoAdaptability;
1.0.18
LeiZhiPing
2016-11-8
Add command:
getDevAttr;setRichMediaPushConfig;GetOnv
ifAgentStat;setProductAllInfo;getNVRApSigQ
uality;getVoiceEnableState;setVoiceEnableSt
ate;getNetworkAutoAdaptability;setNetworkA
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
13
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
Foscam IPCamera CGI User Guide
14
1. General description
Our device can only support authentication by pass user name or password attached
We only support GET and POST method. Only importConfig and fwUpgrade can
The cgi request string must be encode in url format. URL encode rule:
cgi execute result
value
mean
0
Success
-1
CGI request string format error
-2
Username or password error
-3
Access deny
-4
CGI execute fail
-5
Timeout
-6
Reserve
-7
Unknown error
-8
Reserve
at CGI request string currentlly.
For example:
https://xxxxxx.myfoscam.org:443/cgi-bin/CGIProxy.fcgi&usr=admin&pwd=123&cmd=
ABC
support POST method.
The following chars will not be encoded:
[A~Z] [a~z] [0~9] + @ * /
The other chars will be encoded into hex format.
For example:
https://xxxxxx.myfoscam.org:443/cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=getIPInfo
will be encode to:
https://xxxxxx.myfoscam.org:443/cgi-bin/CGIProxy.fcgi?usr%3Dadmin%26pwd%3D%26cmd%3DgetIPInfo
1) We orgnize the cgi execute result as xml format, for example:
<CGI_Result>
<result>0</result>
<isDHCP>1</isDHCP>
<ip>192.168.1.8</ip>
<gate>0.0.0.0</gate>
<mask>255.255.255.0</mask>
<dns1>0.0.0.0</dns1>
<dns2>0.0.0.0</dns2>
</CGI_Result>
<result></result> means the common execute result
Copyright@ Shenzhen Foscam Intelligent Technology Limited
15
2. All Platform CGI
AV Function
Function
Get color attribute of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getImageSetting
Param
None
Return
brightness
0~100
contrast
0~100
hue
0~100
saturation
0~100
sharpness
0~100
denoiseLevel
Not use
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getImageSetting&usr=admin&pwd=
Function
Set brightness of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setBrightness
Param
brightness
0~100
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setBrightness&brightness=50&usr=admin&pwd=
Function
Set contrast of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setContrast
Param
constrast
0~100
getImageSetting
Foscam IPCamera CGI User Guide
setBrightness
setContrast
Copyright@ Shenzhen Foscam Intelligent Technology Limited
16
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
hue
0~100
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setHue&hue=50&usr=admin&pwd=
Function
Set saturation of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSaturation
Param
saturation
0~100
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSaturation&saturation=50&usr=admin&pwd=
Function
Set sharpness of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSharpness
Param
sharpness
0~100
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSharpness&sharpness=50&usr=admin&pwd=
Function
Set DenoiseLevel of video
Foscam IPCamera CGI User Guide
setSaturation
setSharpness
setDenoiseLevel (not use)
Copyright@ Shenzhen Foscam Intelligent Technology Limited
17
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=
Function
Get mirror and flip attribute of video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMirrorAndFlipSetting
Param
None
Return
isMirror
0 Not mirred
1 Mirred
isFlip
0 Not filpped
1 Flipped
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getMirrorAndFlipSetting&usr=admin&pwd=
Function
Mirror video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=mirrorVideo
Param
isMirror
0 Not mirror
Foscam IPCamera CGI User Guide
getMirrorAndFlipSetting
mirrorVideo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
18
1 Mirror
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=mirrorVideo&
isMirror=1
&usr=admin&pwd=
flipVideo
Function
Flip video
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=flipVideo
Param
isFlip
0 Not flip
1 Flip
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=flipVideo&isFlip=1&usr=admin&pwd=
Function
Get value for image distortion correction
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getRatio
Param
None
Return
ratio
Three ranks for image distortion correction
High:150.
Middle:210.
Low:430.
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getRatio&usr=admin&pwd=
Function
Set value for image distortion correction
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setRatio
Param
ratio
1. 0-511，value for image distortion correction.
2. Three ranks,
Foscam IPCamera CGI User Guide
getRatio
setRatio
Copyright@ Shenzhen Foscam Intelligent Technology Limited
19
High:0-150.
Middle:151-429.
Low:430-511.
3. Default, Middle.
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setRatio&
ratio=150
&usr=admin&pwd=
getH264FrmRefMode
Function
Get frame shipping reference mode of H264 encode stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getH264FrmRefMode
Param
None
Return
mode
0 Normal reference mode
1 Two frames are separated by four skipping
frames
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getH264FrmRefMode&usr=admin&pwd=
Function
Set frame shipping reference mode of H264 encode stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setH264FrmRefMode
Param
mode
0 Normal reference mode
1 Two frames are separated by four skipping
frames
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setH264FrmRefMode&mode=0&usr=admin&pwd=
Function
Get stream channel for schedule record
privilege
admin
Foscam IPCamera CGI User Guide
setH264FrmRefMode
getScheduleRecordStreamChn
Copyright@ Shenzhen Foscam Intelligent Technology Limited
20
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleRecordStreamChn
Param
None
Return
chn
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
chn
0 main stream
1 sub stream
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleRecordStreamChn&chn=0&usr=admin
&pwd=
Function
Set power freq of sensor
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setPwrFreq
Param
freq
0 60HZ
1 50HZ
2 outdoor mode
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setPwrFreq&freq=0&usr=admin&pwd=
Function
Get video stream param
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getVideoStreamParam
Foscam IPCamera CGI User Guide
setPwrFreq
getVideoStreamParam
Copyright@ Shenzhen Foscam Intelligent Technology Limited
21
Param
None
Return
resolutionN
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
Change bit rate of stream 1-yes
0-nosetSubVideoStreamParam
Note
N means streamType [0~3]
Example
/cgi-bin/CGIProxy.fcgi?cmd=getVideoStreamParam&usr=admin&pwd=
setVideoStreamParam
Function
Set the video stream param of stream N
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setVideoStreamParam
Param
streamType
0~3
resolution
Resolution of stream type N
bitRate
Bit rate of stream type N (20480~2097152)
frameRate
Frame rate of stream type N
GOP
P frames between I frame of stream type N
The suggest value is: X * frameRate
isVBR
Change bit rate of stream type 1-Yes 0-No
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setVideoStreamParam&streamType=0&resolution=
0&bitRate=2097152&frameRate=30&GOP=30&isVBR=0&usr=admin&pwd=
Function
Get sub video stream param
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getSubVideoStreamParam
Param
None
Return
resolutionN
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
getSubVideoStreamParam
Copyright@ Shenzhen Foscam Intelligent Technology Limited
22
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
0~3
resolution
Resolution of stream type N
bitRate
Bit rate of stream type N (20480~2097152)
frameRate
Frame rate of stream type N
GOP
P frames between I frame of stream type N
The suggest value is: X * frameRate
isVBR
Not in use currentlly
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSubVideoStreamParam&streamType=0&resoluti
on=0&bitRate=2097152&frameRate=30&GOP=30&isVBR=0&usr=admin&pwd=
Function
Get the stream type of main stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMainVideoStreamType
Param
None
Return
streamType
The stream type 0~3
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getMainVideoStreamType&usr=admin&pwd=
Function
Get the stream type of sub stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getSubVideoStreamType
Param
None
Foscam IPCamera CGI User Guide
getMainVideoStreamType
getSubVideoStreamType
Copyright@ Shenzhen Foscam Intelligent Technology Limited
23
Return
streamType
The stream type 0~3
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getSubVideoStreamType&usr=admin&pwd=
setMainVideoStreamType
Function
Set the stream type of main stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setMainVideoStreamType
Param
streamType
The stream type 0~3
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setMainVideoStreamType&streamType=0&usr=ad
min&pwd=
Function
Set the stream format of sub stream
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSubStreamFormat
Param
format
0
H264
1
MotionJpeg
Return
None
Note
Our device can only support 2 streams:Main stream for PC access and Sub
stream for mobile access, but someone need a MJ stream to embed their
camera into a webpage, in this case, we should set sub stream format to Motion
Jpeg, and then you can get MJ stream by 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=
Function
Get motion jpeg stream
privilege
visitor
Usage
/cgi-bin/CGIStream.cgi?cmd=GetMJStream
Param
None
Foscam IPCamera CGI User Guide
setSubStreamFormat
GetMJStream
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
24
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” CGI to get mjstream long time. This problem is due to the
browse has some defects, it can not parse data correctly and directly. In
order to fix this problem, we should as follows:
A. Create a .txt empty document, such as “MJ.txt”.
B.Input the content into you .txt document, as follows:
<html>
<body>
<img
src="https://xxxxxx.myfoscam.org:443/cgi-bin/CGIStream.cgi?cmd=GetMJStream
&usr=admin&pwd="/>
</body>
</html>
Note: please change the ip\port\usr\pwd to youself;
C. Rename your .txt to .html, such as “MJ.html”.
D. Open you r.html by Firefox, and enjoy your MJStream-video;
Example
/cgi-bin/CGIStream.cgi?cmd=GetMJStream&usr=admin&pwd=
Function
Get OSD config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getOSDSetting
Param
None
Return
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
isEnableOSDMask
Is OSD mask effective
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getOSDSetting&usr=admin&pwd=
Function
Set OSD config
getOSDSetting
setOSDSetting
Copyright@ Shenzhen Foscam Intelligent Technology Limited
25
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
evName=1&dispPos=0&isEnableOSDMask=0&usr=admin&pwd=
getOsdMaskArea
Function
Get OSD mask area info
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getOsdMaskArea
Param
None
Return
x1_N
The top left X position of mask N
y1_N
The top left Y position of mask N
x2_N
The bottom right X position of mask N
y2_N
The bottom right Y position of mask N
Note
Our device can only support 4 mask areas
Example
/cgi-bin/CGIProxy.fcgi?cmd=getOsdMaskArea&usr=admin&pwd=
Function
Set OSD mask area info
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setOsdMaskArea
param
x1_N
The top left X position of mask N
y1_N
The top left Y position of mask N
x2_N
The bottom right X position of mask N
y2_N
The bottom right Y position of mask N
Resturn
None
Note
Our device can only support 4 mask areas
Example
/cgi-bin/CGIProxy.fcgi?cmd=setOsdMaskArea&x1_0=100&y1_0=100&x2_0=20
0&y2_0=200&x1_1=0&y1_1=0&x2_1=0&y2_1=0&x1_2=0&y1_2=0&x2_2=0&y
2_2=0&x1_3=0&y1_3=0&x2_3=0&y2_3=0&usr=admin&pwd=
Foscam IPCamera CGI User Guide
setOsdMaskArea
Copyright@ Shenzhen Foscam Intelligent Technology Limited
26
getOSDMask
Function
Get OSD mask status
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getOSDMask
Param
None
Return
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
isEnableOSDMask
Is OSD mask effective
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getOSDMask&usr=admin&pwd=
Function
Set OSD mask status
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setOSDMask
Param
isEnableOSDMask
0-Disable, 1-Enable
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setOSDMask&isEnableOSDMask=1&usr=admin&p
wd=
Function
Get motion detect config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig
Param
None
Return
isEnable
Is enable motion detect alarm
linkage
Motion alarm linkage
( bit3 | bit2 | bit1 | bit0 )
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
snapInterval
The interval time to snap picture again
sensitivity
Motion detect
0 : Low
setOSDMask
Foscam IPCamera CGI User Guide
getMotionDetectConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
27
sensitivity
1: Normal
2: High
3: Lower
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.
isMovAlarmEnable
Is enable motion alarm detect
isPirAlarmEnable
Is enable Passive Infrared alarm detect
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
areaN
The area info of row N
For detail, see *2 bellow
Note
·Video region is divided into 10*10 sub areasideo region is divided into 10*10
sub areas
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
.areaN value
1-2
N
(N[0-10])
Example
/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&usr=admin&pwd=
Function
Set motion detect config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig
Param
isEnable
Is enable motion detect alarm
linkage
Motion alarm linkage
( bit3 | bit2 | bit1 | bit0 )
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
snapInterval
The interval time to snap picture again
sensitivity
Motion detect
sensitivity
0 : Low
1: Normal
2: High
3: Lower
4: Lowest
setMotionDetectConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
28
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
0
Disable
1
Enable
isPirAlarmEnable
0
Disable
1
Enable
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
areaN
The area info of row N
For detail, see *2 bellow
Return
None
Note
·Video region is divided into 10*10 sub areasideo region is divided into 10*10
sub areas
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
.areaN value
1-2
N
(N[0-10])
Example
/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=1&linkage=16&s
napInterval=2&sensitivity=1&triggerInterval=5&isMovAlarmEnable=1&isPirAla
rmEnable=1&schedule0=1023&schedule1=1023&schedule2=1023&schedule3
=1023&schedule4=1023&schedule5=1023&schedule6=1023&area0=1023&are
a1=1023&area2=1023&area3=1023&area4=1023&area5=1023&area6=1023&
area7=1023&area7=1023&area8=1023&area9=1023&usr=admin&pwd=
0123456
7
Monday
Tuesday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday…Wednesday
*1 schedule bitmap
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
29
Each grid of a row presents half of an
hour of
one day. For example, 40 presents
20:00
bit0
bit1
bit2
bit3
bit4
bit5
bit6
bit7
bit8
bit9
Function
Set local alarm-record config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setLocalAlarmRecordConfig
Param
isEnableLocalAlar
mRecord
0
Disable
1
Enable
localAlarmRecordS
ecs
Recording time
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setLocalAlarmRecordConfig&isEnableLocalAlarmR
ecord=1&localAlarmRecordSecs=30&usr=admin&pwd=
Function
Get local alarm-record config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getLocalAlarmRecordConfig
Param
None
40414243444546
47
area0
area1
area2
area3
area4
area5
area6
area7
area8
area9
~20:30.
The bit 40 set to “1” means the motion detection is effective between 20:00 to 20:30
*2 area bitmap
The video region is divided into 10*10 sub areas, bit0 above present the first area, when
this bit is set to “1”, it means motion detection is effective on this area.
setLocalAlarmRecordConfig
getLocalAlarmRecordConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
30
Return
isEnableLocalAlar
mRecord
0
Disable
1
Enable
localAlarmRecordS
ecs
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
Return
snapPicQuality
0
Low quality
1
Normal quality
2
High quality
saveLocation
0
Save to sd card
1
Not in use now
2
Upload to FTP
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getSnapConfig&usr=admin&pwd=
Function
Set snap config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSnapConfig
Param
snapQuality
0
Low quality
1
Normal quality
2
High quality
saveLocation
0
Save to sd card
1
Not in use now
2
Upload to FTP
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSnapConfig&snapQuality=1&saveLocation=2&
usr=admin&pwd=
Foscam IPCamera CGI User Guide
setSnapConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
31
getScheduleSnapConfig
Function
Get schedule snap config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleSnapConfig
Param
None
Return
isEnable
Is enable motion detect alarm
snapInterval
The interval time to snap picture again
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
Note
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
Example
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleSnapConfig&usr=admin&pwd=
Function
Set schedule snap config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleSnapConfig
Param
isEnable
Is enable snap
snapInterval
The interval time to snap picture again
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
Return
None
Note
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
Example
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleSnapConfig&isEnable=1&snapInterva
l=2&schedule0=1023&schedule1=1023&schedule2=1023&schedule3=1023&sc
hedule4=1023&schedule5=1023&schedule6=1023&usr=admin&pwd=
0123456
7
Monday
Tuesday
Thursday
…
Wednesday
Foscam IPCamera CGI User Guide
setScheduleSnapConfig
*1 schedule bitmap
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
32
Function
Manual snap picture
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=snapPicture
Param
None
Return
We will return a html script directly:
<html><body><img src="../snapPic/20121121-215939.jpg"/></body></html>
Note
Picture resolution is the same as main stream resolutionnapPicture
Example
/cgi-bin/CGIProxy.fcgi?cmd=snapPicture&usr=admin&pwd=
Function
Manual snap picture
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=snapPicture2
Param
None
Return
Jpeg image data
Note
This command will return jpeg image data directly
Example
/cgi-bin/CGIProxy.fcgi?cmd=snapPicture2&usr=admin&pwd=
Function
Get record list
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getRecordList
Param
recordPath
Record path
startTime
Start time for research
40414243444546
47
Tuesday
Wednesday
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
snapPicture
snapPicture2
getRecordList
Copyright@ Shenzhen Foscam Intelligent Technology Limited
33
endTime
End time for research
recordType
Recort type
startNo
Start no
Return
totalCnt
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
Param
recordPath
Record path
startTime
Start time for research
endTime
End time for research
recordType
Recort type
startNo
Start no
Return
totalCnt
Total record count
curCnt
Current record count
recordN
N(0-9), Record information
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getRecordList2&usr=admin&pwd=
Function
Synchronization of record index for Play
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=reloadRecordindex
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=reloadRecordindex&usr=admin&pwd=
Foscam IPCamera CGI User Guide
reloadRecordindex
Copyright@ Shenzhen Foscam Intelligent Technology Limited
34
getAlarmRecordConfig
Function
Get alarm record config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getAlarmRecordConfig
Param
None
Return
isEnablePreRecord
Preview record state
preRecordSecs
Preview record time
alarmRecordSecs
Alarm record time
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getAlarmRecordConfig&usr=admin&pwd=
Function
Set alarm record config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setAlarmRecordConfig
Param
isEnablePreRecord
Preview record state
preRecordSecs
Preview record time
alarmRecordSecs
Alarm record time
Return
Set result(0-success,-1-error)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setAlarmRecordConfig&usr=admin&pwd=&isEnabl
ePreRecord=1&preRecordSecs=5&alarmRecordSecs=30
Function
Get record path for storage
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getRecordPath
Param
None
Return
path
0-SD card，2-FTP server
free
The free capacity of storage device
total
The total capacity of storage device
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getRecordPath&usr=admin&pwd=
setAlarmRecordConfig
Foscam IPCamera CGI User Guide
getRecordPath
Copyright@ Shenzhen Foscam Intelligent Technology Limited
35
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
Return
setResult
0
success
-1
Sd card is not exist
-2
Share direction is not set
-3
Not enough space
-4
Param error
-5
Param recording
free
The free capacity of storage device
total
The total capacity of storage device
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setRecordPath&usr=admin&pwd=&path=2
Function
Get config for schedule recording
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleRecordConfig
Param
None
Return
isEnable
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
isEnableAudio
Is recording include audio? 0-no,1-yes
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
Note
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
Example
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleRecordConfig&usr=admin&pwd=
Foscam IPCamera CGI User Guide
getScheduleRecordConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
36
setScheduleRecordConfig
Function
Set schedule recordconfig
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleRecordConfig
Param
isEnable
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
isEnableAudio
Is recording include audio? 0-no,1-yes
scheduleN
The motion alaram schedule of one week,
N = 0(Monday) ~6(Sunday)
For detail, see *1 bellow
Return
None
Note
·The min unit of schedule is half an hour, scheduleN value range
1-2
N
(N[0-48])
Example
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleRecordConfig&isEnable=1&recordLev
el=0&spaceFullMode=0&isEnableAudio=0&schedule0=1023&schedule1=1023&
schedule2=1023&schedule3=1023&schedule4=1023&schedule5=1023&sched
ule6=1023&usr=admin&pwd=
0123456
7
40414243444546
47
Monday
Tuesday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday…Wednesday
Foscam IPCamera CGI User Guide
*1 schedule bitmap
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
Copyright@ Shenzhen Foscam Intelligent Technology Limited
37
setIOAlarmConfig
Function
Set IO alarm config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setIOAlarmConfig
Param
isEnable
Enable state
linkage
IO alarm linkage
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
alarmLevel
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
&linkage=16&snapInterval=2&alarmLevel=1&triggerInterval=5&schedule0=102
4&schedule1=1024&schedule2=1024&schedule3=1024&schedule4=1024&sch
edule5=1024&schedule6=1024
Function
Get IO alarm config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getIOAlarmConfig
Param
None
Return
isEnable
Enable state
linkage
IO alarm linkage
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
alarmLevel
Alarm level
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.
Foscam IPCamera CGI User Guide
getIOAlarmConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
38
scheduleN
N(0-6), alarm schedule
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getIOAlarmConfig&usr=admin&pwd=
clearIOAlarmOutput
Function
Clean IO alarm output
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=clearIOAlarmOutput
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=clearIOAlarmOutput&usr=admin&pwd=
Function
Set Audio alarm config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setAudioAlarmConfig
Param
isEnable
Enable state
linkage
Audio alarm linkage
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
sensitivity
0=low 1=middle 2=high
snapInterval
Interval for snap picture
triggerInterval
Interval for trigger alarm again
scheduleN
N(0-6), alarm schedule
Return
Set result(0-success,-1-error)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setAudioAlarmConfig&usr=admin&pwd=&isEnable
=1&linkage=16&
snapInterval=2&sensitivity=1
&triggerInterval=5&schedule0=1
024&schedule1=1024&schedule2=1024&schedule3=1024&schedule4=1024&s
chedule5=1024&schedule6=1024
Foscam IPCamera CGI User Guide
setAudioAlarmConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
39
getAudioAlarmConfig
Function
Get Audio alarm config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getAudioAlarmConfig
Param
None
Return
isEnable
Enable state
linkage
IO alarm linkage
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
sensitivity
0=low 1=middle 2=high
snapInterval
Interval for snap picture
triggerInterval
Interval for trigger alarm again
scheduleN
N(0-6), alarm schedule
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getAudioAlarmConfig&usr=admin&pwd=
Function
Set audio alarm config for PC（web live video）
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setPCAudioAlarmCfg
Param
isEnablePCAudioAl
arm
Enable state
Return
Set result(0-success,-1-error)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setPCAudioAlarmCfg&usr=admin&pwd=&isEnable
PCAudioAlarm=1
Function
Get audio alarm config for PC（web live video）
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPCAudioAlarmCfg
Param
None
Return
isEnablePCAudioAl
Enable state
Foscam IPCamera CGI User Guide
setPCAudioAlarmCfg
getPCAudioAlarmCfg
Copyright@ Shenzhen Foscam Intelligent Technology Limited
40
arm
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=
Function
Get multi device information
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMultiDevDetailInfo
Param
chnnl
Channel no
Return
productType
Device type
ip
Device IP
port
Web port
mediaPort
Media port
userName
User name
passWord
Password
devName
Device name
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getMultiDevDetailInfo&usr=admin&pwd=
Function
Add multiy device
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=addMultiDev
Param
chnnl
Channel no
productType
Device type
Foscam IPCamera CGI User Guide
getMultiDevDetailInfo
addMultiDev
Copyright@ Shenzhen Foscam Intelligent Technology Limited
41
ip
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
/cgi-bin/CGIProxy.fcgi?cmd=addMultiDev&usr=admin&pwd=&
chnnl
=2&
product
Type
=H264&
ip=192.168.1.3&port=88&mediaPort
=88
&userName=admin&pass
Word=&devName=FI9805W
delMultiDev
Function
Delete multiy device
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=delMultiDev
Param
chnnl
Channel no
Return
Delete result(0-success,-1-error)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=delMultiDev&usr=admin&pwd=&
chnnl
=2
Function
Set status to enhance night vision definition
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setDeFrameLevel
Param
level
0 -Disable the status of enhance
1 -Enable the status of enhance
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setDeFrameLevel&level=0&usr=admin&pwd=
Function
Get status of enhance the night vision definition
privilege
admin
Foscam IPCamera CGI User Guide
setDeFrameLevel
getDeFrameLevel
Copyright@ Shenzhen Foscam Intelligent Technology Limited
42
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
Get status of Network Auto Adaptability flag
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getNetworkAutoAdaptability
Param
None
Return
enable
0 -Disable the status of
Network Auto Adaptability
1 -Enable the status of
Network Auto Adaptability
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getNetworkAutoAdaptability&usr=admin&pwd=
Function
Set status to Network Auto Adaptability flag
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setNetworkAutoAdaptability
Param
enable
0 -Disable the status of
Network Auto Adaptability flag
1 -Enable the status to
Network Auto Adaptability flag
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setNetworkAutoAdaptability&enable=0&usr=admin
&pwd=
Function
Get status of Network Auto Adaptability flag
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMainStreamCapabilities
Param
None
Return
Json 格式数据
Foscam IPCamera CGI User Guide
setNetworkAutoAdaptability
getMainStreamCapabilities
Copyright@ Shenzhen Foscam Intelligent Technology Limited
43
Note
类似格式：
{
"HD816P V2":[{
"MSRL": "1280*720",
"MSRLV": 0,
"MSFR": 30,
"MSBR": "4M"
}]
}
Example
/cgi-bin/CGIProxy.fcgi?cmd=getMainStreamCapabilities&usr=admin&pwd=
getSubStreamCapabilities
Function
Get status of Network Auto Adaptability flag
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getSubStreamCapabilities
Param
None
Return
Json 格式数据
Note
同 getMainStreamCapabilities 返回格式
Example
/cgi-bin/CGIProxy.fcgi?cmd=getSubStreamCapabilities&usr=admin&pwd=
Function
getAudioSendMethod
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getAudioSendMethod
Param
None
Return
method
0:old method;1:new method
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=
getAudioSendMethod
&usr=admin&pwd=
Foscam IPCamera CGI User Guide
getAudioSendMethod
Copyright@ Shenzhen Foscam Intelligent Technology Limited
44
User account
Function
Add user account
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=addAccount
Param
usrName
user name
usrPwd
user password
privilege
0
Visitor
1
Operator
2
Administrator
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=addAccount&usrName=test&usrPwd=test&privileg
e=0& usr=admin&pwd=
Function
Delete user account
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=delAccount
Param
usrName
user name
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=delAccount&usrName=test&usr=admin&pwd=
Function
Get user password
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPassword
Param
usrName
user name
Return
None
Note
addAccount
Foscam IPCamera CGI User Guide
delAccount
getPassword
Copyright@ Shenzhen Foscam Intelligent Technology Limited
45
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
their own password
Example
/cgi-bin/CGIProxy.fcgi?cmd=changePassword&usrName=admin&oldPwd=&ne
wPwd=test&usr=admin&pwd=
Function
Change user name
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=changeUserName
Param
usrName
The user you want to change name
newUsrName
The new user name
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=changeUserName&usrName=admin&
newUsrName=newname&usr=admin&pwd=
Function
Change user name and password together
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=changeUserNameAndPwdTogether
Param
usrName
The user you want to change name
Foscam IPCamera CGI User Guide
changeUserName
changeUserNameAndPwdTogether
Copyright@ Shenzhen Foscam Intelligent Technology Limited
46
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
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd= logIn
Param
usrName
User name
remoteIp
Access IP
groupId
An id use to distinguish different users,can be set to
current cpu tick
pwd
password
Return
logInResult
0
Login success
-1
Parameter check error
-2
Exceed max user
-3
User not exist
-4
User not found
-5
Password error
-6
IP repetition
-7
Access deny
-8
Already login
privilege
0
Visitor
1
Operator
2
Administrator
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=logIn&usrName=admin&remoteIp=192.168.1.12&
groupId=673982479&pwd=&usr=admin&pwd=
Foscam IPCamera CGI User Guide
Copyright@ Shenzhen Foscam Intelligent Technology Limited
47
logOut
Function
User log out to camera
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=logOut
Param
usrName
User name
ip
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
d=673982479&usr=admin&pwd=
Function
Get current session list of the camera
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getSessionList
Param
None
Return
usrCnt
session count
usrN
User name of session N
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getSessionList&usr=admin&pwd=
Function
Get user account list of the camera
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getUserList
Param
None
Return
usrCnt
User count
usrN
User name of accnount N
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getUserList&usr=admin&pwd=
Foscam IPCamera CGI User Guide
getSessionList
getUserList
Copyright@ Shenzhen Foscam Intelligent Technology Limited
48
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
&groupId=673982479&usr=admin&pwd=
Function
Move up
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveUp
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveUp&usr=admin&pwd=
Function
Move down
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveDown
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveDown&usr=admin&pwd=
Foscam IPCamera CGI User Guide
PTZ Control
ptzMoveUp
ptzMoveDown
Copyright@ Shenzhen Foscam Intelligent Technology Limited
49
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=
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=
Function
Move to top left
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveTopLeft
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveTopLeft&usr=admin&pwd=
Function
Move to top right
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveTopRight
Param
None
ptzMoveRight
Foscam IPCamera CGI User Guide
ptzMoveTopLeft
ptzMoveTopRight
Copyright@ Shenzhen Foscam Intelligent Technology Limited
50
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=
Function
Move to bottom right
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveBottomRight
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzMoveBottomRight&usr=admin&pwd=
Function
Stop run PT
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzStopRun
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzStopRun&usr=admin&pwd=
Function
Reset PT to default position
Foscam IPCamera CGI User Guide
ptzMoveBottomRight
ptzStopRun
ptzReset
Copyright@ Shenzhen Foscam Intelligent Technology Limited
51
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
0
Very slow
1
Slow
2
Normal speed
3
Fast
4
Very fast
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getPTZSpeed&usr=admin&pwd=
Function
Set the speed of PT
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setPTZSpeed
Param
speed
0
Very slow
1
Slow
2
Normal speed
3
Fast
4
Very fast
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setPTZSpeed&speed=2&usr=admin&pwd=
Foscam IPCamera CGI User Guide
setPTZSpeed
Copyright@ Shenzhen Foscam Intelligent Technology Limited
52
getPTZPresetPointList
Function
Get all preset point
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPTZPresetPointList
Param
None
Return
cnt
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=
Function
Add preset point
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzAddPresetPoint
Param
name
Preset point name
Return
None
Note
The preset point position is current PT position
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzAddPresetPoint&name=test&usr=admin&pwd
=
Function
Delete preset point by name
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzDeletePresetPoint
Param
name
Preset point name
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzDeletePresetPoint&name=test&usr=admin&p
wd=
ptzAddPresetPoint
Foscam IPCamera CGI User Guide
ptzDeletePresetPoint
Copyright@ Shenzhen Foscam Intelligent Technology Limited
53
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
=
Function
Get all cruise map list
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzGetCruiseMapList
Param
None
Return
cnt
Current cruise map point count
mapN
The name of map N
Note
Our device can support at most 8 cruise map
We have 2 maps default:Horizental/Vertical
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzGetCruiseMapList&usr=admin&pwd=
Function
Get the detail info of a cruise map by name
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzGetCruiseMapInfo
Param
name
Name of the cruise map
Return
getResult
0
Success
-1
Fail
pointN
The preset point name of this cruise map
Note
Our device can support at most 8 preset point one cruise map
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzGetCruiseMapInfo&name=Horizental&usr=ad
min&pwd=
ptzGetCruiseMapList
Foscam IPCamera CGI User Guide
ptzGetCruiseMapInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
54
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
1=test1&point2=test2&point3=test3&point4=test4&point5=test5&point6=&poin
t7=&usr=admin&pwd=
Function
Delete a cruise map
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzDelCruiseMap
Param
name
Name of the cruise map
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzDelCruiseMap&name=test&usr=admin&pwd=
Function
Start a specificate cruise
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=ptzStartCruise
Param
mapName
Name of the cruise map
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=ptzStartCruise&
mapName
=test&usr=admin&pwd=
Function
Start current cruise
privilege
operator
ptzDelCruiseMap
Foscam IPCamera CGI User Guide
ptzStartCruise
ptzStopCruise
Copyright@ Shenzhen Foscam Intelligent Technology Limited
55
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
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseTime&
time
=5&usr=admin&pwd=
Function
Set time for continue cruise
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getCuriseTime
Param
Return
time
Time for continue cruise
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getCuriseTime&usr=admin&pwd=
Function
Set time for continue cruise by costomer
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseTimeCustomed
Param
time
Customed time for continue cruise
customed
Customed enable state-0-no,1-yes
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseTimeCustomed&time=5&customed=1&u
sr=admin&pwd=
Foscam IPCamera CGI User Guide
getCruiseTime
setCruiseTimeCustomed
Copyright@ Shenzhen Foscam Intelligent Technology Limited
56
getCruiseTimeCustomed
Function
Set time for continue cruise by costomer
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getCruiseTimeCustomed
Param
Return
time
Customed time for continue cruise
customed
Customed enable state-0-no,1-yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getCruiseTimeCustomed&usr=admin&pwd=
Function
Set counts for continue cruise
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseLoopCnt
Param
count
Counts for continue cruise
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseLoopCnt&
count
=5&usr=admin&pwd=
Function
Set counts for continue cruise
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getCruiseLoopCnt
Param
Return
count
Counts for continue cruise
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getCruiseLoopCnt&usr=admin&pwd=
Function
Set control mode for continue cruise, by time or count
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseCtrlMode
setCruiseLoopCnt
Foscam IPCamera CGI User Guide
getCruiseLoopCnt
setCruiseCtrlMode
Copyright@ Shenzhen Foscam Intelligent Technology Limited
57
Param
mode
Control mode-0:by time,1:by loop count
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setCruiseCtrlMode&
mode
=0&usr=admin&pwd=
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
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getCruiseCtrlMode&usr=admin&pwd=
Function
Set linger time for cruise,when pt arrive prepoint
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setCruisePrepointLingerTime
Param
name
Cruise map name
timeN
Time for each prepoint
Return
None
Note
N:[0-7],max number of prepoints in cruise
Example
/cgi-bin/CGIProxy.fcgi?cmd=setCruisePrePointLingerTime&
name
=123&time0=
0&time1=1&time2=2&time3=3&time4=4&time5=5&time6=6&time7=7&usr=ad
min&pwd=
Function
Set linger time for cruise,when pt arrive prepoint
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getCruisePrepointLingerTime
Param
name
Cruise map name
Return
timeN
Time for each prepoint
Note
N:[0-7],max number of prepoints in cruise
Example
/cgi-bin/CGIProxy.fcgi?cmd=getCruisePrePointLingerTime&name=123&usr=a
Foscam IPCamera CGI User Guide
setCruisePrePointLingerTime
getCruisePrePointLingerTime
Copyright@ Shenzhen Foscam Intelligent Technology Limited
58
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=
Function
Zoom out
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=zoomOut
Param
None
Return
None
Note
Only supported by the device has zoom lens
Example
/cgi-bin/CGIProxy.fcgi?cmd=zoomOut&usr=admin&pwd=
Function
Stop zoom run
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=zoomStop
Param
None
Return
None
Note
Only supported by the device has zoom lens
Example
/cgi-bin/CGIProxy.fcgi?cmd=zoomStop&usr=admin&pwd=
Function
Get the speed of Zoom
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getZoomSpeed
zoomOut
Foscam IPCamera CGI User Guide
zoomStop
getZoomSpeed
Copyright@ Shenzhen Foscam Intelligent Technology Limited
59
Param
None
Return
speed
0
Slow
1
Normal
2
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
0
Slow
1
Normal
2
Fast
Return
None
Note
Only supported by the device has zoom lens
Example
/cgi-bin/CGIProxy.fcgi?cmd=setZoomSpeed&usr=admin&pwd=&speed=1
Function
Set the selftest mode of PTZ
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd= setPTZSelfTestMode
Param
mode
0
No selftest
1
Normal selftest
2
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=setPTZSelfTestMode&mod
e=2
Function
Get the selftest mode of PTZ
privilege
operator
Foscam IPCamera CGI User Guide
setPTZSelfTestMode
getPTZSelfTestMode
Copyright@ Shenzhen Foscam Intelligent Technology Limited
60
Usage
/cgi-bin/CGIProxy.fcgi?cmd= getPTZSelfTestMode
Param
None
Return
mode
0
No selftest
1
Normal selftest
2
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
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd= setPTZPrePointForSelfTest
Param
name
Preset point name
Return
None
Note
Only supported by ipc that can enable ptz-selftest-2
Example
/cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=setPTZPrePointForSelfTes
t&name=TopMost
Function
Get the presetpoint for selftest of PTZ
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd= getPTZPrePointForSelfTest
Param
None
Return
name
Preset point name
Note
Only supported by ipc that can enable ptz-selftest
Example
/cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=getPTZPrePointForSelfTes
t
Function
Set informations of 485
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=set485Info
Foscam IPCamera CGI User Guide
getPTZPrePointForSelfTest
set485Info
Copyright@ Shenzhen Foscam Intelligent Technology Limited
61
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
privilege
operator
Usage
/cgi-bin/CGIProxy.fcgi?cmd=get485Info
Param
None
Return
rs485Protocol
Protocol
rs485Addr
Address
rs485Baud
Baud rate
rs485DataBit
DataBit
rs485StopBit
StopBit
rs485Check
Parity
Note
Only supported by ipc that can enable 485
Example
/cgi-bin/CGIProxy.fcgi?usr=admin&pwd=&cmd=get485Info
Function
Get IP Info
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getIPInfo
Param
None
Return
isDHCP
Obtain ip from dhcp server or not
ip
ip address(Can only support ipv4 yet)
Foscam IPCamera CGI User Guide
Network
getIPInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
62
gate
gateway(“0.0.0.0” when use dhcp)
mask
subnet mask
dns1
The first dns server addr(“0.0.0.0” when use dhcp)
dns2
The second dns server addr(“0.0.0.0” when use dhcp)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getIPInfo&usr=admin&pwd=
setIpInfo
Function
Set IP Info
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setIpInfo
Param
isDHCP
Obtain ip from dhcp server or not
ip
ip address(Can only support ipv4 yet)
gate
gateway
mask
subnet mask
dns1
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=
Function
Start scan the aps around
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=refreshWifiList
Param
None
Return
None
Note
This operation may takes a while, about 20 seconds or above, the other
operation on this device will be blocked during the period.
Example
/cgi-bin/CGIProxy.fcgi?cmd=refreshWifiList&usr=admin&pwd=
Foscam IPCamera CGI User Guide
refreshWifiList
Copyright@ Shenzhen Foscam Intelligent Technology Limited
63
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
last ten aps, then startNo=20
Return
totalCnt
Total count of aps
curCnt
Current aps count
apN
The detail info of ap N
Format:
ssid+mac+quality+isEncryp
t+encrypType
ssid
AP name
mac
AP’s mac address
quality
Signal quality(0~100)
isEncrypt
Encrypt or not
encrypType
0
Open mode
1
WEP
2
WPA
3
WPA2
4
WPA/WPA2
Note
Only 10 aps will be returned one time
Example
/cgi-bin/CGIProxy.fcgi?cmd=getWifiList&startNo=0&usr=admin&pwd=
Function
Set wifi config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setWifiSetting
Param
isEnable
Enable state
isUseWifi
Use wifi or not
ssid
AP name
netType
0
Infra net
1
Ad-hoc Not supported yet
encryptType
0
Open mode
1
WEP
2
WPA
3
WPA2
4
WPA/WPA2
Foscam IPCamera CGI User Guide
setWifiSetting
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
64
psk
The psk of WPA WPA2
authMode
0
Open mode
1
Shared key
2
Auto mode
keyFormat
0
ASIC
1
Hex
defaultKey
1~4
key1
key2
key3
key4
key1Len
64 or 128
key2Len
64 or 128
key3Len
64 or 128
key4Len
64 or 128
isNewFormat
1
Use in new version when you need encrypt wifi
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)
Return
None
Note
Camera will not connect to AP unless you enject your cable
Example
/cgi-bin/CGIProxy.fcgi?cmd=setWifiSetting&isEnable=1&isUseWifi=1&ssid=fosta
r_soft&netType=0&encryptType=4&psk=41,48,38&authMode=0&keyFormat=0&d
efaultKey=1&key1=&key2=&key3=&key4=&key1Len=64&key2Len=64&key3Len
=64&key4Len=64&usr=admin&pwd=
Function
Set wifi config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setWifiSettingNew
Param
isEnable
Enable state
isUseWifi
Use wifi or not
ssid
AP name(url encoded)
netType
0
Infra net
setWifiSettingNew
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
65
1
Ad-hoc Not supported yet
encryptType
0
Open mode
1
WEP
2
WPA
3
WPA2
4
WPA/WPA2
psk
The psk of WPA WPA2(url encoded)
authMode
0
Open mode
1
Shared key
2
Auto mode
keyFormat
0
ASIC
1
Hex
defaultKey
1~4
key1
key2
key3
key4
key1Len
64 or 128
key2Len
64 or 128
key3Len
64 or 128
key4Len
64 or 128
Return
None
Note
Camera will not connect to AP unless you enject your cable
Example
/cgi-bin/CGIProxy.fcgi?cmd=setWifiSettingNew&isEnable=1&isUseWifi=1&ssid=f
ostar_soft&netType=0&encryptType=4&psk=414838&authMode=0&keyFormat=
0&defaultKey=1&key1=&key2=&key3=&key4=&key1Len=64&key2Len=64&key3
Len=64&key4Len=64&usr=admin&pwd=
Function
Get wifi config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getWifiConfig
Param
None
Return
isEnable
Enable state
isUseWifi
Use wifi or not
isConnecte
Connected state
getWifiConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
66
d
connected
AP
Connedted ap
ssid
AP name
encryptTyp
e
0
Open mode
1
WEP
2
WPA
3
WPA2
4
WPA/WPA2
psk
The psk of WPA WPA2
authMode
0
Open mode
1
Shared key
2
Auto mode
keyFormat
0
ASIC
1
Hex
defaultKey
1~4
key1
key2
key3
key4
key1Len
64 or 128
key2Len
64 or 128
key3Len
64 or 128
key4Len
64 or 128
Return
None
Note
Camera will not connect to AP unless you enject your cable
Example
/cgi-bin/CGIProxy.fcgi?cmd=getWifiConfig&usr=admin&pwd=
Function
Get ports of camera
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPortInfo
Param
None
Return
webPort
http port(default value is 88)
httpsPort
https port(default value is 443)
mediaPort
media port(default value is 88)
getPortInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
67
onvifPort
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=
setPortInfo
Function
Set ports of camera
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPortInfo
Param
webPort
http port(default value is 88)
mediaPort
media port(default value is 88)
httpsPort
https port(default value is 443)
onvifPort
Onvif Port(default value is 888)
Return
None
Note
.Re login is needed after call this CGI command
.
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=setPortInfo&webPort=88&mediaPort=88&httpsPo
rt=443&onvifPort=888&usr=admin&pwd=
Function
Get UpnP config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getUPnPConfig
Param
None
Return
isEnable
is Enable UpnP function
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getUPnPConfig&usr=admin&pwd=
Function
Set UpnP config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setUPnPConfig
Foscam IPCamera CGI User Guide
getUPnPConfig
setUPnPConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
68
Param
isEnable
is Enable UpnP function
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setUPnPConfig&isEnable=1&usr=admin&pwd=
getDDNSConfig
Function
Get DDNS config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getDDNSConfig
Param
None
Return
isEnable
is Enable DDNS update
hostName
DDNS domain
ddnsServer
0
Factory DDNS
1
Oray
2
3322
3
no-ip
4
dyndns
user
user name
password
password
factoryDDNS
factory ddns
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getDDNSConfig&usr=admin&pwd=
Function
Set DDNS config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setDDNSConfig
Param
isEnable
is Enable DDNS update
hostName
DDNS domain
ddnsServer
0
Factory DDNS
1
Oray
2
3322
3
no-ip
4
dyndns
user
user name
Foscam IPCamera CGI User Guide
setDDNSConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
69
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
Param
ftpAddr
FTP server address, you can contain sub directory in it
ftpPort
FTP port
mode
0
PASV mode
1
PORT mode
userName
user name
password
password
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setFtpConfig&ftpAddr=ftp://192.168.1.2/sbuDir&ft
pPort=21&mode=0&userName=test&password=test&usr=admin&pwd=
Function
Set FTP config (Password to support special characters)
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setFtpConfigNew
Param
ftpAddr
FTP server address, you can contain sub directory in it
ftpPort
FTP port
mode
0
PASV mode
1
PORT mode
userName
user name
password
Encoded password
Eg: 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)
Return
None
Foscam IPCamera CGI User Guide
setFtpConfigNew
Copyright@ Shenzhen Foscam Intelligent Technology Limited
70
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
Param
ftpAddr
FTP server address, you can contain sub directory in it
ftpPort
FTP port
mode
0
PASV mode
1
PORT mode
userName
user name
password
password
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getFtpConfig&usr=admin&pwd=
Function
Test FTP server
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=testFtpServer
Param
ftpAddr
FTP server address, you can contain sub directory in it
ftpPort
FTP port
mode
0
PASV mode
1
PORT mode
fptuserName
user name
ftppassword
password
Return
testResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=testFtpServer&ftpAddr=ftp://192.168.1.2/sbuDir&f
Foscam IPCamera CGI User Guide
testFtpServer
Copyright@ Shenzhen Foscam Intelligent Technology Limited
71
tpPort=21&mode=0&fptuserName=test&ftppassword=test&usr=admin&pwd=
testFtpServerNew
Function
Test FTP server (Password to support special characters)
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=testFtpServerNew
Param
ftpAddr
FTP server address, you can contain sub directory in it
ftpPort
FTP port
mode
0
PASV mode
1
PORT mode
fptuserName
user name
ftppassword
Encoded password
Eg: 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)
Return
testResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=testFtpServerNew&ftpAddr=ftp://192.168.1.2/sbu
Dir&ftpPort=21&mode=0&fptuserName=test&ftppassword=49,50,51,38&usr=a
dmin&pwd=
Function
Get mail config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getSMTPConfig
Param
None
Return
isEnable
is enable camera send mail?
server
SMTP server address
port
smtp port
isNeedAuth
Need auth user account or not
tls
0
None
1
TLS
Foscam IPCamera CGI User Guide
getSMTPConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
72
2
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?
server
SMTP server address
port
smtp port
isNeedAuth
Need auth user account or not
tls
0
None
1
TLS
2
STARTTLS
user
user name
password
password
sender
reciever
Use “,” between 2 senders, for exapler:
aaa@123.com,bbb@456.com
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSMTPConfig&isEnable=1&server=smtp.gmail.
com&port=587&isNeedAuth=1&user=test&password=test&send=test@gmail.c
om&reciever=aa@123.com,bb@456.com&usr=admin&pwd=
Function
set mail config (
Password to support special characters
)
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSMTPConfigNew
Foscam IPCamera CGI User Guide
setSMTPConfigNew
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
73
Param
isEnable
is enable camera send mail?
server
SMTP server address
port
smtp port
isNeedAuth
Need auth user account or not
tls
0
None
1
TLS
2
STARTTLS
user
user name
password
Encoded password
Eg: 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)
sender
reciever
Use “,” between 2 senders, for exapler:
aaa@123.com,bbb@456.com
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setSMTPConfigNew&isEnable=1&server=smtp.g
mail.com&port=587&isNeedAuth=1&user=test&password=49,50,51,38&send=
test@gmail.com&reciever=aa@123.com,bb@456.com&usr=admin&pwd=
Function
Test mail setting
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=smtpTest
Param
smtpServer
SMTP server address
port
smtp port
isNeedAuth
Need auth user account or not
tls
0
None
1
TLS
2
STARTTLS
user
user name
password
password
sender
Send Email address
smtpTest
Copyright@ Shenzhen Foscam Intelligent Technology Limited
74
Return
testResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=smtpTest&
smtpServer
=smtp.gmail.com&port=587
&isNeedAuth=1&user=test&password=test&sender=test@gmail.com&usr=ad
min&pwd=
smtpTestNew
Function
Test mail setting (
Password to support special characters
)
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=smtpTestNew
Param
smtpServer
SMTP server address
port
smtp port
isNeedAuth
Need auth user account or not
tls
0
None
1
TLS
2
STARTTLS
user
user name
password
Encoded password
Eg: 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)
sender
Send Email address
Return
testResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=smtpTestNew&smtpServer=smtp.gmail.com&port=
587&isNeedAuth=1&user=test&password=49,50,51,38&sender=test@gmail.c
om&usr=admin&pwd=
Function
Set p2p status
privilege
admin
Foscam IPCamera CGI User Guide
setP2PEnable
Copyright@ Shenzhen Foscam Intelligent Technology Limited
75
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setP2PEnable
enable
0
Disable
1
Enable
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setP2PEnable&enable=1&usr=admin&pwd=
getP2PEnable
Function
Get p2p status
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getP2PEnable
Param
None
enable
0
Disable
1
Enable
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getP2PEnable&usr=admin&pwd=
Function
Set p2p port
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setP2PPort
port
P2P port number
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setP2PPort&
port
=12345&usr=admin&pwd=
Function
Get p2p port
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getP2PPort
Param
None
Return
port
P2P port number
Note
Foscam IPCamera CGI User Guide
setP2PPort
getP2PPort
Copyright@ Shenzhen Foscam Intelligent Technology Limited
76
Example
/cgi-bin/CGIProxy.fcgi?cmd=getP2PPort&usr=admin&pwd=
getP2PInfo
Function
Get p2p UID
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getP2PInfo
Param
None
Return
uid
P2P UID
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getP2PInfo&usr=admin&pwd=
Function
Get PPPoE config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getPPPoEConfig
Param
None
Return
isEnable
is Enable PPPoE function
userName
userName
password
password
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getPPPoEConfig&usr=admin&pwd=
Function
Set PPPoE config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setPPPoEConfig
Param
isEnable
is Enable PPPoE function
userName
userName
password
password
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setPPPoEConfig&isEnable=1&userName=usr&p
assword=pwd&usr=admin&pwd=
getPPPoEConfig
Foscam IPCamera CGI User Guide
setPPPoEConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
77
EnableOnvifAgent
Function
Enable onvifAgent
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=EnableOnvifAgent
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=EnableOnvifAgent&usr=admin&pwd=
Function
Disable onvifAgent
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=DisableOnvifAgent
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=DisableOnvifAgent&usr=admin&pwd=
Function
GetOnvifAgentStat
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=GetOnvifAgentStat
Param
None
Return
OnvifAgentStat
disable
enable
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=GetOnvifAgentStat&usr=admin&pwd=
Function
getNetMode
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getNetMode
DisableOnvifAgent
Foscam IPCamera CGI User Guide
GetOnvifAgentStat
getNetMode
Copyright@ Shenzhen Foscam Intelligent Technology Limited
78
Param
None
Return
netMode
0:wired
1:wireless
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getNetMode&usr=admin&pwd=
wifiTest
Function
Wifi connect test
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=wifiTest
Param
isEnable
Enable state
isUseWifi
Use wifi or not
ssid
AP name
netType
0
Infra net
1
Ad-hoc Not supported yet
encryptType
0
Open mode
1
WEP
2
WPA
3
WPA2
4
WPA/WPA2
psk
The psk of WPA WPA2
authMode
0
Open mode
1
Shared key
2
Auto mode
keyFormat
0
ASIC
1
Hex
defaultKey
1~4
key1
key2
key3
key4
key1Len
64 or 128
key2Len
64 or 128
key3Len
64 or 128
key4Len
64 or 128
isNewFormat
1
Use in new version when you need encrypt wifi
Foscam IPCamera CGI User Guide
Copyright@ Shenzhen Foscam Intelligent Technology Limited
79
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)
Return
isEnable
0: success,wifi info can connect route
1:fail,
Note
only can use when Camera wired cable connect
Example
/cgi-bin/CGIProxy.fcgi?cmd=
wifiTest
&isEnable=1&isUseWifi=1&ssid=fostar_soft
&netType=0&encryptType=4&psk=41,48,38&authMode=0&keyFormat=0&default
Key=1&key1=&key2=&key3=&key4=&key1Len=64&key2Len=64&key3Len=64&
key4Len=64&usr=admin&pwd=
Device manage
Function
Set system time
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setSystemTime
Param
timeSource
0
Get time from NTP server
1
Set time manually
ntpServer
ntp server addr
Support ntp server:
time.nist.gov time.kriss.re.kr time.windows.com
time.nuri.net
dateFormat
0
YYYY-MM-DD
1
DD/MM/YYYY
2
MM/DD/YYYY
timeFormat
0
12 hours
1
24 hours
timeZone
The seconds between local time and GMT time.
For example: timeZone=3600 presents GMT-01:00
timeZone=-3600 presents GMT+01:00
isDst
Daylight saving time (0-disable,1-enable)
dst
Not in use currently
year
Foscam IPCamera CGI User Guide
setSystemTime
Copyright@ Shenzhen Foscam Intelligent Technology Limited
80
mon
day
hour
minute
sec
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
0
Get time from NTP server
1
Set time manually
ntpServer
ntp server addr
Support ntp server:
time.nist.gov time.kriss.re.kr time.windows.com
time.nuri.net
dateFormat
0
YYYY-MM-DD
1
DD/MM/YYYY
2
MM/DD/YYYY
timeFormat
0
12 hours
1
24 hours
timeZone
The seconds between local time and GMT time.
For example: timeZone=3600 presents GMT-01:00
timeZone=-3600 presents GMT+01:00
isDst
Daylight saving time (0-disable,1-enable)
dst
Not in use currently
year
mon
day
hour
Foscam IPCamera CGI User Guide
Copyright@ Shenzhen Foscam Intelligent Technology Limited
81
minute
sec
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
Return
ctrlResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=openInfraLed&usr=admin&pwd=
Function
Force close infra led
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=closeInfraLed
Param
None
Return
ctrlResult
0
Success
-1
Fail
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=closeInfraLed&usr=admin&pwd=
Function
Get infra led config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getInfraLedConfig
Param
None
Return
mode
0
Auto mode
1
Manual mode
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getInfraLedConfig&usr=admin&pwd=
Foscam IPCamera CGI User Guide
closeInfraLed
getInfraLedConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
82
setInfraLedConfig
Function
Set infra led config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setInfraLedConfig&mode=0
Param
mode
0
Auto mode
1
Manual mode
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setInfraLedConfig&mode=&usr=admin&pwd=
Function
Get config for infra led switch schedule
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleInfraLedConfig
Param
None
Return
startHourN
Start hour
startMinN
Start Minitue
endHourN
End hour
endMinN
End minitue
Note
N:[0-2],the number of infra led switch schedule
Example
/cgi-bin/CGIProxy.fcgi?cmd=getScheduleInfraLedConfig&usr=admin&pwd=
Function
Set config for infra led switch schedule
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setScheduleInfraLedConfig&mode=0
Param
startHourN
Start hour
startMinN
Start Minitue
endHourN
End hour
endMinN
End minitue
Return
None
Note
N:[0-2],the number of infra led switch schedule
Example
/cgi-bin/CGIProxy.fcgi?cmd=setInfraLedConfig&mode=&usr=admin&pwd=
getScheduleInfraLedConfig
Foscam IPCamera CGI User Guide
setScheduleInfraLedConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
83
Function
Get all device state
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getDevState
Param
None
Return
IOAlarm
0
Disabled
1
No alaram
2
Detect alarm
motionDetectAlar
am
0
Disabled
1
No alarm
2
Detect alarm
soundAlarm
0
Disabled
1
No alarm
2
Detect alarm
record
0
Not in recording
1
Recording
sdState
0
No sd card
1
Sd card ok
2
Sd card read only
sdFreeSpace
Free space of sd card by unit of k
sdTotalSpace
Total space of sd card by unit of k
ntpState
0
Disabled
1
Update success
2
Update fail
ddnspState
0
Disabled
1
Update success
2
Update fail
url
DDNS url
upnpState
0
Disabled
1
Update success
2
Update fail
isWifiConnected
0
No wifi connected
1
Connected
wifiConnectedAP
The ssid of the ap which has been connected
infraLedState
0
OFF
1
ON
Foscam IPCamera CGI User Guide
getDevState
Copyright@ Shenzhen Foscam Intelligent Technology Limited
84
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
Return
devName
Camera name
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getDevName&usr=admin&pwd=
Function
Set camera name
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setDevName
Param
devName
Camera name
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setDevName&devName=test&usr=admin&pwd=
Function
Get camera information
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getDevInfo
Param
None
Return
productNam
e
Camera model
serialNo
Serial no
devName
Camera name
mac
Mac address
year
mon
setDevName
Foscam IPCamera CGI User Guide
getDevInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
85
day
hour
min
sec
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
/cgi-bin/CGIProxy.fcgi?cmd=getDevAttr
Param
None
Return
alarmAttr
Bit[0]:motion;Bit[1]:sound;Bit[2]:io;Bit[3]:temperature;Bit[4]:
humidiy;
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=
getDevAttr
&usr=admin&pwd=
Function
Get camera model number
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductModel
Param
None
Return
model
Camera model number
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductModel&usr=admin&pwd=
Function
Get camera model name
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductModelName
Foscam IPCamera CGI User Guide
getProductModel
getProductModelName
Copyright@ Shenzhen Foscam Intelligent Technology Limited
86
Param
None
Return
modelName
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
Return
language
Camera main language
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductLanguage&usr=admin&pwd=
Function
Get camera sensor type number
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductSensorType
Param
None
Return
sensorType
Camera sensor type number
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductSensorType&usr=admin&pwd=
Function
Get camera wifi type number
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductWifiType
Param
None
Return
wifiType
Camera wifi type number
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductWifiType&usr=admin&pwd=
Foscam IPCamera CGI User Guide
getProductSensorType
getProductWifiType
Copyright@ Shenzhen Foscam Intelligent Technology Limited
87
getProductSdFlag
Function
Whether camera support sd card
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductSdFlag
Param
None
Return
sdFlag
Camera flag to support sd card-0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductSdFlag&usr=admin&pwd=
Function
Whether camera is outdoor machine
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductOutdoorFlag
Param
None
Return
outdoorFlag
Whether camera is outdoor machine-0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductOutdoorFlag&usr=admin&pwd=
Function
Whether camera is pt machine
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductPtFlag
Param
None
Return
ptFlag
Whether camera is pt machine-
0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductPtFlag&usr=admin&pwd=
Function
Whether camera is zoom machine
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductZoomFlag
Param
None
getProductOutdoorFlag
Foscam IPCamera CGI User Guide
getProductPtFlag
getProductZoomFlag
Copyright@ Shenzhen Foscam Intelligent Technology Limited
88
Return
zoomFlag
Whether camera is zoom machine-0:no,1:yes
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
Return
rs485Flag
Whether camera support rs485-
0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductRs485Flag&usr=admin&pwd=
Function
Whether camera support IO alarm
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductIoAlarmFlag
Param
None
Return
ioAlarmFlag
Whether camera support IO alarm-0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductIoAlarmFlag&usr=admin&pwd=
Function
Whether camera support Onvif
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductOnvifFlag
Param
None
Return
onvifFlag
Whether camera support onvif-
0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductOnvifFlag&usr=admin&pwd=
Foscam IPCamera CGI User Guide
getProductIoAlarmFlag
getProductOnvifFlag
Copyright@ Shenzhen Foscam Intelligent Technology Limited
89
getProductP2pFlag
Function
Whether camera support P2p
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductP2pFlag
Param
None
Return
p2pFlag
Whether camera support p2p-
0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductP2pFlag&usr=admin&pwd=
Function
Whether camera support Wps
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductWpsFlag
Param
None
Return
wpsFlag
Whether camera support wps-0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductWpsFlag&usr=admin&pwd=
Function
Whether camera support audio-speak
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductAudioFlag
Param
None
Return
audioFlag
Whether camera support audio for speak-
0:no,1:yes
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductAudioFlag&usr=admin&pwd=
Function
Whether camera support audio-talk
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductTalkFlag
Param
None
getProductWpsFlag
Foscam IPCamera CGI User Guide
getProductAudioFlag
getProductTalkFlag
Copyright@ Shenzhen Foscam Intelligent Technology Limited
90
Return
talkFlag
Whether camera support audio for talk-0:no,1:yes
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
Return
appVer
camera application version
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductAppVer&usr=admin&pwd=
Function
Get camera Information
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getProductAllInfo
Param
None
Return
model
Model number
modelName
Model Name
language
Main language
sensorType
Sensor type number
wifiType
Wifi Type Number
reserve1
Reserve
reserve2
Reserve
reserve3
Reserve
reserve4
Reserve
sdFlag
Whether machine support sd card
outdoorFlag
Whether machine is outdoor
ptFlag
Whether machine support pt
zoomFlag
Whether machine support zoom
rs485Flag
Whether machine support rs485
ioAlarmFlag
Whether machine support io alarm
Foscam IPCamera CGI User Guide
getProductAllInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
91
onvifFlag
Whether machine support onvif
p2pFlag
Whether machine support p2p
wpsFlag
Whether machine support wps
audioFlag
Whether machine support audio-speak
talkFlag
Whether machine support audio-talk
reserveFlag1
reserve
reserveFlag2
reserve
reserveFlag3
reserve
reserveFlag4
reserve
appVer
Camera application version
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getProductAllInfo&usr=admin&pwd=
Function
setcamera Information
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setProductAllInfo
Param
model
Model number
language
Main language
sensorType
Sensor type number
wifiType
Wifi Type Number
sdFlag
Whether machine support sd card
outdoorFlag
Whether machine is outdoor
ptFlag
Whether machine support pt
zoomFlag
Whether machine support zoom
rs485Flag
Whether machine support rs485
ioAlarmFlag
Whether machine support io alarm
onvifFlag
Whether machine support onvif
p2pFlag
Whether machine support p2p
wpsFlag
Whether machine support wps
audioFlag
Whether machine support audio-speak
talkFlag
Whether machine support audio-talk
return
setProductAllInfo
Copyright@ Shenzhen Foscam Intelligent Technology Limited
92
Note
Only Lan net use
Example
/cgi-bin/CGIProxy.fcgi?cmd=setProductAllInfo&language=0&talkFlag=1&&usr
=admin&pwd=
getNVRApSigQuality
Function
Get camera application version
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getNVRApSigQuality
Param
ssid
Check ssid name
Return
NVRApSigQu
ality
Ssid signal value
Note
When wired connect,return 100
Example
/cgi-bin/CGIProxy.fcgi?cmd=getNVRApSigQuality&ssid=foscam_ssid&usr=ad
min&pwd=
Function
Get camera voice enable state
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=
getVoiceEnableState
Param
None
Return
isEnable
0:disable;1:enable
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=
getVoiceEnableState
&usr=admin&pwd=
Function
Get camera voice enable state
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setVoiceEnableState
Param
isEnable
0:disable;1:enable
Return
Foscam IPCamera CGI User Guide
getVoiceEnableState
setVoiceEnableState
Copyright@ Shenzhen Foscam Intelligent Technology Limited
93
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setVoiceEnableState&isEnable=1&usr=admin&pwd
=
getGeneratePubKey
Function
Get public key generated by camera for software reset
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getGeneratePubKey
Param
None
Return
genResult
The result that camera generate public key for software reset
genPubLen
The length of public key
pubKey
Public key
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getGeneratePubKey&usr=admin&pwd=
Function
Set camera reset to factory by software
privilege
visitor
Usage
/cgi-bin/CGIProxy.fcgi?cmd=toolRestoreToFactory
Param
codeLen
Code length for camera reset
code
Code for camera reset
Return
restoreResult
The result that camera reset
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=toolRestoreToFactory&codeLen=10&code=xxxxx
xxxxx&&usr=admin&pwd=
Function
Reboot camera
Foscam IPCamera CGI User Guide
toolRestoreToFactory
System
rebootSystem
Copyright@ Shenzhen Foscam Intelligent Technology Limited
94
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=rebootSystem
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=rebootSystem&usr=admin&pwd=
restoreToFactorySetting
Function
Restore to factory setting
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=restoreToFactorySetting
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd= restoreToFactorySetting&usr=admin&pwd=
Function
Export config file
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=exportConfig
Param
None
Return
fileName
The config name
Note
After call this command, you can get the config file by visit the following addr:
/configs/export/configs.bin
Example
/cgi-bin/CGIProxy.fcgi?cmd=exportConfig&usr=admin&pwd=
Function
Import config file
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=importConfig&usr=admin&pwd=
Param
None
Return
None
Note
System will reboot automatically after this operation
Foscam IPCamera CGI User Guide
exportConfig
ImportConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
95
Example
<form name="form5" method="post" target="retframe" enctype="multipart/form-data"
action="cgi-bin/ CGIProxy.fcgi?cmd=importConfig&usr=admin&pwd=" >
<input type="file" name="setting_file" >
<input type="submit" value="import" >
</form>
FwUpgrade
Function
Upgrade firmware
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=fwUpgrade&usr=admin&pwd=
Param
None
Return
upgradeResu
lt
0
Upgrade success
-1
Upgrade fail
Note
System will reboot automatically after this operation.
This action may takes about 120s when upgrade app firmware, takes about
60s when upgrade system firmware
Example
<form name="form5" method="post" target="retframe" enctype="multipart/form-data"
action="cgi-bin/ CGIProxy.fcgi?cmd=fwUpgrade&usr=admin&pwd=" >
<input type="file" name="fw_file" >
<input type="submit" value="upgrade" >
</form>
Function
remove firewall patch
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=removePatch
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=removePatch&usr=admin&pwd=
Foscam IPCamera CGI User Guide
removePatch
Copyright@ Shenzhen Foscam Intelligent Technology Limited
96
MISC
Function
Get firewall config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getFirewallConfig
Param
None
Return
isEnable
Use firewall or not
rule
0
The ip list can’t access
1
Only allow the ip list to access
ipListN
The ip address(Network address) of list N
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getFirewallConfig&usr=admin&pwd=
Function
Set firewall config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setFirewallConfig
Param
isEnable
Use firewall or not
rule
0
The ip list can’t access
1
Only allow the ip list to access
ipListN
The ip address(Network address) of list N
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setFirewallConfig&isEnable=1&rule=0&ipList0=0
&ipList1=0&ipList2=0&ipList3=0&ipList4=0&ipList5=0&ipList6=0&ipList7=0&us
r=admin&pwd=
Function
Get system log
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getLog
Param
offset
Where you want to start get log
getFirewallConfig
Foscam IPCamera CGI User Guide
setFirewallConfig
getLog
Copyright@ Shenzhen Foscam Intelligent Technology Limited
97
count
How many logs you want to get, must less then 20
Return
totalCnt
Total log count
curCnt
current log count
logN
log information, consist by
time+user+ip+logID
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
Param
None
Return
volume
Volume value (0~100)
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getAudioVolume&usr=admin&pwd=
Function
Set Audio Volume
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setAudioVolume
Param
volume
Volume value (0~100)
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setAudioVolume&volume=100&usr=admin&pwd=
Function
Get Wifi Mode
privilege
admin
Foscam IPCamera CGI User Guide
setAudioVolume
getWifiMode
Copyright@ Shenzhen Foscam Intelligent Technology Limited
98
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getWifiMode
Param
None
Return
wifiMode
0
sta
1
softAp
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getWifiMode&usr=admin&pwd=
getTemperatureAlarmConfig
Function
Get Temperature Alarm Config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getTemperatureAlarmConfig
Param
None
Return
isEnable
0
disable
1
enable
linkage
Motion alarm linkage
( bit7| bit3 | bit2 | bit1 | bit0 )
bit0:Ring
bit1:Send mail
bit2:Snap picture
bit3:Record
bit7:Push to phone
topLimit
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=
Function
Set Temperature Alarm Config
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setTemperatureAlarmConfig
Param
isEnable
0
disable
1
enable
linkage
Motion alarm linkage
bit0:Ring
Foscam IPCamera CGI User Guide
setTemperatureAlarmConfig
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Foscam IPCamera CGI User Guide
99
( bit7| bit3 | bit2 | bit1 | bit0 )
bit1:Send mail
bit2:Snap picture
bit3:Record
bit7:Push to
phone
topLimit
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
/cgi-bin/CGIProxy.fcgi?cmd=setTemperatureAlarmConfig&isEnable=1&linkag
e=129&topLimit=40&lowerLimit=20snapInterval=2&triggerInterval=5&schedul
e0=1023&schedule1=1023&schedule2=1023&schedule3=1023&schedule4=1023
&schedule5=1023&schedule6=1023&usr=admin&pwd=
Function
Get Temperature Degree
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getTemperatureState
Param
None
Return
degree
Temperature ℃！
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=getTemperatureState&usr=admin&pwd=
Function
Refresh default list
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=setMusicDefaultListRefresh
getTemperatureState
Music
setMusicDefaultListRefresh
Copyright@ Shenzhen Foscam Intelligent Technology Limited
100
Param
None
Return
None
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setMusicDefaultListRefresh&usr=admin&pwd=
getMusicListsName
Function
Get Music lists name
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMusicListsName
Param
None
Return
getResult
0
Sucess
-1
Faild
cnt
List number
list0
List0 name
list1
List1 name
list2
List2 name
Note
Example
/cgi-bin/CGIProxy.fcgi?cmd=setMusicDefaultListRefresh&usr=admin&pwd=
Function
Get Musics name of list
privilege
admin
Usage
/cgi-bin/CGIProxy.fcgi?cmd=getMusicsNameOfList
Param
name
List name
startNo
Get music start from startNo
musicNum
Expect to get music numbers
Return
getResult
0
Sucess
-1
Faild
cnt
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
getMusicsNameOfList
Copyright@ Shenzhen Foscam Intelligent Technology Limited
Loading...