Cmaras IP. www.foscam.

es

IP Camera CGI V1.27

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

Version Editor 1.0 Maverick Gao 1.01 Maverick Gao

Date Modify 2007-11-21 system software x.x.1.2 2008-07-25 system software x.x.1.17 get_params.cgi add parameter wifi_channel wifi_authtype wifi_keyformat wifi_key1_bits wifi_key2_bitswifi_key3_bitswifi_key4_bits set_wifi.cgi add parameterchannelauthtype keyformat key1_bits key2_bits key3_bits key4_bits modify snapshot.cgiadd authentication method use username and password in param directly add videostream.cgi 2008-08-06 system software x.x.1.18 modify camera_control.cgiadd PT control 2009-01-07 system software x.x.1.32 2009-02-07 system software x.x.1.33 chang motion detection sensibility add alarm scheduler related param 2009-04-29 system software x.x.1.39 add videostream.asf in videostream.cgi add resolution param 2009-06-13 system software x.x.1.41 in decoder_control.cgi add onestep param add comm_write.cgi add set_forbidden.cgi add get_forbidden.cgi add set_misc.cgi add get_misc.cgi add set_decoder.cgi in get_params.cgi add param : decoder_baud 2009-06-19 system software x.x.1.42 in set_misc.cgi get_misc.cgi param added ptz_patrol_rate, ptz_patrol_up_rate, ptz_patrol_down_rate, ptz_patrol_left_rate, ptz_patrol_right_rate 2009-08-03 system software x.x.1.43 add wifi_scan.cgi add get_wifi_scan_result.cgi add get_log.cgi

1.02 1.03 1.04

Maverick Gao Maverick Gao Maverick Gao Maverick Gao Maverick Gao

1.05

1.06

1.07

Maverick Gao

1.08

Maverick Gao

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

1.09 1.10

Maverick Gao Maverick Gao

1.11 1.12

Maverick Gao Maverick Gao

1.13

Maverick Gao

1.14

Maverick Gao

1.15

Maverick Gao

2009-08-22 system software x.x.1.44 modify get_wifi_scan_result.cgi return value 2009-09-25 system software x.x.2.2 in get_params.cgi add param of alarm_ioin_level alarm_ioout_level in set_pppoe.cgi modify user and pwd s longest character as 64 in set_ddns.cgi modify userpwdhostproxy_svr s longest character as 64 in set_mail.cgi modify svr user pwd sender receiver1receiver2receiver3receiver4 s longest character as 64 in set_alarm.cgi add param of ioin_levelioout_level add check_user.cgi add backup_params.cgi add restore_params.cgi 2009-10-07 system software x.x.2.2 add set_mac.cgi 2010-04-26 system software x.x.2.17 modify get_misc.cgi and set_misc.cgi param description in get_params.cgi and set_alarm.cgi add alarm_http related param(system software x.x.2.12) in videostream.cgi and videostream.asf add param of rate in get_params.cgi and set_ftp.cgi add param of ftp_filename and ftp_numberoffiles 2010-05-26 system software x.x.2.20 modify get_params.cgi and set_ddns.cgi param description modify get_status.cgi param description add set_factory_ddns,cgi add get_factory_ddns.cgi add restore_factory_ddns.cgi 2010-06-03 system software x.x.2.21 modify decoder_control.cgi param description modify get_params.cgi param description modify set_alarm.cgi param description 2010-08-17 system software x.x.2.27 modify set_misc.cgi param description modify get_misc.cgi param description modify get_params.cgi and set_mail.cgi param descriptionadd param of tls modify test_mail.cgi return value

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

1.16 1.17

Maverick Gao Maverick Gao

1.18

Maverick Gao

1.19

Maverick Gao

1.20 1.21 1.22

Maverick Gao Maverick Gao Maverick Gao

1.23

Maverick Gao Maverick Gao

1.24

2010-09-03 system software x.x.2.28 add decoder_control.cgi with param of degree 2010-09-27 system software x.x.2.29 modify get_params.cgi param description add alarm_motion_compensationdaylight_saving_time ftp_schedule_enableftp_schedule series param add modify set_ftp.cgi param description schedule_enableschedule param description add modify set_datetime.cgi param daylight_saving_time param modify set_alarm.cgi param description add motion_compensation param add modify set_misc.cgi param description ptz_preset_onstart param add modify get_misc.cgi param description ptz_preset_onstart param 2010-11-20 system software x.x.2.32 modify get_params.cgi param description add msn_usermsn_pwd series param add set_msn.cgi add get_status.cgi return param msn_status 2010-12-07 system software x.x.2.34 modify get_params.cgi param description,add msn_friend series param modify set_msn.cgi paramadd friend series param modify set_ddns.cgi get_params.cgi get_factory_ddns.cgi and set_factory_ddns.cgi s ddns param description modify get_status.cgi return ddns_status param description 2011-3-3 system software x.x.2.37 add set_factory_params.cgi 2011-3-30 system software x.x.2.38 add set_extra_io.cgi 2011-5-23 system software x.x.2.40 modify get_params.cgi param description,add dhcp_vendor param modify set_network.cgi param description add dhcp_vendor param 2011-6-25 system software x.x.2.40 modify get_parames.cgi , set_ddns.cgiget_status.cgi add easynet platform 2011-7-1 system software x.x.2.41 modify get_parames.cgi , set_alarm.cgi

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

1.25 1.26

Maverick Gao Maverick Gao Maverick Gao

2011-7-18 2011-8-11

1.27

2011-9-17

get_status.cgi add voice motion detection content system software x.x.2.41 In get_status.cgi add wifi_status system software x.x.2.42 In get_params.cgi and set_wifi.cgi add wifi_country param system software x.x.2.43 modify ddns param description add ftp_retain param

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

Content

IP Camera CGI Introduction ...............................................................................................8 Check_user.cgi.................................................................................................................9 snapshot.cgi ....................................................................................................................9 Videostream.cgi ..............................................................................................................10 videostream.asf ..............................................................................................................10 get_status.cgi ................................................................................................................ 11 get_camera_params.cgi ................................................................................................13 decoder_control.cgi .......................................................................................................13 set_extra_io.cgi .............................................................................................................14 Camera_control.cgi .........................................................................................................15 reboot.cgi .......................................................................................................................15 restore_factory.cgi ..........................................................................................................15 get_params.cgi..............................................................................................................16 upgrade_firmware.cgi ....................................................................................................20 upgrade_htmls.cgi .........................................................................................................21 set_alias.cgi ..................................................................................................................21 set_datetime.cgi .............................................................................................................21 set_users.cgi .................................................................................................................22 set_devices.cgi..............................................................................................................22 set_network.cgi .............................................................................................................23 set_wifi.cgi .....................................................................................................................23 set_pppoe.cgi .................................................................................................................24 set_upnp.cgi ..................................................................................................................24 set_ddns.cgi ..................................................................................................................24 set_ftp.cgi......................................................................................................................25 set_mail.cgi ....................................................................................................................27 set_msn.cgi ....................................................................................................................27 set_alarm.cgi ..................................................................................................................28 comm_write.cgi .............................................................................................................29 set_forbidden.cgi ...........................................................................................................30 get_forbidden.cgi ...........................................................................................................30 set_misc.cgi ..................................................................................................................31 get_misc.cgi ...................................................................................................................31 set_decoder.cgi ..............................................................................................................32 wifi_scan.cgi ..................................................................................................................32 get_wifi_scan_result.cgi ..................................................................................................32 get_log.cgi.....................................................................................................................33 test_mail.cgi ...................................................................................................................34 test_ftp.cgi.....................................................................................................................34 backup_params.cgi.........................................................................................................35 restore_params.cgi........................................................................................................35 set_factory_params.cgi .................................................................................................35
set_mac.cgi ........................................................................................ 35
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es set_factory_ddns.cgi .......................................................................................................36

get_factory_ddns.cgi .....................................................................................................37 restore_factory_ddns.cgi ...............................................................................................37

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

IP camera cgi introduction

Here CGI is based on http protocol portClient Procedurecould be internet page on web or other procedurecan perform various operations on the device by the CGI cgi security authentication: the cgi listed below all need security authentication when visit. Besides, different cgi port require different permission, there are three level permission: visitor,operator and administrator. But the permission is decided by the user of device. Specific security authentication mechanism supported in two ways: in http protocol, the Basic security authentication mechanism in cgi param, add username and password directly. The way to visit cgi: compare with all http method, the cgi listed in this article only support get and post. Among them, the upgrade_firmware.cgi and upgrade_htmls.cgi only support post, and others only
support get. Get example: <form action=/set_mail.cgi> <input name=svr> <input name=user> <input name=pwd> <input name=sender> <input name=receiver1> <input name=receiver2> <input name=receiver3> <input name=receiver4>

<input type=hidden name=next_url value=index.htm> <input type=submit value=ok> </form> Post example: <form action=upgrade_firmware.cgi?next_url=index.htm method=post enctype=multipart/form-data> <input type=file name=file size=20> </form> cgis returnaccording the different return information, this article devide the cgi into two kinds: The cgi to obtain device status and param, include get_status.cgi and get_params.cgi. they return include device status and para text, the specific format seems like javascript Variable definitionto define all the device status or param as variable then return, such as : var id=003456789A0A;
var sys_ver=0.0.1.2; var app_ver=0.0.1.3;
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

var alias=;
var now=1195552193; var tz=0;

var ntp_enable=1; var ntp_svr=time.nist.gov;

the cgi to set device param or perform operatering. This kind cgi will return text information include operatering result, such as it will returen ok if success param has mistake Besides, if you dont want to the cgi only return ok text return exact error information if faild, such as :error: illegal param indicate that cgis

and

when succeed but a file. In this case, you can add one param into cgi param url:
next_url. The parameter that corresponds to the operation is successful jump

to the next file, note that must be a relative path.

Check_user.cgi
Description obtain current users verify result Permission visitor Grammar /check_user.cgi[?user=&pwd=] Return

usercurrent user pwdcurrent password pricurrent permission 1visitor 2operator 3administrator

snapshot.cgi
Description obtain current snapshot Permission visitor Grammar /snapshot.cgi[?user=&pwd=&next_url=] param next_url snapshot filename

Description
z

if not add extra next_url param return snapshots filename: device id(device aliasname)_current time.jpg otherwise, its filename will be one that next_url specify.

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

Videostream.cgi
Grammar/videostream.cgi[?user=&pwd=&resolution=&rate=] Param
resolution image resolution 8 320*240 32 640*480 rate image data translate speed value rang 0-23

Description ipcamera use server push mode to send client-end the jpeg video stream. Permission visitor

0 1 3 6 11 12 13 14 15 17 19 21 23

full speed 20 fps 15 fps 10 fps 5 fps 4 fps 3 fps 2 fps 1 fps 1 fp/2s 1 fp/3s 1 fp/4s 1 fp/5s

videostream.asf
Description ipcamera send asf currently only support vlc player and mplayer Permission visitor Grammar /videostream.asf[?user=&pwd=&resolution=&rate=] Param

resolution image resolution 8 320*240 32 640*480 rate image data translate speed value rang 0-23

0 1 3 6 11 12 13 14 15 17 19

full speed 20 fps 15 fps 10 fps 5 fps 4 fps 3 fps 2 fps 1 fps 1 fp/2s 1 fp/3s

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

21 23

1 fp/4s 1 fp/5s

get_status.cgi
Description obtain device status Permission N/A Grammar /get_status.cgi Return id device id sys_ver firmware version app_ver webpage gui version alias aliasname now the lapse second from 1970-1-1 0:0:0 to device current time. Tz device current time zoon setting and the number of seconds deviation of GMT

alarm_status device current alarm status 0 no alarm 1 motion detection alarm 2 input alarm 3 voice detection alarm ddns_status current ddns status of device

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 28 29 30 31

No Action Its connecting Can not connect serve Dyndns succeed Dyndns failed system error Dyndns failed password

incorrect

username

or

Dyndns failed need credited user DynDns failed: illegal host format DynDns failed: the host doesnt exist DynDns failed: the host doesnt belong to you DynDns failed: too many or too few host DynDns failed: the host is blocked as abusing DynDns failed: serve error DynDns failed: bad reply from serve Oray failed: bad reply from serve Oray failed: incorrect username or password Oray failed: incorrect host Oray succeed .. Reserve 3322 succeed 3322 failed: system error 3322 failed: incorrect username or password

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

32 33 34 35 36 37 38 39 40 42 100 101 102 103 104 105 106 200 201 202 203 204 205 300 301 302 303 304 305 ..

3322 failed: need credited user 3322 failed: illegal host format 3322 failed: the host doesnt exist 3322 failed: the host doesnt belong to you 3322 failed: too many or too few host 3322 failed: the host is blocked as abusing 3322 failed: serve error 3322 failed: bad reply from serve Reserve

MintDNS failedsystem error MintDNS failed incorrect username password MintDNS failedneed credited user MintDNS failedthe host doesnt exist MintDNS failedserve error
MintDNS failed unknow error 9299 succeed 9299 failed unknow error

MintDNS succeed

or

9299 failedsecond level host expired 9299 failedsecond level host not activated 9299 failed second level host information errorincorrect username or password 9299 failedfirst level host not exist EasyNet failedaccount not exist EasyNet failedaccount expired EasyNet failedaccount prohibited EasyNet failedparam error EasyNet failedunknow error

EasyNet succeed

EasyNet failed no permission

306 ddns_host ddns Host name

oray_typeoray service type0standard1professional wifi_statuswifi status0wired connected1 wifi connected upnp_statuscurrent device upnp operator status
0 1 2 3 4 5 No Action Succeed Device system error Error in network communication Error in chat with Upnp device Rejected by UpnP device conflict

maybe

port

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

msn_status msn satus 0 1 -1 -2 -3 -4 No action Succeed Inner system error Can not connect serve Error in chat with serve TLS chat failed

get_camera_params.cgi
obtain camera param setting Permission visitor Grammar /get_camera_params.cgi[?user=&pwd=] Return resolutionresolution8qvga32vga brightnessbrightness0~255 contrast contrast0~6 modemode050hz160hz 2outdoor flip 0initial1vertical rotate2horizonal rotate 3vertical + horizontal rotate
Description

decoder_control.cgi
Grammar/decoder_control.cgi?command=[&onestep=&degree=&user=&pwd=&next_url=] param
Description decoder control Permission operator

onestep=1 indicate the PTZ control is one step then stop it is only for camera with ptz originally and it is only for up ,down,left and right.
Degree onestep device operator degree Command decoder control command

Value 0 1 2 3 4 5 6 7

485port extra pelco-d decoder. up stop up down stop down left stop left right stop right

connection Internal motor up stop up down stop down left stop left right stop right

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 60 61 90 91 92 93 94 95 255

Small aperture Stop small aperture Large aperture Stop large aperture Focus close Stop focus close Focus far Stop focus far Zoom close Stop zoom close Zoom far Stop zoom far Auto patrol Stop auto patro Close switch 1 Disconnect switch1 Close switch 2 Disconnect switch 2 Close switch 3 Disconnect switch 3 Close switch 4 Disconnect switch 4 Set preset1 Go to preset1 Set preset 16 Go to preset 16 Set preset 32 Go to prese32 Io output high Io output low Upper left Upper right Down left Down right Io output high Io output low Motor test mode center Up & down patrol Stop up patrol Stop Left patrol Set preset 1 Go to preset 1 Set preset 16 Go to preset 16 & down

Left & right patrol & right

set_extra_io.cgi
Description conntral the extra usage of pca8574 chip extension 8 io Permission Operator
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

valueio level valuebit0-bit7io0-io7 high and low level value1high0low returnsucceed return ok Note
Grammar /set_extra_io.cgi?value=[&user=&pwd=&next_url=] Param The current zoom lens the existing reuse the io4-io7

Camera_control.cgi
Grammar/camera_control.cgi?param=&value=[&user=&pwd=&next_url=] Param
Description to control camera sensor param Permission Operator
param param type value param value

param

resolution 2qqvga 8qvga 32vga 1brightness 0~255 2contrast 0~6 3mode 050hz 160hz 2outdoor 5patrol 0initial 1vertical patrol 2horizontal patrol 3vertical patrol + horizontal patrol

value

reboot.cgi
Description reboot device Permission administrator Grammar /reboot.cgi[?user=&pwd=&next_url=]

restore_factory.cgi
Description restore factory setting Permission administrator
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

Grammar /restore_factory.cgi[?user=&pwd=&next_url=]

get_params.cgi
Description Obtain device setting param Permission administrator Grammar /get_params.cgi[?user=&pwd=] Return

id

Device id Firmware version Webpage interfact version alias the lapse second from 1970-1-1 0:0:0 to device current time. device current time zoon setting and the number of seconds deviation of GMT the number of seconds between Daylight Saving Time and standard time 0

sys_ver app_ver alias now tz daylight_saving_time ntp_enable ntp_svr user1_name user1_pwd user1_pri user8_name user8_pwd user8_pri dev2_alias dev2_host dev2_port dev2_user dev2_pwd dev4_alias dev4_host dev4_port dev4_user dev4_pwd ip mask gateway

prohibit

ntp timing

1permit

Ntp serve user1 username user1 password user1 permission administrator user8username user 8 password user 8 permission The second device alias name The second device address The second device port The second device visitor username The second device visitor password The fouth device alias name The fouth device address The fouth device port The fouth device visitor username The fouth device visitor password ip address Subnet mask Gateway

0 visitor 1 operator 2

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

dns dhcp_vendor port wifi_enable wifi_ssid wifi_channel wifi_mode wifi_encrypt wifi_authtype wifi_keyformat wifi_defkey wifi_key1 wifi_key2 wifi_key3 wifi_key4 wifi_key1_bits wifi_key2_bits wifi_key3_bits wifi_key4_bits

Dns serve Dhcp vendor class id port 0

prohibit

wifi function 1

permit

Wifi ssid reserve reserve 0

encryption prohibit1wep encryption wep Authetication0open1share wep Key Format016 hexadecimal number1ascii
character wep Default TX Key wep key1 wep key 2 wep key 3 wep key 4

wifi_wpa_psk wifi_country

128 bits wep key 2 length064 bits1128 bits wep key 3 length064 bits1128 bits wep key 4 length064 bits1128 bits
wep key 1 length 0 64 bits 1 wpa psk encryption Area setting 0 North american 1- 11 channel 1 Europe most area of world 1-13 channel 2 10-11 channel 3 10-13 channel 4 14 channel 5 Japan 1-14 channel 6 3-9 channel 7 5-13 channel

pppoe_enable pppoe_user pppoe_pwd upnp_enable ddns_service

0prohibit pppoe1permit
Pppoe dial user Pppoe dial password 0

prohibit upnp port mapping1permit 0prohibit ddns service 1oray.cn 2DynDns.org(dyndns) 3DynDns.org(statdns) 4DynDns.org(custom) 5reserve 6reserve 7reserve 83322(dyndns)

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

3322(statdns) 10reserve 11reserve 12reserve 13MintDNS 149299.org 15easynet platform

9 ddns_user ddns_pwd ddns_host Ddns username Ddns password Ddns host if service=14 like 9299.org it is level one hostname setting if service=15 like easynet platform it is alarm url setting, for example: http://xxxx/api/alarm.aspx

ddns_proxy_svr

if service=13/14 like MintDNS/9299.org it is visit URL setting for example http://www.dynddns.us/nic/update http://www.9299.org/upgengxin.asp if service=15 like easynet platform it is update url setting for example http://xxxx/api/userip.aspx

ddns_proxy_port mail_svr mail_port mail_tls mail_user mail_pwd mail_sender mail_receiver1 mail_receiver2 mail_receiver3 mail_receiver4 mail_inet_ip ftp_svr ftp_port ftp_user ftp_pwd ftp_dir ftp_mode ftp_retain ftp_upload_interval ftp_filename

if service=14 like 9299.org it is mode setting Mail serve address Mail serve port Mail serve visit user Mail serve visit password Mail sender Mail receiver1 Mail receiver 2 Mail receiver 3 Mail receiver 4 camera inet ip chang, if send notice email or not 0 no 1 yes If use tls transport protocol, 0 no 1 TLS 2 STARTLS

ftp serve address ftp serve port ftp visit user ftp serve visit password ftp serve upload folder 0

port mode1pasv mode 0 release connection after every time upload pictures1remain connection when upload pictures upload image interval(second)0prohibit
ftp filename save

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

ftp_numberoffiles ftp_schedule_enable ftp_schedule_sun_0 ftp_schedule_sun_1 ftp_schedule_sun_2

ftp file quantity save If use upload scheduler or not Sunday upload scheduler by15minuts every hour,

by 24hours everyday,
to divide 96 motion

scheduler period Bit0-95 0 no upload in this period 1 upload in this period

ftp_schedule_mon_0 ftp_schedule_mon_1 ftp_schedule_mon_2 ftp_schedule_tue_0 ftp_schedule_tue_1 ftp_schedule_tue_2 ftp_schedule_wed_0 ftp_schedule_wed_1 ftp_schedule_wed_2 ftp_schedule_thu_0 ftp_schedule_thu_1 ftp_schedule_thu_2 ftp_schedule_fri_0 ftp_schedule_fri_1 ftp_schedule_fri_2 ftp_schedule_sat_0 ftp_schedule_sat_1 ftp_schedule_sat_2 alarm_motion_armed alarm_motion_sensitivity alarm_motion_compensation alarm_input_armed alarm_ioin_level alarm_sounddetect_armed alarm_sounddetect_sensitivity alarm_iolinkage alarm_preset alarm_ioout_level alarm_mail alarm_upload_interval alarm_http alarm_http_url alarm_schedule_enable alarm_schedule_sun_0

alarm_motion_armed1armed 0-9high-low Enable alarm motion compensation or not when the light changes suddently0no1yes 0alarm_input_armed1armed alarm_ioin_level0low1high 0alarm_sounddetect_armed1armed alarm_sounddetect_sensitivity0-9high-low 0disable io linkage on alarm1enable 0disable preset linkage on alarmotherenable preset linkage on alarm Io alarm_ioout_level0low1high 0:disable sending mail on alarm1enable alarm_upload_intervalseconds0disable 0diable alarm_http to inform1enable
0 alarm http url Alarm schedule enable or not Sunday alarm plan.24hours/day.

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

alarm_schedule_sun_1 alarm_schedule_sun_2

Divided 24hours to 96 time district,each district for 15 munites. bit0-95 0 alarm unarmed at this bit 1 alarm armed at this bit

alarm_schedule_mon_0 alarm_schedule_mon_1 alarm_schedule_mon_2 alarm_schedule_tue_0 alarm_schedule_tue_1 alarm_schedule_tue_2 alarm_schedule_wed_0 alarm_schedule_wed_1 alarm_schedule_wed_2 alarm_schedule_thu_0 alarm_schedule_thu_1 alarm_schedule_thu_2 alarm_schedule_fri_0 alarm_schedule_fri_1 alarm_schedule_fri_2 alarm_schedule_sat_0 alarm_schedule_sat_1 alarm_schedule_sat_2 decoder_baud msn_user msn_pwd msn_friend1 msn_friend2 msn_friend3 msn_friend4 msn_friend5 msn_friend6 msn_friend7 msn_friend8 msn_friend9 msn_friend10 decoder baud msn user msn password msn friend1 msn friend 2 msn friend 3 msn friend 4 msn friend 5 msn friend 6 msn friend 7 msn friend 8 msn friend 9 msn friend 10

upgrade_firmware.cgi description upgrade firmware permission administrator syntax /upgrade_firmware.cgi[?user=&pwd=&next_url=]

note This cgi must use post method ,send the file in package which need to be upgraded
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

to ip camera.

upgrade_htmls.cgi

description upgrade webpage interface permission administrator syntax /upgrade_htmls.cgi[?user=&pwd=&next_url=]

note This cgi must use post method ,send the file in package which need to be upgraded to ip camera.

set_alias.cgi

description set alias parameter permission administrator syntax

/set_alias.cgi?alias=[&user=&pwd=&next_url=] parameter

alias device alias length <= 20

set_datetime.cgi

description set date&time parameter permission administrator

syntax /set_datetime.cgi?[tz=&daylight_saving_time=&ntp_enable=&ntp_svr=&now=&user=&pwd =&next_url=] parameter

now

The lost seconds during the period from 1970-1-1 0:0:0 to the specified time , e.g. attach the parameter,then the device proofread the time according to this time. Tz setting the seconds deviate from the standard GMT Set the different seconds between daylight saving time and the standard time

tz daylight_saving_time

ntp_enable ntp_svr

0:disable ntp proofread time 1 enable Ntp server length <= 64

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

set_users.cgi

permissionadministrator syntax
description set user parameter

/set_users.cgi?user1=&pwd1=&pri1=&user2=&pwd2=&pri2=&user3=&pwd3=&pri3=&u ser4=&pwd4=&pri4=&user5=&pwd5=&pri5=&user6=&pwd6=&pri6=&user7=&pwd7=& pri7=&user8=&pwd8=&pri8=[&user=&pwd=&next_url=]

parameter

user1 pwd1 pri1 user8 pwd8 pri8

user1name length <= 12

user1permission 0 visitor 1 operator 2

user1password length <= 12 administrator User 8 name User 8 password User 8 permission

set_devices.cgi

description set multi-device parameter permission administrator syntax /set_devices.cgi?dev2_alias=&dev2_host=&dev2_port=&dev2_user=&dev2_pwd=& dev3_alias=&dev3_host=&dev3_port=&dev3_user=&dev3_pwd=&dev4_alias=&dev4_ host=&dev4_port=&dev4_user=&dev4_pwd=[&user=&pwd=&next_url=] parameter

dev2_alias dev2_host dev2_port dev2_user dev2_pwd dev4_alias dev4_host dev4_port dev4_user dev4_pwd

dev2_hostlength <= 64
dev2_port

dev2_alias length <= 20

dev2_pwdlength <= 12
dev4_alias dev4_host dev4_port dev4_user dev4_pwd

dev2_user length <= 12

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

set_network.cgi

description set basic network parameter permission administrator syntax /set_network.cgi?ip=&mask=&gateway=&dns=&port=[&dhcp_vendor=&user=&pwd=&next _url=] parameter ip

Ip address,e.g.set the ip blank,then obtain the ip dynamicly and ignore mask,gateway,dns parameter below. Subnet mask gateway Dns server port Dhcp vendor class id

mask gateway dns port dhcp_vendor

set_wifi.cgi

description set wifi parameter permission administrator syntax /set_wifi.cgi?enable=&ssid=&encrypt=&defkey=&key1=&key2=&key3=&key4= &authtype=&keyformat=&key1_bits=&key2_bits=&key3_bits=&key4_bits=&channel=& mode=&wpa_psk=[&country=&user=&pwd=&next_url=]

parameter

enable ssid channel mode encrypt authtype keyformat defkey key1 key2 key3 key4

disable wifi function1:enable Join wifi network ssidlength <= 40

0 reserved =5 reserved =0 0 3

disable encrypt1wep encrypt2wpa tkip wpa aes4wpa2 aes5wpa2 tkip+aes wep authtype0open1share Wep keyformat016 hex1ascii character Wep key selection0-3 Wep key1length <= 30
wep key 2 Wep key3 Wep key4

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

key1_bits key2_bits key3_bits key4_bits wpa_psk country

128 bits Wep key2 length064 bits1128 bits Wep key3 length064 bits1128 bits Wep key4 length064 bits1128 bits wpa psk keylength <= 64 Country set 0North America 1- 11 channel 1Europemost parts of the world1-13 channel 210-11 channel 310-13 channel 414 channel 5Japan 1-14 channel 63-9 channel 75-13 channel
Wep key1 length 0 64 bits 1

set_pppoe.cgi

permissionadministrator syntax /set_pppoe.cgi?enable=&user=&pwd=&mail_ip=[&cam_user=&cam_pwd=&next_url=] parameter 0disable pppoe1enable enable Pppoe dial userlength <= 64 user pwd Pppoe dial passwordlength <= 64
description set pppoe settings set_upnp.cgi

description set upnp options

permission administrator syntax

/set_upnp.cgi?enable=[&user=&pwd=&next_url=] parameter

enable

disable upnp forwarding function1enable

set_ddns.cgi

description set ddns settings

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

permission administrator syntax

/set_ddns.cgi?service=&user=&pwd=&host=&proxy_svr=&proxy_port=[&restart_dyndn s=&cam_user=&cam_pwd=&next_url=]

parameter

service

user pwd host

disable ddns 1oray.cn 2DynDns.org(dyndns) 3DynDns.org(statdns) 4DynDns.org(custom) 5reserved 6reserved 7reserved 83322(dyndns) 93322(statdns) 10reserved 11reserved 12reserved 13MintDNS 149299.org 15NetEase communication platform Ddns userlength <= 64 Ddns passwordlength <= 64 Ddns domain namelength <= 64 when service=14as 9299.org it is A level domain settings when service=15 as NetEase communication platform it is setting e.g. alarm url
0 http://xxxx/api/alarm.aspx length <= 64 when service=13/14 as MintDNS/9299.org it is URL setting,e.g. http://www.dynddns.us/nic/update http://www.9299.org/upgengxin.asp when service=15 as NetEase communication platform it is update url setting e.g. http://xxxx/api/userip.aspx

proxy_svr

proxy_port restart_dyndns

1restart dyndns0no

when service=14 as 9299.org

it is mode setting

set_ftp.cgi description set ftp settings

www.foscam.es

Cmaras IP. www.foscam.es

permission administrator syntax /set_ftp.cgi?[svr=&port=&user=&pwd=&mode=&retain=&dir=&upload_interval=&filena me=&numberoffiles=&schedule_enable=&schedule_sun_0=&schedule_sun_1=&sche dule_sun_2=&schedule_mon_0=&schedule_mon_1=&schedule_mon_2=&schedule_t ue_0=&schedule_tue_1=&schedule_tue_2=&schedule_wed_0=&schedule_wed_1=&s chedule_wed_2=&schedule_thu_0=&schedule_thu_1=&schedule_thu_2=&schedule_f ri_0=&schedule_fri_1=&schedule_fri_2=&schedule_sat_0=&schedule_sat_1=&schedu le_sat_2=&cam_user=&cam_pwd=&next_url=]

parameter svr

ftp service address length <= 64

port user pwd dir mode retain upload_interval filename numberoffiles schedule_enable schedule_sun_0 schedule_sun_1 schedule_sun_2 schedule_mon_0 schedule_mon_1 schedule_mon_2 schedule_tue_0 schedule_tue_1 schedule_tue_2 schedule_wed_0 schedule_wed_1 schedule_wed_2 schedule_thu_0 schedule_thu_1 schedule_thu_2 schedule_fri_0 schedule_fri_1 schedule_fri_2 schedule_sat_0 schedule_sat_1

ftpservice pwdlength<= 64 ftp upload cataloguelength <= 64 0port mode1pasv mode 0release connection after uploading pics1retain connection after uploading pics upload_intervalseconds0disable0-65535
ftp service user length <= 64 Filename when upload Numberoffiles when upload Schedule enable or not Sunday upload plan.24hours/day. Divided 24hours to 96 time district,each district for 15 munites. bit0-95 0 not upload at this bit 1 upload at this bit

ftp service port

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

schedule_sat_2

set_mail.cgi

permissionadministrator syntax
parameter svr port tls user pwd sender receiver1 receiver2 receiver3 receiver4 mail_inet_ip

description set mail settings

/set_mail.cgi?svr=&port=&user=&pwd=&sender=&receiver1=&receiver2=&receiver3= &receiver4=&mail_inet_ip=[&tls=&cam_user=&cam_pwd=&next_url=]

mail service address length<= 64 mail service port Use tls transport protocol or not 0 no 1 TLS STARTLS mail service user length <= 64

mail service pwdlength<= 64 senderlength <= 64 receiver 1length <= 64 receiver 2length <= 64 receiver 3length<= 64 receiver 4length <= 64 send mail or not when cameras inet ip changes0no 1yes

set_msn.cgi

description set msn parameter permission administrator syntax

/set_msn.cgi?[user=&pwd=&friend1=&friend2=&friend3=&friend4=&friend5=&friend6= &friend7=&friend8=&friend9=&friend10=&cam_user=&cam_pwd=&next_url=]

parameter

user pwd friend1 friend2 friend3 friend4 friend5

www.foscam.es

msn pwdlength <= 64 msn friend 1length <= 64 msn friend 2length <= 64 msn friend 3length <= 64 msn friend 4length <= 64 msn friend 5length <= 64
msn user length <= 64

Cmaras IP. www.foscam.es

friend6 friend7 friend8 friend9 friend10

msn friend 7length <= 64 msn friend 8length <= 64 msn friend 9length <= 64 msn friend 10length <= 64
msn friend 6 length <= 64

set_alarm.cgi

permissionadministrator syntax

description set alarm settings

/set_alarm.cgi?[motion_armed=&motion_sensitivity=&motion_compensation&input_ar med=&sounddetect_enabled=&sounddetect_sensitivity=&iolinkage=&mail=&upload_in terval=&schedule_enable=&schedule_sun_0=&schedule_sun_1=&schedule_sun_2=& schedule_mon_0=&schedule_mon_1=&schedule_mon_2=&schedule_tue_0=&schedu le_tue_1=&schedule_tue_2=&schedule_wed_0=&schedule_wed_1=&schedule_wed_ 2=&schedule_thu_0=&schedule_thu_1=&schedule_thu_2=&schedule_fri_0=&schedul e_fri_1=&schedule_fri_2=&schedule_sat_0=&schedule_sat_1=&schedule_sat_2=&ioi n_level=&ioout_level=&http=&http_url=&preset=&user=&pwd=&next_url=]

parameter

motion_armed motion_sensitivity motion_compensation input_armed ioin_level sounddetect_armed sounddetect_sensitivity iolinkage preset ioout_level mail upload_interval http http_url schedule_enable schedule_sun_0 schedule_sun_1 schedule_sun_2

0-9high-low

0 motion detection unarmed 1

armed

Enable alarm motion compensation or not when the light changes suddently 0 no 1 yes

0input_unarmed1armed io ioin_level0low1high 0sounddetect_unarmed1armed sounddetect_sensitivity0-9high-low 0disable io linkage on alarm1enable 0disable preset linkage on alarmotherenable preset linkage on alarm ioioout_level0low1high 0disable sending mail on alarm 1:enabl alarm_upload_intervalseconds-65535
0 Disable notifying with http visit on alarm 1 enable http url when visit on alarm schedule_enable or not Sunday arm plan.24hours/day. Divided 24hours to 96 time district,each district for 15 munites. bit0-95 0 not upload at this bit 1 upload at this bit

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

schedule_mon_0 schedule_mon_1 schedule_mon_2 schedule_tue_0 schedule_tue_1 schedule_tue_2 schedule_wed_0 schedule_wed_1 schedule_wed_2 schedule_thu_0 schedule_thu_1 schedule_thu_2 schedule_fri_0 schedule_fri_1 schedule_fri_2 schedule_sat_0 schedule_sat_1 schedule_sat_2

comm_write.cgi

description sending data through camera serial port,only support some models
permission operator syntax /comm_write.cgi?port=&baud=&bytes=&data=[&user=&pwd=&next_url=]

parameter

portserial port number0-3 baudport bau 9B1200 11B2400 12B4800 13B9600 14B19200 15B38400; 4097B57600 4098B115200 bytesbytes when send data < 256 datadata need to send,use url code

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

set_forbidden.cgi

permissionadministrator
syntax

description set the forbidden for checking video/audio

/set_forbidden.cgi?schedule_enable=&schedule_sun_0=&schedule_sun_1=&schedul

e_sun_2=&schedule_mon_0=&schedule_mon_1=&schedule_mon_2=&schedule_tue_ 0=&schedule_tue_1=&schedule_tue_2=&schedule_wed_0=&schedule_wed_1=&sche dule_wed_2=&schedule_thu_0=&schedule_thu_1=&schedule_thu_2=&schedule_fri_0 =&schedule_fri_1=&schedule_fri_2=&schedule_sat_0=&schedule_sat_1=&schedule_ sat_2=[&user=&pwd=&next_url=]

parameter

Plan to forbidding to check video/audio Sunday plan.24hours/day. Divided 24hours to 96 time district,each district for 15 munites. Bit0-95: 0: not forbid,1: forbid

schedule_enable schedule_sun_0 schedule_sun_1 schedule_sun_2 schedule_mon_0 schedule_mon_1 schedule_mon_2 schedule_tue_0 schedule_tue_1 schedule_tue_2 schedule_wed_0 schedule_wed_1 schedule_wed_2 schedule_thu_0 schedule_thu_1 schedule_thu_2 schedule_fri_0 schedule_fri_1 schedule_fri_2 schedule_sat_0 schedule_sat_1 schedule_sat_2

get_forbidden.cgi

description get the forbidden for checking video/audio

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

permission administrator syntax /get_forbidden.cgi[?user=&pwd=] return see set_forbidden.cgi

set_misc.cgi

permissionadministrator syntax

description set misc parameters of camera

/set_misc.cgi?[led_mode=&ptz_center_onstart=&ptz_auto_patrol_interval=&ptz_auto_ patrol_type=&ptz_patrol_h_rounds=&ptz_patrol_v_rounds=&ptz_disable_preset=&ptz_pre set_onstart&user=&pwd=&next_url=]

parameter

0mode11mode22shut off the led ptz_center_onstart=1ptz_center_onstart ptz_auto_patrol_intervalptz_auto_patrol_interva=0no auto rotating

led_mode
ptz_auto_patrol_type

0no rotate1horizontal2vertical3horizontal + vertical

ptz_patrol_h_rounds ptz_patrol_h_rounds 0 infinite

ptz_patrol_v_rounds0infinite ptz_patrol_rate ptz_patrol_rate0-1000the fastest ptz_patrol_up_rate ptz_patrol_up_rate0-1000the slowest ptz_patrol_down_rate ptz_patrol_down_rate0-1000the slowest ptz_patrol_left_rate ptz_patrol_left_rate0-1000the slowest
ptz_patrol_v_rounds

ptz_preset_onstartptz_preset_onstart0disable
get_misc.cgi

ptz_patrol_right_rate ptz_patrol_right_rate 0-100 0 the slowest ptz_disable_preset ptz_disable_preset 0 no 1 yes take effect after reboot

permissionadministrator syntax/get_misc.cgi[?user=&pwd=] returnsee get_misc.cgi

description obtain misc parameters of camera

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

set_decoder.cgi

permissionadministrator syntax
parameter
baud

description set the parameter for decoder

/set_decoder.cgi?baud=[&user=&pwd=&next_url=]

9B1200 11B2400 12B4800 13B9600 14B19200 15B38400;

4097 B57600 4098 B115200

wifi_scan.cgi

description

permission administrator syntax [?user=&pwd=&next_url=]

to order the camera to scan wifi

/wifi_scan.cgi

parameter no

get_wifi_scan_result.cgi

permissionadministrator syntax/get_wifi_scan_result.cgi[?user=&pwd=] return

description obtain result of camera scan wifi var ap_bssid=new Array(); var ap_ssid=new Array(); var ap_mode=new Array(); var ap_security=new Array(); ap_bssid[0]='0015ebbe2153'; ap_ssid[0]='ZXDSL531BII-BE2153'; ap_mode[0]=0;
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

ap_security[0]=0; ap_bssid[1]='00223f176d70'; ap_ssid[1]='nony'; ap_mode[1]=0; ap_security[1]=2; ap_bssid[2]='001d0f3fef40'; ap_ssid[2]='Calvin&Cici'; ap_mode[2]=0; ap_security[2]=1; ap_bssid[3]='0022b0f5ce72'; ap_ssid[3]='CX'; ap_mode[3]=0; ap_security[3]=1; ap_bssid[4]='001c1042b6b7'; ap_ssid[4]='ipcamera'; ap_mode[4]=0; ap_security[4]=2;

var ap_number=5; among

ap_number scan ap number ap_bssid

scan ap bssid ap_ssidscan ap ssid ap_modescan ap mode0infra1adhocnot support ap_securityscan ap security mode 0no 1WEP 2WPAPSK(TKIP) 3WPAPSK(AES) 4WPA2PSK(AES) 5WPA2PSK(TKIP) 6security mode do not support
get_log.cgi

description obtain log of the camera

permission administrator syntax /get_log.cgi[?user=&pwd=]

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

return

log infoe.g.
var log_text='Mon, 2009-08-03 19:53:04 ipcamera 192.168.0.16 192.168.0.16 access\n'; admin

access\nMon, 2009-08-03 20:13:03

Among which log text variable for the log info,use \n to separate every log info.

test_mail.cgi

test mail function permissionadministrator syntax

description /test_mail.cgi[?user=&pwd=] return

result the result of test

0succeed -1can not connect to the server -2network error -3server error -4 incorrect user -5incorrect pwd -6rejected by the sender -7rejected by the receiver -8the text rejected -9authentication does not accept -10internal error -11the device does not support TLS/STARTTLS protocol -12invalid parameter -13the server does not support TLS/STARTTLS protocol

test_ftp.cgi

description ftp function test

permission administrator syntax /test_ftp.cgi[?user=&pwd=]

return

result the result of test

0succeed -1can not connect to the server

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

-2 network error -3 server error -4 incorrect user -5 incorrect pwd -6 incorrect catalogue -7 pasv mode error -8 port mode error -9 stor command error

backup_params.cgi

description back up the current parameter settings

permission administrator syntax /backup_params.cgi[?user=&pwd=]

return

params.bin file

restore_params.cgi

restore the previous backup parameter settings permissionadministrator syntax

description /restore_params.cgi[?user=&pwd=&next_url=] note The cgi must use the post method,package the previous backup parameter set file and send it to the ip camera.

set_factory_params.cgi

description set factory parameter

permission administrator syntax /set_factory_params.cgi[?user=&pwd=&next_url=]

note The cgi must use the post method,package the factory parameter set file and send it to the ip camera. Keep the file format and CAMERA_PARAMS format the same.

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

set_mac.cgi

permissionadministrator syntax
parameter

description set the cameras mac address

/set_mac.cgi?mac=[&user=&pwd=&next_url=]

macmac addresse.g. mac=0012a0746f01

set_factory_ddns.cgi

permissionadministrator syntax
parameter

description set device ddns setting,while set it as factory default value

/set_factory_ddns.cgi?[service=&user=&pwd=&host=&proxy_svr=&proxy_port=&cam_ user=&cam_pwd=&next_url=]

service

user pwd host

disable ddns service 1oray.cn 2DynDns.org(dyndns) 3DynDns.org(statdns) 4DynDns.org(custom) 5reserved 6reserved 7reserved 83322(dyndns) 93322(statdns) 10reserved 11reserved 12reserved 13MintDNS 149299.org Ddns userlength <= 64 Ddns pwdlength <= 64 Ddns hostlength <= 64 when service=14as 9299.org,it is A level domain
0 settings length <= 64 when service=13/14 as MintDNS/9299.org it is visit URL setting e.g.

proxy_svr

www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)

Cmaras IP. www.foscam.es

http://www.dynddns.us/nic/update proxy_port restart_dyndns

1restart dyndns0no

http://www.9299.org/upgengxin.asp

when service=14 as 9299.org it is mode setting

get_factory_ddns.cgi

description get device ddns factory parameter setting /get_factory_ddns.cgi[?user=&pwd=] return factory_ddns_service 0

permissionadministrator syntax

disable ddns service 1oray.cn 2DynDns.org(dyndns) 3DynDns.org(statdns) 4DynDns.org(custom) 5reserved 6reserved 7reserved 83322(dyndns) 93322(statdns) 10reserved 11reserved 12reserved 13MintDNS 149299.org
Ddns user Ddns pwd Ddns host when service=14 as 9299.org,it is A level domain settings

factory_ddns_user factory_ddns_pwd factory_ddns_host

factory_ddns_proxy_svr

when service=13/14 as MintDNS/9299.org it is visit URL setting,e.g. http://www.dynddns.us/nic/update http://www.9299.org/upgengxin.asp

factory_ddns_proxy_port

when service=14 as 9299.org it is mode setting

restore_factory_ddns.cgi description restore device ddns factory default value permission administrator
syntax /restore_factory_ddns.cgi?[user=&pwd=&next_url=]
www.foscam.es Autor: www.foscam.com (Shenzhen Foscam Technology)