JVC 686BU, 686U, VN-V685U manual Ssage, Alarm%20ON

Page 40

/api/param?application.event(1).action=mailto/somebody@somecompany.com/none/Me

ssage

Example of Response

application.event(1).action&202 Accepted(application.event(1).status=restart)

Interpretation Set the alarm action of the specified alarm number. Up to 5 alarm actions can be specified, and therefore the number of alarm(number) can also be set between the range of 1 to 5. Note that alarm numbers are different from the alarm input pin numbers. A separate API (/api/param?application.event(Number).status=off) is used to set the alarm action to off.

The action will be activated by setting the alarm trigger. The API for setting the alarm trigger is /api/param?application.event(Number).trigger.

The changes to settings of alarm action become valid by /api/param?application.event(Number).status=restart.

Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify object01. If none is specified instead of object01, JPEG is not attached to the mail. Number of the character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.

space & / < > # % " { } \ ^ [ ] `

For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available.

Setting Example

/api/param?application.event(1).action=mailto/somebody@somecompany.com/object0

1/Alarm%20ON

The character string "Alarm from VN-V685/686/686B" will be stored in the title field of the mail.

Specify recftp, FTP number and the object for PrePostRecording+FTP. The FTP number is fixed as ftp01 at all times. The object is fixed as object01. Parameters of FTP can be set by other APIs, application.ftp and application.object. Ensure to set the FTP server (/api/param?application.ftp.host, /api/param?application.object.framerate etc.) before setting PrePostRecording+FTP.

Setting Example /api/param?application.event(1).action=ftpto/ftp01/object01

Specify tcpto, IP address, port number and the character string to be sent when sending via TCP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.

space & / < > # % " { } \ ^ [ ] `

For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available.

40

Image 40
Contents API Guide Updates Custom Application Software Development Guide Content Basic Procedures Getting Jpeg from VN-V685/686/686B via HttpPage API Format Structure Parameter DescriptionWhen API is successfully received with boundary=off Response When API is successfully received with boundary=onRestrictions Access restriction Jpeg File Format Sent Out by VN-V685/686/686BGetting MPEG-4 from VN-V685/686/686B via Http Example of VN-V685 API Format Structure Response When API is successfully received MPEG-4 Stream Format Sent Out by VN-V685/686/686B 20070319161455123UTCProcedure Search VN-V685/686/686B in LANUsing API that Requires Basic Authentication User Vn-v686 VN-V685 and VN-V686B Username General CameraSaving Changes of Camera Settings Setting Camera ID in Jpeg from VN-V685/686/686BExample of setting /api/param?camera.id=Camera01 Getting Camera ID stored in Jpeg from VN-V685/686/686BSetting Monitor Type for VN-V685/686/686B Setting Black level for VN-V685/686/686BGetting Monitor Type from VN-V685/686/686B Getting Black level from VN-V685/686/686BSetting Gamma for VN-V685/686/686B Setting Active Gamma Level for VN-V685/686/686BGetting Gamma from VN-V685/686/686B Getting Active Gamma Level from VN-V685/686/686BSetting Enhance Band for VN-V685/686/686B Setting Enhance for VN-V685/686/686BGetting Enhance from VN-V685/686/686B Getting Color Level from VN-V685/686/686BSetting Color Level for VN-V685/686/686B Setting Stabilizer for VN-V685/686/686BGetting Stabilizer from VN-V685/686/686B Getting Stabilizer Level from VN-V685/686/686BSetting Stabilizer Level for VN-V685/686/686B Setting DNR for VN-V685/686/686BGetting DNR from VN-V685/686/686B Getting 3D Noise Reduction from VN-V685/686BSetting 3D Noise Reduction for VN-V685/686B Setting AGC for VN-V685/686/686BGetting AGC from VN-V685/686/686B Getting Limit of Sense Up from VN-V685/686/686BSetting Limit of Sense Up for VN-V685/686/686B Setting ALC priority for VN-V685/686/686BSetting Shutter Speed for VN-V685/686/686B Getting ALC priority from VN-V685/686/686BGetting B&W Mode from VN-V685/686/686B Setting B&W Mode for VN-V685/686/686BCamera.image.truedaynight&202 Acceptedcamera.status=save Format /api/param?camera.image.truedaynight.af=dataSetting Light for focus in B&W mode for VN-V685/686/686B Saving Image Settings for Auto Pan and Auto TraceExample /api/param?camera.image.truedaynight.af=on Camera.image.truedaynight.af&202 Acceptedcamera.status=saveSetting Iris for VN-V685/686/686B Setting Iris Direction for VN-V685/686/686BGetting Iris from VN-V685/686/686B Operating Iris for VN-V685/686/686BSetting White Balance for VN-V685/686/686B Getting White Balance from VN-V685/686/686BGetting R-Gain of White Balance from VN-V685/686/686B Example of response camera.iris.status&200 OKSetting B-Gain of White Balance for VN-V685/686/686B Setting R-Gain of White Balance for VN-V685/686/686BGetting B-Gain of White Balance from VN-V685/686/686B Setting Back Light Compensation for VN-V685/686/686B Getting Back Light Compensation from VN-V685/686/686BSetting Jpeg Frame Size for VN-V685/686/686B Getting Jpeg Rate Control Setting from VN-V685/686/686BSetting Jpeg Rate Control for VN-V685/686/686B Getting Jpeg Frame Size from VN-V685/686/686BGetting Jpeg File Size Setting from VN-V685/686/686B Setting Jpeg File Size Setting for VN-V685/686/686BGetting MPEG-4 Frame Size from VN-V685/686/686B Format /api/param?encode2.framesizeSetting MPEG-4 Frame Size for VN-V685/686/686B Getting MPEG-4 bitrate Setting from VN-V685/686/686BSetting MPEG-4 bitrate Setting for VN-V685/686/686B Getting MPEG-4 Rate Control Setting from VN-V685/686/686BGetting MPEG-4 Frame Rate Setting from VN-V685/686/686B Setting MPEG-4 Frame Rate Setting for VN-V685/686/686BSetting MPEG-4 Priority Setting for VN-V685/686/686B Getting MPEG-4 Priority Setting from VN-V685/686/686BFormat /api/param?application.eventNumber.status Getting Alarm Action from VN-V685/686/686B Setting Alarm Action for VN-V685/686/686B Format /api/param?application.eventNumber.action=DataAlarm%20ON SsageGetting Alarm Filter Setting from VN-V685/686/686B Setting Alarm Filter for VN-V685/686/686B Getting Alarm Filter Time from VN-V685/686/686BSetting Alarm Filter Time for VN-V685/686/686B Api/param?application.event1.filtersunday.status=onSetting Alarm Filter Type for VN-V685/686/686B Getting Alarm Filter Type from VN-V685/686/686BApi/param?application.event1.filtersunday.type=unmask Getting Alarm Trigger from VN-V685/686/686B Setting Alarm Trigger for VN-V685/686/686BFormat /api/param?application.eventNumber.trigger Example of Response application.event1.trigger=v1&200 OKSetting Example /api/param?application.event1.trigger=v1 Setting Example /api/param?application.event6.trigger=i1500Format /api/param?application.eventNumber.trigger=data Api/param?application.event1.trigger=m1Setting Smtp Server Port Number for VN-V685/686/686B Setting Smtp Server Address for VN-V685/686/686BGetting Sender Mail Address Setting from VN-V685/686/686B Setting Sender Mail Address for VN-V685/686/686B Getting POP before Smtp Setting from VN-V685/686/686BSetting POP before Smtp for VN-V685/686/686B Getting POP Server Address Setting from VN-V685/686/686BGetting POP Server User Name Setting from VN-V685/686/686B Setting POP Server Port Number for VN-V685/686/686BSetting POP Server User Name for VN-V685/686/686B Setting POP Server Password for VN-V685/686/686B Getting FTP Server Address Setting from VN-V685/686/686BSetting FTP Server Address for VN-V685/686/686B Getting FTP Server Path Setting from VN-V685/686/686BSetting FTP Server Path for VN-V685/686/686B Getting FTP Server User Name Setting from VN-V685/686/686BSetting FTP Server User Name for VN-V685/686/686B Setting FTP Server Password for VN-V685/686/686BApi/param?application.ftp.password=%00 Setting File Naming of Periodic FTP for VN-V685/686/686BGetting File Naming of Periodic FTP from VN-V685/686/686B Setting User Define Name of File Naming for VN-V685/686/686B Setting Alarm Output Time for VN-V685/686/686B Getting Alarm Output Time Setting from VN-V685/686/686BGetting Alarm Output Status from VN-V685/686/686B Changing Alarm Output of VN-V685/686/686B Getting Auto Return Mode from VN-V685/686/686BSetting Auto Return Mode for VN-V685/686/686B PTZGetting Timeout of Auto Return from VN-V685/686/686B Setting Timeout of Auto Return for VN-V685/686/686BSetting Auto Return Status for VN-V685/686/686B Getting Auto Return Status from VN-V685/686/686BStart/Stop of Auto Tracking for VN-V685/686/686B Api/param?camera.motion.autotracking2.target=s10-s20Getting Restart Time of Auto Tracking from VN-V685/686/686B Setting Restart Time of Auto Tracking for VN-V685/686/686BFormat /api/param?camera.motion.autotracking2.area Page Page Setting Upper Limit of EZoom for VN-V685/686/686B Getting Upper Limit of EZoom from VN-V685/686/686BSetting On/Off of Pan Limit for VN-V685/686/686B Setting Left Side of Pan Limit for VN-V685/686/686BGetting On/Off of Pan Limit from VN-V685/686/686B Getting Left Side of Pan Limit from VN-V685/686/686BSetting Right Side of Pan Limit for VN-V685/686/686B Setting Tilt Limit for VN-V685/686/686BMoving to Left/Right Side of Pan Limit for VN-V685/686/686B Getting Tilt Limit from VN-V685/686/686BGetting Auto Flip Setting from VN-V685/686/686B Setting Auto Flip for VN-V685/686/686BSetting Direction of Pan Operation for VN-V685/686/686B Setting Speed of Pan Operation for VN-V685/686/686BGetting Pan Position from VN-V685/686/686B Moving to Specified Pan Position for VN-V685/686/686BGetting Pan Operation Status from VN-V685/686/686B Getting Tilt Position from VN-V685/686/686BMoving to Specified Tilt Position for VN-V685/686/686B Example of Response camera.motion.pan.speed&200 OKSetting Direction of Tilt Operation for VN-V685/686/686B Setting Speed of Tilt Operation for VN-V685/686/686BTilt Operation for VN-V685/686/686B Getting Tilt Operation Status from VN-V685/686/686BSetting Direction of Zoom Operation for VN-V685/686/686B Setting Speed of Zoom Operation for VN-V685/686/686BMoving to Specified Zoom Position for VN-V685/686/686B Zoom Operation for VN-V685/686/686BGetting Focus Position from VN-V685/686/686B Moving Specified Position to Center for VN-V685/686/686BMoving to Specified Focus Position for VN-V685/686/686B Setting Direction of Focus Operation for VN-V685/686/686B Setting Speed of Focus Operation for VN-V685/686/686BGetting Current Preset Position from VN-V685/686/686B Focus Operation for VN-V685/686/686BInitialize Preset Position for VN-V685/686/686B Moving to Preset Position for VN-V685/686/686BGetting Title of Preset Position from VN-V685/686/686B Setting Title to Preset Position for VN-V685/686/686BSetting Direction of Auto Pan for VN-V685/686/686B Getting Status of Auto Pan from VN-V685/686/686BStart/Stop of Auto Pan for VN-V685/686/686B Getting Direction of Auto Pan from VN-V685/686/686BSetting Speed of Auto Pan for VN-V685/686/686B Getting Speed of Auto Pan from VN-V685/686/686BGetting Status of Auto Trace from VN-V685/686/686B Format /api/param?camera.motion.autotrace.statusStart/Stop of Auto Trace Recording for VN-V685/686/686B Start/Stop of Auto Trace for VN-V685/686/686BApi/param?camera.motion.autotrace.record.status=start Auto Patrol Start/Stop of Auto Patrol for VN-V685/686/686B Getting Status of Auto Patrol from VN-V685/686/686BGetting Duration of Auto Patrol from VN-V685/686/686B Setting Duarion of Auto Patrol for VN-V685/686/686BPrivacy Masking Setting Whole Status of Privacy Masking for VN-V685/686/686B Getting Privacy Masking Brightness from VN-V685/686/686BSetting Privacy Masking Brightness for VN-V685/686/686B Setting Width of Privacy Masking Area for VN-V685/686/686BSetting Height of Privacy Masking Area for VN-V685/686/686B Start/Save Editing of Privacy Masking for VN-V685/686/686BSetting Motion Detect Sensitivity for VN-V685/686/686B Setting Motion Detect to On/Off for VN-V685/686/686BGetting Motion Detect Sensitivity from VN-V685/686/686B Network Basics Enabling Network Setting Changes Setting Motion Detect Mask for VN-V685/686/686BGetting Motion Detect Mask from VN-V685/686/686B Getting Dhcp Setting from VN-V685/686/686B Setting Dhcp for VN-V685/686/686BSetting IP Address for VN-V685/686/686B Getting IP Address from VN-V685/686/686BSetting Subnet Mask for VN-V685/686/686B Getting Default Gateway from VN-V685/686/686BSetting Default Gateway for VN-V685/686/686B Getting Subnet Mask from VN-V685/686/686BSetting Host Name for VN-V685/686/686B Setting DNS Server IP Address for VN-V685/686/686BGetting DNS Server On/Off Status from VN-V685/686/686B Getting DNS Server IP Address from VN-V685/686/686BSetting IPv6 status for VN-V685/686/686B Getting IPv6 status from VN-V685/686/686BGetting Link Local Address of IPv6 from VN-V685/686/686B Getting Global Address of IPv6 from VN-V685/686/686BGetting MAC Address from VN-V685/686/686B Setting TOS Value of Jpeg for VN-V685/686/686BGetting TOS Value of MPEG-4 from VN-V685/686/686B Setting TOS Value of MPEG-4 for VN-V685/686/686B Setting Unicast TTL for VN-V685/686/686BSetting Multicast TTL for VN-V685/686/686B Getting Unicast TTL Value from VN-V685/686/686BSetting MTU Value for VN-V685/686/686B Getting Network Negotiation Setting from VN-V685/686/686BSetting Network Negotiation for VN-V685/686/686B Getting MTU Value VN-V685/686/686BSetting Port Number of Http for VN-V685/686/686B Setting Status of Vsip for VN-V685/686/686BProtocol Getting Port Number of Http from VN-V685/686/686B Getting Status of Vsip from VN-V685/686/686BGetting Mode of Jpeg streaming from VN-V685/686B Setting Port Number of Vsip for VN-V685/686/686BSetting Mode of Jpeg streaming for VN-V685/686B Getting Jpeg Multicast Address from VN-V685/686/686B Setting Jpeg Multicast Address for VN-V685/686/686B Setting Jpeg Multicast Port Number for VN-V685/686/686BSetting Frame Rate of Jpeg Multicast for VN-V685/686/686B Getting Jpeg Multicast Port Number from VN-V685/686/686BSetting MPEG-4 Multicast Address for VN-V685/686/686B Getting MPEG-4 Multicast Address from VN-V685/686/686BSetting MPEG-4 Multicast Port Number for VN-V685/686/686B Getting MPEG-4 Multicast Port Number from VN-V685/686/686BFormat /api/param?network.accesscontrolstreamout.hostNumber Network.accesscontrolstreamout.host1=10.0.0.0/24&200 OKExample /api/param?network.accesscontrolstreamout.host1=%00 TimeSetting NTP Server Address for VN-V685/686/686B Getting Access Interval to NTP Server from VN-V685/686/686BSetting Access Interval to NTP Server for VN-V685/686/686B Getting On/Off of Sntp Client from VN-V685/686/686BGetting Access Interval Unit of NTP from VN-V685/686/686B Setting Access Interval Unit of Sntp for VN-V685/686/686BSetting Time for VN-V685/686/686B Getting Time from VN-V685/686/686BGetting Timezone from VN-V685/686/686B GMT-8Password Setting Password for VN-V685/686/686B Setting Timezone for VN-V685/686/686BFormat /api/param?system.password.data1=data2 Maintenance Initialization Firmware UpdateGetting Status of Auto Cleaning from VN-V685/686/686B Setting Auto Cleaning for VN-V685/686/686BGetting Status Getting Sending Status Setting Time of Auto Cleaning for VN-V685/686/686BFormat /api/param?system.session Getting Settings Getting Model Name Getting LogGetting Firmware Revisions of Streaming Manager 100Getting Alarm Input Status from VN-V685/686/686B Getting Firmware Revisions of PTZ ControllerGetting Firmware Revisions of Image Processor Getting Firmware Revisions of LensGetting Mode of FTP Server from VN-V685/686/686B Setting Mode of FTP Server for VN-V685/686/686B102 Format /api/param?application.ftp.mode=dataList of ActiveX 103Properties of ActiveX 104105 HhmmssMethod of ActiveX Control 106How to use ActiveX Control by Html 107Html Sample 108109 Script110 111 Form Body Html