Ozeki VoIP SDK - Product Guide
Did you know?This SDK was used to build:
Ozeki Phone System XE - VoIP PBX Software for Developers Which is a high performance PBX system supporting Mobile and Desktop phones.
It was also used to create Ozeki 3D VoIP softphone. A cool SIP client that allows 3D Video calls.
How to setup Ozeki VoIP SIP SDK with Asterisk
This guide shows how you can connect Ozeki VoIP SIP SDK to your Asterisk PBX. This solution gives you a brief explanation about how you can configure Ozeki VoIP SIP SDK to start building your own application.
Ozeki VoIP SIP SDK uses Voice over IP to establish phone calls. Using VoIP technology is less expensive than traditional phone services. With Ozeki VoIP SIP SDK you can view your registered phone line and your active phone calls. You can establish calls using the Softphone of the Demo Application. You can also select the codec to be used during the phone call.
This configuration guide demonstrates how you can connect Ozeki VoIP SIP SDK to your Asterisk PBX.
If you follow the configuration guide, you will have a telephone system that works
First, create an extension in your Asterisk PBX. Ozeki VoIP SIP SDK will connect using this created extension. Once Ozeki VoIP SIP SDK Studio is connected, you can start your calls. The destination phone could be a VoIP phone, a land line phone or a mobile phone. You can see this process in Figure 1.
Figure 1 - Calling contacts via Asterisk
- Ozeki VoIP SIP SDK registers to Asterisk
- The call will be forwarded to Asterisk using the created extension
- The destination phone will be ringing
- You can start talking using the SDK
Before you start to configure this solution it is assumed that you have already installed your Asterisk PBX and downloaded Ozeki VoIP SIP SDK installer from the download page.
Step 1.) Configure Asterisk
Start a terminal at the Linux server and login as superuser. For this, type su and login with the administrator password (Figure 2).
Figure 2 - Login as superuser
Then navigate to the config directory of Asterisk (Figure 3). In this example it is located in the etc directory.
Figure 3 - Navigate to the config directory
The users.conf contains the settings that clients can use to register to the PBX. Open this file with a plain text editor. In this example I use a built-in text editor: vi (Figure 4).
Figure 4 - Edit users.conf file
In this example I will register two users.
User 100 for a landline phone and user 101 for Ozeki VoIP SIP SDK (Figure 5).
For this, I insert the following lines into the config file:
 type=friend username=100 callerid=100 secret=100 context=test host=dynamic allow=all  type=friend username=101 callerid=101 secret=101 context=test host=dynamic allow=all
Figure 5 - Register two users
Finally, quit insert mode by pressing Escape button and type: wq (Figure 6).
Figure 6 - Save and exit
Next open extensions.conf file for editing (Figure 7).
Figure 7 - Open extensions.conf file
In extensions.conf file you can find the user's dial plans. Now
set the dial plan for the created user accounts (Figure 8).
In this example I will use the following dial plan:
[test] exten => 100,1,Dial(SIP/100) exten => 101,1,Dial(SIP/101)
Figure 8 - Dial plans
Insert the dial plan, save the file and exit (Figure 9).
Figure 9 - Save Dial plan
Start asterisk service by typing: service asterisk start. The service will start with the new configuration (Figure 10).
service asterisk start
Figure 10 - Start asterisk service
Now the configuration of Asterisk is done, and you can configure Ozeki VoIP SIP SDK.
Step 2.) Configure Ozeki VoIP SIP SDK
In this example, I have already downloaded the Ozeki VoIP SIP SDK installer into my PC from the download page. Open the downloaded package and execute the installer. Accept the License Agreement and click on Next (Figure 11).
Figure 11 - Install VoIP SIP SDK
Wait until your Ozeki VoIP SIP SDK is installed (Figure 12).
Figure 12 - Installing VoIP SIP SDK
After installation, Ozeki VoIP SIP SDK Demo Application will be started automatically. To provide your Asterisk extension details in the Demo Application, fill the SIP Account Settings fields with the created extension data and click on Register. (Figure 13).
Figure 13 - Register to Asterisk
After registration, the registered phone line will be visible in the Phone Lines section. Enter a number using the keypad and click on Pick up (Figure 14).
Figure 14 - Dial a phone
On Figure 15 you can see the Demo Application is calling the destination phone.
Figure 15 - Incoming call from the Demo Application
The active phone call is visible in the Phone Calls section (Figure 16).
Figure 16 - Active phone call
Now the configuration is completed and the testing is successful. You are ready to start to build your application with VoIP support.
If you have any questions, do not hesitate to contact us: email@example.com