2021 JVoIP -Java VoIP SDK A full featured, flexible SIP client in a single JAR file The Mizu Java VoIP SDK (JVoIP) is a lightweight standards based VoIP phone that can be used as a library or as a standalone application/applet. Based on the industry standard SIP, RTP and related protocols, it is compatible with all common VoIP devices, servers and softphones, providing easy integration capabilities with any application. - Mizutech 6/3/2021 Contents About ............................................................................................................................................................................................................................. 3 Requirements ................................................................................................................................................................................................................. 3 Usage ............................................................................................................................................................................................................................. 3 Using from the console/command line ...................................................................................................................................................................... 3 Using as a standalone application ............................................................................................................................................................................. 4 Using as a library ....................................................................................................................................................................................................... 4 Socket/HTTP API......................................................................................................................................................................................................... 6 Using on a website ..................................................................................................................................................................................................... 7 Features ......................................................................................................................................................................................................................... 9 Licensing ........................................................................................................................................................................................................................ 9 API ................................................................................................................................................................................................................................ 11 Functions .................................................................................................................................................................................................................. 11 Notifications ............................................................................................................................................................................................................. 25 Parameters .................................................................................................................................................................................................................. 33 Main Parameters ..................................................................................................................................................................................................... 34 serveraddress ....................................................................................................................................................................................................... 34 username ............................................................................................................................................................................................................. 34 password .............................................................................................................................................................................................................. 34 register ................................................................................................................................................................................................................. 34 Other Parameters .................................................................................................................................................................................................... 35 FAQ .............................................................................................................................................................................................................................. 74 Resources ..................................................................................................................................................................................................................... 99 About The Mizu Java VoIP SDK (JVoIP) is a SIP client implemented as a platform independent java library. Since it is based on the open standard Session Initiation Protocol, it can inter-operate with any other SIP-based device (servers and clients). The VoIP SDK can be used in many ways: o as a library added to your project (use the API to create a SIP app or add VoIP capabilities for your app; this is the main use-case) o as a command line Java VoIP client (with stdin input / stdout output) o as a standalone desktop application (it has a built-in minimalistic GUI to ease such kind of usage) o as an applet embedded to a web page (applets are already deprecated in modern browsers but still supported by JVoIP) With the Java VoIP SDK you have an easy to use full featured SIP/media stack in a single jar file, easy to integrate or embedded in your desktop, server or web application. For example it can be integrated with callcenter software or embedded in VoIP devices such as PBX or gateways so users will have a fully functional VoIP softphone without the need to download any other third-party software. You can also use it to add VoIP call capabilities into any software not directly related to VoIP (such as games or CRM’s) or to perform any kind of VoIP automation (auto dialer, auto answer machine, etc). See all related resources here. Requirements JVoIP hardware/software requirements: Any OS with Java SE support (Linux, Windows, MAC, others) JVM: Works with most JVM’s including Oracle, OpenJDK and others. Download. Minimum Java version: J2SE 5.0+ (Java 1.5+ which means support for all java versions since 2004) Maximum Java version: 16+. No limitations, the library doesn’t use special modules or API’s. Works well with Java 16 (the current/latest Java when this documentation was last updated) and will remain compatible with all further Java JVM/JRE/JDK releases. Development: any java compiler, any OS and any IDE can be used (the library is a single jar file which can be easily added to your project regardless of your environment) Programming language (when used as a library): any JVM based language such as Java, Clojure, Kotlin, Groovy, Python, Jython and others IDE (when used as a library): any IDE or command line can be used such as IntelliJ, Eclipse, NetBeans, JBuilder, JDeveloper, JCreator, BlueJ, Kite and others Audio device: Headset or microphone/speaker for audio (will work also without audio device for streaming or voice recording) Video device: optional if you wish to use video calls. Any recorded/webcam device which is recognized by your OS CPU: any architecture with Java SE support such as x86, x64, armv7k, arm64, sparc, etc. with a performance of minimum 350 MHz Pentium 3 or higher (runs well also on ancient devices or with embedded devices such as Raspberry Pi) RAM: minimum 10 MB to run JVoIP (above the JVM basic requirements) Disk space: 3 MB (additional data such as call recording or detailed logs might take more space) A SIP account (At any VoIP service provider or your own IP-PBX/Softswitch/SIP sever. Can be also used without registration for peer to peer SIP calls) Note: If you are looking for a SIP stack for your Android project, then you should use the AJVoIP SDK instead of this library (AJVoIP has the same API as this JVoIP SDK, but targets Android instead of Java SE) Usage The SDK can be used in many ways: as a standalone application, embedded into your project or integrated with your website. The settings can be specified from: API, command line, config file, URL or sent via SIP signaling. It can be used as a standalone app or integrated into other app with or without using the API. The API can be accessed from: Java and any other JVM language, JavaScript, UDP, TCP or HTTP (clear text, URL, JSON, XML). The API can be directly used from Java or other JVM based application such as Kotlin, or you can use the API via UDP/TCP or HTTP wrapper from any development environment and programming language such as C, C++, C# or Delphi. Download: Java SIP SDK (this is the demo version) Note: Optionally you might also copy the mediaench files to your app folder (near your java or jar files). This contains some platform dependent native binaries to optimize audio processing