X-Git-Url: https://git.defcon.no/?a=blobdiff_plain;f=doc%2Fapi-nodes.txt;h=9d0e347bf43ca577530cc9a1f778ecf5f763761b;hb=1482cea4e589347ee79cc563f291661ef7a4931b;hp=a288bbda9639c1f5fa78943b8cf5377769d9e941;hpb=5e06b6865a488899dc997fbd3ee2d22e9c5569f4;p=hermes diff --git a/doc/api-nodes.txt b/doc/api-nodes.txt index a288bbd..9d0e347 100644 --- a/doc/api-nodes.txt +++ b/doc/api-nodes.txt @@ -80,8 +80,13 @@ user/change_email?user=foo@bar.bz&email=user@example.com user/remove?username=foo&domain=bar user/remove?user=foo@bar.bz Removes user account from Kamailio, if present, and removes user from - provisioning. Will fail if user has associated hardphones, remove - phones before removing user. + provisioning. + + Will fail if user has associated hardphones, remove phones before + removing user. + + TODO: Should fail if user has associated aliases. Remove aliases before + removing user. Returns 'ok' on success. @@ -94,8 +99,10 @@ user/available?user=foo@bar.bz Returns 'failed' with 'cause' = 'exists' if the address is in use. user/gen_pw - Test-node, generates a random password on the same form as that used by - user/add_local. May be used with the to-be-implemented change_pw node. + Generates a random password on the same form as that used by + user/add_local. + + Return is always a password in plain text, with no formatting. phone/get?mac=f00ba2ba5c00 phone/get?user=foo@bar.bz @@ -225,9 +232,21 @@ alias/remove?alias=foo@bar.bz Returns 'invalid' with 'cause' = 'address' if the given alias is not a valid SIP adress. +BUGS: +--------------------- + +api/alias/list?destination=foo@bar.bz&e164=true + should return an empty array, returns false + TODO list: --------------------- +Add a node to test a destination (pre-flight testing of user/add and alias/add) + +Read list of kamailio domains (domains/list ?) RW? +Default server-settings for domains (domains/server ? ) (registrar, proxy, ports...) RW. +Permissions! (user/permissions?user=...) + authentication-mechanism :) Change all GET to POST