Differences

This shows you the differences between two versions of the page.

--- api [2023/05/08 17:36]
nightfly
+++ api [2025/08/14 16:10] (current)
nightfly
@@ Line 30: / Line 30: @@
 |            | delete 		| cameraid | deletes specified camera |
 |            | isregistered 		| ip    | checks is some camera is registered by IP on NVR or not? |
+|            | isipportfree 		| ip+port   | checks is some camera IP+PORT free on NVR or not? |
 | users      | getall	|      | returns array of all available users data |
 |            | create 		| login + password     | creates new limited user |
@@ Line 48: / Line 49: @@
 |            | getscreenshotsall 		|      | returns array of all available channel screenshots |
 |            | getscreenshot 		| channelid     | returns specified channel screenshot path |
-|            | getlivestream 		| channelid     | returns live preview stream URL (not implemented yet) |
+|            | getlivestream 		| channelid     | returns live preview stream URL |
 | recorders  | getall 		|      | returns array of all running cameras recorders processes |
 |            | isrunning	| cameraid      | check is recorder running for some camera or not |
@@ Line 210: / Line 211: @@
                     [active] => 1
                     [storageid] => 1
-                    [channel] => kjqidmubme1
+                    [channel] => kiqgdmrbma1
                     [comment] => Here some camera description
+                    [realport] => Here is camera RTSP port that depends template or custom port if set
+                    [maxretention] => Here is maximum retention days limit or zero if no
                 )
@@ Line 231: / Line 234: @@
                     [name] => Default
                 )
+            [OPTS] => Array
+                (
+                    [id] => 1
+                    [cameraid] => 57
+                    [rtspport] => 666
+                    [keepsubalive] => 0
+                    [maxretdays] => 0
+                    [order] =>
+                )
         )
@@ Line 236: / Line 249: @@
     [33] => Array
         (
+        ....
 </code>
+===== User creation =====
+**Request**
+<code>
+http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&users=create
+</code>
+**Request data**
+<code>
+$requestData=array(
+ 'login'=>'view666',
+ 'password'=>'PasswordHere'
+ );
+</code>
+**POST variable 'data'**
+<code>
+{"login":"view666","password":"PasswordHere"}
+</code>
+**Reply**
+<code>
+Array
+(
+    [error] => 0
+    [message] => Success
+)
+</code>
+===== Attempt to create existing user =====
+**Request**
+<code>
+http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&users=create
+</code>
+**Request data**
+<code>
+$requestData=array(
+ 'login'=>'view666',
+ 'password'=>'PasswordHere'
+ );
+</code>
+**POST variable 'data'**
+<code>
+{"login":"view666","password":"PasswordHere"}
+</code>
+**Reply**
+<code>
+Array
+(
+    [error] => 7
+    [message] => User already exists
+)
+</code>
+We hope it is clear how it works. You can also check out a sample implementation of this API at [[https://github.com/nightflyza/Ubilling/blob/master/api/libs/api.wolfrecorder.php|this link]].

WolfRecorder Wiki

User Tools

Site Tools

Differences

Page Tools