1 General description on API protocol:
2 =========================================================================
3 All API nodes currently use POST requests for all parameters.
4 All API nodes return JSON data unless explicitly noted ,
5 and all JSON results will contain a 'response' element.
6 The 'response' may be set to:
7 * 'ok' on success. Further contents depend on the node requested.
8 * 'invalid' on invalid requests. A 'cause' element should give a
9 keyword denoting what was invalid about the request...
10 * 'failed' on simple failure. A 'cause' element is supplied, with a
11 failure-keyword (e.g. 'nonexistant', 'inuse', 'dbfail').
12 A final 'detail' is commonly included, with a verbose desctiption.
13 * 'error' on critical failure. Regard this as a soft form of "500 server error"...
15 So, in all Return-specifications it should be assumed that 'response' is set to
19 Authentication mechanism:
20 =========================================================================
21 All API nodes except 'auth/login' and 'auth/logout' require a
22 'token authentication' based on a session identifier (session) and a
23 session authentication key (auth_key) passed as parameters.
25 The 'session' and 'auth_key' values are provided as response to a
26 successful API login through 'auth/login', and must be included as
27 parameters to all subsequent calls to the API.
29 The 'auth_key' has a limited lifetime (configurabel, defaul 5 minutes),
30 significantly shorter than the session lifetime. The 'auth_kye' must
31 be renewed before the key lifetime expires, by issuing a call to
32 'auth/ping'. The ping call will provide a new key that replaces the
33 previous 'auth_key' in subsequent calls to the API.
35 API login may be done using either a username/password combination,
36 or using a registered API key tied to the host originating the requests.
38 See documentation for nodes under 'auth/*' for information about
39 adding, removing and maintaining authentication users and keys.
43 call auth/login with username and password
44 store session and auth_key for further requests
46 perform API calls with session and auth_key set
49 call auth/ping with session and auth_key set
50 update the auth_key used for requests
52 perform API calls with session and auth_key set
55 call auth/logout with session set
57 NOTE: that the API also requires COOKIE-support in the user-agent
58 used to communicate with the API.
60 NOTE: See README for information on configuring API authentication
61 backends, and boostrapping the user/key authorizations.
64 =========================================================================
65 'user'/'alias' parameters marked '*' may alternatively be given as
66 username=foo + domain=bar
67 alias_username=foo + alias_domain=bar
70 =========================================================================
84 Returns 'session' set to the allocated session_name and 'auth_key'
85 set to the generated auth_key. These must be used for further access,
86 and the key must be refreshed through 'auth/ping' at intervals.
87 Returns 'failed' with 'cause' = 'unauthorized' if Login failed
96 // De-authenticate/deauthorize the ongoing session.
97 // I.e. destroy session data, remove session cookies.
100 Returns 'ok' on successful logout
105 session=$session_name
110 // API clients are required to periodically ping the server
111 // The time between pings (interval) is 5 minutes?
112 // A ping call refreshes cookie lifetimes, then
113 // generates and stores a new auth_key
114 // The ping required a valid session...
115 // A successful ping returns a 'response' => 'pong'
116 // along with the new auth_key.
118 NOTE!: Does not give 'response' => 'ok' !
121 Returns 'pong' with 'auth_key' set to the new key to be used
122 with the session_name in further requests.
132 'access' may be one of:
138 Returns 'key', 'host' and 'access'.
139 Returns 'invalid' with 'cause' = 'parameters' on parameter error
140 Returns 'failed' with 'cause' = 'error' on database errors.
141 TODO: Change 'error' to 'dbfail'.
152 Returns 'key' set to the removed key on success.
153 Returns 'invalid' on parameter error
154 Returns 'failed' with 'cause' = 'nonexistant' if key does not exist.
155 Returns 'failed' with 'cause' = 'error' on database errors.
156 TODO: Change 'error' to 'dbfail'.
175 // Add or update a valid back-end user in authorization
176 // if the current authentication has write access.
177 // If the authorization does not exist, add it.
178 // If the user is already authorized, replace access level.
180 'access' may be one of:
186 Returns 'user' and 'access' when user was successfully added.
187 Returns 'invalid' with 'cause' = 'parameters' on parameter error
188 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
189 Returns 'failed' with 'cause' = 'error' on database errors.
198 // If the current authentication has write access:
199 // Remove authorization for the given users.
200 // Delete user from backend if backend is read-write.
203 Returns 'user' when user was successfully removed.
204 Returns 'invalid' with 'cause' = 'parameters' on parameter error
205 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
206 Returns 'failed' with 'cause' = 'error' on database errors.
218 TODO: This is not implemented. Document, write test and implement.
219 Returns 'notimplemented'
220 // Add user to backend if backend is read-write and
221 // the current authentication has write access.
222 // The created user should be added to authorizations
223 // with an access level of "limited_read (1)"
229 TODO: This is not implemented. Document, write test and implement.
230 Returns 'notimplemented'
231 // Update the given user in the backend, if the backend
232 // is read-write, and the current authentication has
241 Return User information, not including hardphone association.
244 On success, 'user' will be set to the user-data set:
246 type,username,password,domain,authid,registrar,
247 r_port,proxy,p_port,dialplan,displayname,linetext
248 for local users (kamailio), as above, plus:
249 email,ha1,ha1b,rpid,permittedcalls
250 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist..
251 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
259 Return an array of users, with 'user' set to SIP-address and
260 'displayname' set to the users Displayname.
262 If the search parameter is included, a globbing search is performed,
263 and only matches are listed.
276 Adds a user account to both Kamailio and provisioning, if the
277 username@domain is nonexistant, and the domain is local (handled by
278 Kamailio). The password for the user is auto-generated.
281 Returns a full user object, the same form as user/get
282 Returns 'failed' with 'cause' = 'exists' if address is taken
283 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
284 Returns 'failed' with 'cause' = 'servfail' if no default servers
285 could be determined for the requested domain. See domain/set_servers.
286 Returns 'failed' with 'cause' = 'dbfail' on database errors..
294 registrar=sip.example.com
297 proxy=sipproxy.example.com
304 Adds a provisioning user for a remote SIP account. This allows locally
305 provisioned hardphones to be associated with non-local SIP accounts.
308 Returns a full user object, the same form as user/get
309 Returns 'failed' with 'cause' = 'domain' if an attempt is made to
310 add_remote for a local domain.
311 Returns 'failed' with 'cause' = 'exists' on any address collisions
312 Returns 'failed' with 'cause' = 'dbfail' on database errors..
320 Removes user account from Kamailio, if present, and removes user from
323 Will fail if user has associated hardphones, remove phones before
326 TODO: Should fail if user has associated aliases. Remove aliases before
330 TODO: Document additional data on 'result' = 'ok'
331 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist..
332 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
333 Returns 'failed' with 'cause' = 'inuse' if phone-associations exists
334 TODO: Returns 'failed' with 'cause' = 'inuse' if aliases exist for the address
344 Changes the password for the given user, returns 'ok' with 'detail' as
345 a descriptive text on success. In the current implementation,
346 provisioning and kamailio passwords are handled separately, so one
347 may succeed and the other fail. As is, this permits password changes
348 of non-local provision users with minimal effort.
351 Returns 'detail' on success.
352 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
353 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
354 Returns 'failed' with 'cause' = 'dbfail' if the database request
355 failed. Note that this may be because the given password was identical
362 email=user@example.com
365 Changes the email address for the given user, returns 'ok' with
366 'user' set to the requested username and 'email' set to the
367 email address. This only applies to kamailio local users.
370 Returns 'user' and 'email' on success.
371 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
372 TODO: Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
373 Returns 'failed' with 'cause' = 'dbfail' if the database request
374 failed. This may be because no update was required ...
386 Updates user with the given data....
387 TODO: Extend this description ;)
390 Returns two arrays on success, 'updated' containing updated params
391 and 'skipped' containing specified parameters that did not require
393 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
394 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
395 Returns 'failed' with 'cause' = 'dbfail' if the database request
396 failed. With database errors, the array 'failed' will contain any
397 parameters that may have caused the dbfail.
404 Tests an address to see if it is available.
407 Returns 'ok' with 'cause' = 'nonexistant' if the address is available.
408 Returns 'failed' with 'cause' = 'exists' if the address is in use.
409 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
415 Generates a random password on the same form as that used by
418 NOTE: This node does not use JSON formatting.
421 Return is always a password in plain text, with no formatting.
430 Returns a list of associated elements. If MAC address is given as
431 parameter, a list of associated user@domain addresses is retruned. If
432 user@domain is given as parameter, a list of associated mac addresses
436 Returns 'list' as an array of phone-user mappings on success,
437 where each element of 'list' consists of either usernames or mac-adresses.
438 Returns 'failed' with 'cause' = 'nonexistant' on no matches.
439 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
447 Returns the list of registered MAC addresses. If the (optional) search
448 parameter is included, the list is the result of a globbing search,
449 a subset matching on the MAC addresses.
452 Returns 'list' as a simple array of registered MAC-adresses on success,
453 the list will be limited to addresses matching the search if provided.
463 Adds a phone-to-user association to Provisioning. The user may be
464 provided as 'username' and 'domain' in separate parameters, or as
465 'user' in sip-address form. The MAC address must be valid, in plain-hex
466 or colon-separated form, and the user must match a valid user
470 Returns 'mac', 'username' and 'domain' on success.
471 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
472 Returns 'failed' with 'cause' = 'invalid' if MAC address is malformed.
473 Returns 'failed' with 'cause' = 'nonexistant' if user does not exist.
474 Returns 'failed' with 'cause' = 'exists' if user+mac is already reg.
475 Returns 'failed' with 'cause' = 'dbfail' on database failure.
484 Deletes a phone-to-user association. Required parameters and formats
485 are identical to the phone/add node.
488 Returns 'mac', 'username' and 'domain' on success.
489 Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed.
490 Returns 'failed' with 'cause' = 'invalid' if MAC address is malformed.
491 Returns 'failed' with 'cause' = 'nonexistant' on no such registration.
502 Gives a list of entries in the phone number pool.
503 With no parameters, the entire (ordered) list of available numbers is
504 returned. With 'search', the result of a pre-post globbing search is
505 returned With 'random', a list of entries is returned unordered (random
506 order) For all nodes, 'limit' may be a numeric limit of desired
510 Returns the list of numbers as the array 'list'.
511 Returns 'failed' with 'cause' = 'empty' if no numbers were listed...
520 The start and end must have identical lead-in, and start must be less
521 than end. Both numbers must be given in E164 format, remember to
522 urlencode the plus (+ -> %2B). The numeric component of both will be
523 extracted, and all numbers in the range will be iteratively added to
524 the pool, including the ending number.
527 TODO: Document additional info provided on 'result' = 'ok'
528 Returns 'failed' with 'cause' = 'rejected' with 'detail' set on failure
536 Adds the given number to the pool, after verifying that the number is
537 in valid E164 format, and that the number does not already exist in the
541 Returns "Added <number>" in 'detail' on success.
542 Returns 'failed' with 'cause' = 'rejected' and 'detail' set to "Not a
543 valid E164 number" if the provided number could not pass E164
545 Returns 'failed' with 'cause' = 'exists' if number is already in the pool.
546 TODO: Returns 'failed' with 'cause' = 'dbfail' on database failure.
547 TODO: Gives 'cause' = 'rejected' with no detail in current code.
555 Removes/pulls a number from the pool.
556 The number must be a valid e164 number, and must be present in the
560 Returns 'number' set to the number that was pulled from the pool.
561 Returns 'failed' with 'cause' = 'rejected' and 'detail' set to "Not a
562 valid E164 number" if the provided number could not pass E164
564 Returns 'failed' with 'cause' = 'nonexistant' if number is not the pool.
565 Returns 'failed' with 'cause' = 'dbfail' on database failure.
573 Tests if the given E164 number is in the pool.
576 Returns 'number' = '<number>' If the number is in the pool
577 Returns response = 'failed' with 'cause' = 'nonexistant' if not.
583 destination=foo@bar.bz
587 With no parameters, this will return all defined aliases (potentially a
588 huge list). With the destination parameter set, only aliases for that
589 destination will be listed, and with the e164 option set to true, only
590 an e164 alias will be returned (if one/it exists). The alias parameter
591 gives the same behaviour, but looks up an alias address instead of the
592 destination. The e164 option is not valid for the alias search
596 Returns 'ok' on success, with an array of 'destination' and 'alias'
598 Returns 'ok' with an empty array if the search gave no results.
599 Returns 'ok' with an empty array if the database search fails.
600 Returns 'failed' with 'cause' = 'invalid' on invalid SIP addresses.
606 destination=bar@qux.zx
609 Add an alias specified by alias_username and alias_domain that
610 points to the destination SIP-adress.
613 On success, 'ok' is returned, with 'alias' and 'destination' set to the
614 resulting alias and destination adresses.
615 Returns 'invalid' with 'cause' = 'destination' or 'alias' if the
616 resulting alias-adress or destination are invalid SIP-adresses.
617 Returns 'failed' with 'cause' = 'nxdomain' if the given alias domain is
618 not a Kamailio domain.
619 Returns 'failed' with 'cause' = 'exists' if the alias is an E164 number
620 and the user already has an E164 alias registered.
621 Returns 'failed' with 'cause' = 'nonexistant' when an alias for a local
622 domain is requested, but the local subscriber does not exist.
623 Returns 'failed' with 'cause' = 'exists' for aliases that already
624 exists, (and aliases that overlaps SIP-accounts - not implemented).
633 Removes the alias given by alias_username and alias_domain.
636 Returns 'ok' with the removed alias adress as 'alias' on success
637 Returns 'failed' with 'cause' = 'nonexistant' it the alias does not
639 Returns 'invalid' with 'cause' = 'address' if the given alias is not a
647 Returns a list of configured and valid domains. May return an empty
648 list if no domains are configured for kamailio. No node is provided
649 to add domains, this is not a task for Hermes, but a kamailio
653 Returns a list of domains as 'list' on success.
654 Returns 'failed' on database errors.
662 Provides the default registrar/proxy/provisioning server information
663 for the given domain.
666 Returns 'ok' with 'servers' set to a kvp-set on success, containing:
667 'registrar','r_port','proxy','p_port','prov_url'.
668 Returns 'failed' with 'cause' = 'nonexistant' if lookup of data for
669 given domain results in an empty set (not configured).
675 registrar=server.bar.bz
679 prov_url=http://server.bar.bz/hermes/prov
682 Sets the server data for the given domain. All of these parameters
683 are Required: 'domain', 'registrar', 'r_port', 'proxy', 'p_port', 'prov_url'.
684 If no default server data is defined, the configuration is added.
685 If server configuration existed, the default data is updated.
688 Returns 'ok' with 'servers' set as domain/get_servers on success.
689 Returns 'failed' with 'cause' set to 'cause' set to 'parameters'
690 if one of these is true:
692 * One or more NULL/empty parameters
693 * Non-numeric values for port-numbers.
694 If you need to determine which of these triggered, the
695 'description' contains a text describing the actual fail.
696 Return 'failed' with 'cause' = 'error' on database failure.
699 ---------------------
701 api/alias/list destination=foo@bar.bz e164=true
702 should return an empty array, returns false
705 ---------------------
707 Some TODO's listed above ...
709 Permissions! (user/permissions?user=...)
711 Improve robustness of change_pw: fetch old password for rollback/testing.
713 Check for locations where sql_dbexec_rows is more appropriate/correct than sql_dbexec
715 Perform an evaluation of the security related to the api-key functionality,
716 and replace if the method is evaluated as too weak. I.e. implement strong
717 non-interactive, non-user based authentication.