Documentations for Ozeki VoIP JavaScript API

You can find here all of necessary the documentations about developing APIs, using JavaScript.

Classes

The documentations are separated by classes, where you can find their constructor, methods, events, enumerations and much more information:

ClassDescription
Call The call class contains methods for a wide range of call, messaging and video stream functionalities. It also contains events to help messaging and monitor callstates.
Learn more...
Extension The Extension class represents an extension (or outside line) in the system. The Extension class provides basic information about the extension configured in Ozeki Phone System.
Learn more...
Helper The helper class contains methods which lets you query out information from the OzWebclient instance.
Learn more...
OzCamera You can add your camera as an object in the OzCamera class. It contains methods for setting up your camera and checking out camera features.
Learn more...
OzWebClient The OzWebClient class contains methods for connecting the webclient to Ozeki Phone System and disconnecting from it. The webclient class is the main communication interface between Ozeki Phone System and Javascript. It has a method for creating a call. There are also several events in it.
Learn more...
Session The Session class represents a session of an ongoing call in the system. The Session class provides session modification functions such as hold(), unhold(), etc., which can only be used if the connected webclient has the required privileges. This class contains methods and events for manipulate sessions. This class is internal, therefore there is no need to call the constructor of this class directly. You will receive a Session class object if you subscribe to the OzWebClient.onSessionCreated() event.
Learn more...
User The User class represents a user configured in Ozeki Phone System. The user class contains the user's name, phone number , email address and other user related information. The main purpose of this class is to be able to handle the users and to see the information related to them.
Learn more...
Interceptor classes reference If you want to use more complicated dial plans than the ones you can set in the Dial plan configuration page, the built in JavaScript API interceptor is the tool that you are looking for. With its help you can specify programmatically how the calls should be routed.
Learn more...

More information