B series CGI protocol.docx

1、B series CGI protocolIP Camera CGI Application Guide Indexip camera cgi Introduction 3check_user.cgi 4snapshot.cgi 4videostream.cgi 5videostream.asf 5get_status.cgi 5get_camera_params.cgi 7decoder_control.cgi 7camera_control.cgi 8reboot.cgi 8restore_factory.cgi 8get_params.cgi 9upgrade_firmware.cgi

2、11upgrade_htmls.cgi 11set_alias.cgi 12set_datetime.cgi 12set_users.cgi 12set_network.cgi 13set_wifi.cgi 13set_pppoe.cgi 14set_upnp.cgi 14set_ddns.cgi 14set_ftp.cgi 15set_mail.cgi 15set_alarm.cgi 16set_forbidden.cgi 17get_forbidden.cgi 18set_misc.cgi 18get_misc.cgi 19wifi_scan.cgi 19get_wifi_scan_res

3、ult.cgi 19get_log.cgi 20test_mail.cgi 21test_ftp.cgi 21backup_params.cgi 22restore_params.cgi 22set_mac.cgi 22ip camera cgi IntroductionThe CGI listed here is an ip camera interface based on http protocol. The client application (it could be the web browser page or other applications) can be program

4、med by this CGI. Cgi security certificate：All the CGI listed below need security certificate when it is visited.Besides, different CGI interface requires different authority, there are 3 classes: guest, operator, and administrator. And the authority is controlled by the user set on the device.The sp

5、ecific safety certification mechanism supports 2 ways: http protocol basic one and add the username and password into the CGI parameter. The method to visit CGI: among all the http methods, the CGI only supports get and post. And upgrade_firmware.cgi and upgrade_htmls.cgi only support post, and othe

6、r CGI just supports get method.Get example:Post example Cgi return：according to the different return information, the CGI listed could be divided into below 2 category： Get the status and parameter, including get_status.cgi and get_params.cgi. Their return includes the text of device status or param

7、eter, the specific format is similar to variable definitions of javascript, every status and parameter are defined as a Variable and return, for example: var id=003456789A0A; var sys_ver=0.0.1.2; var app_ver=0.0.1.3; var alias=”; var now=1195552193; var tz=0; var ntp_enable=1; var ntp_svr=time.nist.

8、gov; Set device parameter or operate it: The CGI will return the text including operation result, for example if succeeded, and then return “ok”, if failed, and then return the error information, for example: “error: illegal param”. If you dont need only the simple “ok” text, you could add a paramet

9、er into the CGI parameter string: next_url. The operation is succeeded and then jump to next document. Note it must be the relative path. check_user.cgiDescription：get the current user check resultAuthority：guestSyntax：/check_user.cgi?user=&pwd=Return： user：present user pwd：present password pri：pres

10、ent authority 1：guest 2：operator 3：adminstratorsnapshot.cgiDescription：get the real time pictureAuthority：guestSyntax：/snapshot.cgi?user=&pwd=&next_url=Parameter：next_url：Picture document nameInstruction：1 If there is no next_url parameter，return picture document name is: device id(device alias)_pre

11、sent time.jpg，otherwise the document name is: next_url defined document name.videostream.cgiDescription：ipcamera sends the jpeg video stream by server push modeAuthority：guestSyntax：/videostream.cgi?user=&pwd=&resolution=Parameter： resolution：（8：320*240，32：640*480）videostream.asfDescription：ipcamera

12、 send asf video stream data，only support vlc player and mplayerAuthority：guestSyntax：/videostream.asf?user=&pwd=&resolution=Parameter： resolution：（8：320*240，32：640*480）get_status.cgiDescription：get statusAuthority：N/ASyntax：/get_status.cgiReturn： id：device id sys_ver：firmware version app_ver：web pag

13、e version alias：now：the seconds it goes from 1970-1-1 0:0:0tz：current time area setting and the different second from standard GMT alarm_status：alarm status，0：no alarm；1：Motion detection alarm；2：input alarmddns_status：DDNS status 0Non operation1Connecting2Server Connection error3Dyndns succeeded4Dyn

14、dns failed：system error5Dyndns failed：wrong username or password6Dyndns failed：untrusted user7DynDns failed: wrong Domain Name Form registering sites8DynDns failed: Domain Name doesnt exist9DynDns failed: Domain name doesnt belong to you10DynDns failed: too many or too few domain name request11DynDn

15、s failed: domain name is prevented by abuse12DynDns failed: server error13DynDns failed: No correct response from the server14Oray failed: No correct response from the server15Oray failed: wrong username or password16Oray failed: wrong domain name17Oray succeeded18 . 28Reserve293322 succeeded303322

16、failed: system error 313322 failed: wrong username or password323322 failed: untrusted user333322 failed: wrong Domain Name Form registering sites343322 failed: Domain Name doesnt exist353322 failed: Domain name doesnt belong to you363322 failed: too many or too few domain name request373322 failed:

17、 domain name is prevented by abuse383322 failed: server error 393322 failed: No correct response from the server ddns_host：ddns host name oray_type：Oray Service Type，0：standard；1: dedicated upnp_status： The current UPNP operation status of the device 00 operation1succeeded2Device system error3Networ

18、k communication error4the dialog with UpnP error5UpnP refused，port conflictget_camera_params.cgiDescription：settings for getting the device parameterAuthority：guestsyntax：/get_camera_params.cgi?user=&pwd=Return： resolution：8：qvga；32：vga brightness：0255 contrast：06 mode：0：50hz；1：60hz；2：outdoor flip：

19、0： original；1：flip vertical；2：Mirror Horizontally；3：flip vertical + mirror horizontally；decoder_control.cgiDescription：decoder controlAuthority：operatorsyntax：/decoder_control.cgi?command=&onestep=&user=&pwd=&next_url=parameter： onestep=1command：decoder control commandvaluePTZ0up1Stop up2down3Stop d

20、own4left5Stop left6right7Stop right25Center26Up down cruise27Up down cruise stop28Left right cruise29Left right cruise stop90Left up91Right up92Left down93Right down94Io Open (Alarm out interface)95Io Close(Alarm out interface)camera_control.cgiDescription：image sensor parameter controlAuthority：ope

21、ratorSyntax：/camera_control.cgi?param=&value=&user=&pwd=&next_url=Parameter： param：parameter typevalue： paramvalue0：resolution2：qqvga8：qvga32：vga1：brightness 02552：contrast 063：mode0：50hz1：60hz2：outdoor5：rotation0：original1：flip vertical2：horizontal mirror image3：flip vertical + horizontal mirror im

22、agereboot.cgiDescription：rebootAuthority：adminstratorSyntax：/reboot.cgi?user=&pwd=&next_url=restore_factory.cgiDescription：restore factory default Authority：adminstratorSyntax：/restore_factory.cgi?user=&pwd=&next_url=get_params.cgiDescription：get device parameterAuthority：adminstratorSyntax：/get_par

23、ams.cgi?user=&pwd=Return： IdDevice idsys_verFirmware versionapp_verWeb page versionAliasaliasNowthe seconds it goes from 1970-1-1 0:0:0Tzthe different seconds between the time area and standard GMTntp_enable0：disable ntp；1：enablentp_svrNtp serveruser1_nameUser 1 nameuser1_pwdUser 1 passworduser1_pri

24、User 1 Priority，0：guest；1：operator；2：adminstratoruser8_nameUser 8 nameuser8_pwdUser 8 password user8_priUser 8 PriorityIpIp addressMaskmaskGatewaygatewayDnsDns serverportPort wifi_enable0：disable wifi；1：enablewifi_ssidAdd wifi ssidwifi_channelReserver wifi_modeReserverwifi_encrypt0：disable encrypt；1

25、：wep encryptwifi_authtypewep verification mode，0：open；1：sharewifi_keyformatWep key format，0：hexadecimal numbers；1：ascii characterwifi_defkeyWep key selectionwifi_key1Wep key 1wifi_key2Wep key 2wifi_key3Wep key 3wifi_key4Wep key 4wifi_key1_bitsWep key 1 LEN，0：64 bits；1：128 bitswifi_key2_bitsWep key 2

26、 LEN，0：64 bits；1：128 bitswifi_key3_bitsWep key 3 LEN，0：64 bits；1：128 bitswifi_key4_bitsWep key 4 LEN，0：64 bits；1：128 bitswifi_wpa_pskwpa psk keypppoe_enable0：disable pppoe；1：enablepppoe_userPppoe userpppoe_pwdPppoe passwordupnp_enable0：disable upnp；1：enableddns_service0：disable ddns1：Oray2：DynDns.or

27、g(dyndns)3：DynDns.org(statdns)4：DynDns.org(custom)5：Reserve6：Reserve7：Reserve8：3322(dyndns)9：3322(statdns)ddns_userDdns user ddns_pwdDdns passwordddns_hostDdns hostddns_proxy_svrProxy Server （only for China Mainland dyndns users）ddns_proxy_portProxy Server portmail_svrMail server mail_portMail serve

28、r portmail_userMail server usermail_pwdMail server passwordmail_senderMail sendermail_receiver1Mail receiver 1mail_receiver2Mail receiver 2mail_receiver3Mail receiver 3mail_receiver4Mail receiver 4mail_inet_ipEmail inform when ip address has been changed，0：No；1：Yesftp_svrftp server addressftp_portftp server port ftp_userFtp server userftp_pwdftp server passwordftp_dirftp server storage directoryftp_mode0：port mode；1：pasv modeftp_upload_intervalUpload picture interval（second），0：disablealarm_motion_armed0：disarming；1：armedalar