Contents
About ............................................................................................................................................................................................................................. 3
Quick start ...................................................................................................................................................................................................................... 3
Features ......................................................................................................................................................................................................................... 3
Usage examples ............................................................................................................................................................................................................. 4
Benefits .......................................................................................................................................................................................................................... 4
Requirements ................................................................................................................................................................................................................ 4
Demo version ................................................................................................................................................................................................................. 5
Licensing ........................................................................................................................................................................................................................ 5
User interface ................................................................................................................................................................................................................ 6
Deployment ................................................................................................................................................................................................................... 7
Simple examples .................................................................................................................................................................................................... 7
Applet parameters ............................................................................................................................................................................................... 10
Main Parameters ......................................................................................................................................................................................................... 10
serveraddress ....................................................................................................................................................................................................... 10
username ............................................................................................................................................................................................................. 10
password .............................................................................................................................................................................................................. 11
register ................................................................................................................................................................................................................. 11
autocall ................................................................................................................................................................................................................ 11
callto .................................................................................................................................................................................................................... 11
Appearance Parameters .............................................................................................................................................................................................. 11
Other Parameters ........................................................................................................................................................................................................ 14
Parameter security................................................................................................................................................................................................... 36
API ................................................................................................................................................................................................................................ 38
JavaScript API ........................................................................................................................................................................................................... 38
Public Functions ....................................................................................................................................................................................................... 39
Notifications ............................................................................................................................................................................................................. 47
Socket API / HTTP API .............................................................................................................................................................................................. 50
SDK ........................................................................................................................................................................................................................... 51
Version history ............................................................................................................................................................................................................. 52
FAQ .............................................................................................................................................................................................................................. 57
Resources ..................................................................................................................................................................................................................... 71
About
The Mizu VoIP Applet / Browser Phone is a SIP client application implemented as a platform independent java applet and will run in any java enabled browser. Since it is based on the open standard Session Initiation Protocol, it can inter-operate with any other SIP-based networks allowing people to make true VoIP calls directly from webpage. The VoIP Applet can be used as:
o static html: for example as a fully featured pre-customized softphone or click to call button on your website o dynamic html: applet parameters generated dynamically from your server side script, for example a click to call button with the called number
changing depending on the content o via the API: JavaScript API/ HTTP API/SDK. So instead of server side application logic, you can implement all logic on client side: web or desktop o a mix of the above o as a standalone desktop application (with or without API and application parameters)
Quick start
It will cost you less than 10 minutes to deploy the Mizu Browser Phone on your website: 1. Check out the presentation on our website if you havent done it before. 2. Download the demo package and check the Example.html source code (for the basic functionality you only need to rewrite the serveraddress applet
parameter -in the html source- to your preferred sip server address. SIP username/password can be also set as applet parameters preconfigured or from your server side script- or let the users to enter their credentials, depending on your needs)
3. Create a similar html on your website (copy-paste the applet tag from the Example.html anywhere to your webpage and copy the webphone.jar near the html files). If you are comfortable with server side development (.PHP, .NET or any other), then you might generate the applet part dynamically for better control.
4. For more advanced usage check the examples directory from the demo package and read through this documentation. Use/modify the skins found in the demo package or create your own skin with simple HTML/CSS; or just hide the applet user interface and integrate its functionality into your existing website
Deployment in short:
1. Copy the webphone.jar to your webserver and refer to it from anywhere from your html with the applet tag. Set at least the serveraddress applet parameter to the IP or domain name of
