Disclaimer: Work in progress - not for public release!

THE DOCUMENT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE DOCUMENT OR THE USE OR OTHER DEALINGS IN THE DOCUMENT.

This document ist automatically generated.

If you find any mistakes or if you have suggestens to improve this doument please feel free to report back to estos GmbH.

UCServer WebService Overview

The UCServer WebService is an integral component of the estos UCServer. It can be reached via the following methods:

  • http
    The default listen port for http is 7224. You can open the UCWS Web page on http://localhost:7224/ .
  • https
    The default listen port for https is 7225. You can open the UCWS Web page on https://localhost:7225/ . The SSL certificate is self signed by default. It is recommended to configure a real trusted ssl certificate.

WebService API

The WebService offers an JSON API for talking with the estos UCServer.

Calling conventions

All API endpoints may be called with GET or POST.

Available routes

  • /ws/direct
    Using this route, all functions are called with authentication. No user session is created. This route can be used only for simple methods that do not require events. Calling functions in this route has a significant overhead, because the user must be authenticated for every function call. (http://servername:7224/ws/direct/)
  • /ws/client
    This is the default route for clients. In this route it is always required to create a user session. To create a user session authentication is required. The user session authenticates the further function calls. The user session also contains an event channel to receive events from the server. (http://servername:7224/ws/client/)
  • /ws/public
    This is the default route for anonymous (public) clients. The functions in this route do not require authentication. This route is used to display public available presence. (http://servername:7224/ws/public/)

All API endpoints may be called with GET or POST. Jsonp is supported.

Version 7