backlog add

[hermes] / doc / api-nodes.txt

diff --git a/doc/api-nodes.txt b/doc/api-nodes.txt
index 42150590925c825d644b25e79df5daac69314888..a3cafc99bed7291c1dcd2e79a24b63fe280471a5 100644 (file)
--- a/doc/api-nodes.txt
+++ b/doc/api-nodes.txt
@@ -250,6 +250,27 @@ user/get
        Returns 'failed' with 'cause' = 'nonexistant' if user does not exist..
        Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
 
+user/location
+-------------------
+  Required:
+       user=user@bar.bz *
+    
+  Description:
+       Return registered user agent locations for a given user, with 
+        contact and user agent information.
+       
+  Return:
+       On success, returns the array 'locations', each element contianing:
+               'contact' is the registration contact (the location)
+               'useragent' is the UA string from the client
+               'expires' is the expiration time of the registration, as unix timestamp
+       
+       Returns 'failed' with 'cause' = 'offline' if user is not registered ...
+       Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
+
+  TODO:
+       Add a return code for non-existant subscriber?
+
 user/list
 -------------------
   Optional:
@@ -705,6 +726,11 @@ api/alias/list destination=foo@bar.bz e164=true
 TODO list:
 ---------------------
 
+user/forward To set up permanent forwarding. Call forward is stored as a user
+  preference value in the kamailio database. Evample of diverting calls to
+  'jonl@hig.no' to the number +4761135280':
+insert into usr_preferences (username, domain, attribute, value, last_modified) values ( 'jonl', 'hig.no', 'cfu', '+4761135280', now());
+
 Some TODO's listed above ...
 
 Permissions! (user/permissions?user=...)