how can you use ozml api for developing voip applications (like ivr, autodialer or appointment...
DESCRIPTION
This slideshow is intended to be a great explanation about OzML API that allows you to develop such excellent corporate VoIP applications such as IVR, Autodialer and Appointment Reminder. The presentation explains through a simple example what OzML is, and how you can use it for developing more advanced applications.TRANSCRIPT
What is OzML? How you can use OzML API for developing
such an advanced VoIP applications as
1/17
Prerequisites What you need to use OzML to build
your own VoIP functionalities.
2/17
To get started with OzML
+ +
Ozeki Phone System XE Additional PBX requirements OzML script
Before starting to develop special applications with OzML, be sure that your system
meets with some prerequisites:
OPTION 1 OzML Extension
OPTION 2 SQL OzML
OPTION 3 Webserver + HTTP API
3/17
To get started with OzML
OPTION 1 OzML Extension
OPTION 2 SQL OzML
OPTION 3 Webserver + HTTP API
+ +
Ozeki Phone System XE Additional PBX requirements OzML script
If you want to host your OzML script in your PBX,
you need to install an OzML Extension.
If you want to host your OzML script in your database,
you need to use SQL OzML.
If you want to host your OzML script on a webserver,
you need to use a webserver and HTTP API.
4/17
Basics What is OzML
5/17
What is OzML?
OzML (Ozeki XML) is an XML language which uses predefined commands.
These commands are used in responses to the notifications coming from the PBX.
6/17
Standard form of an
OzML command
To write an OzML command the standard form is the following:
<command parameter1="..." parameter2="...">
'a parameter between the command nodes'
</command>
7/17
Standard form of an
OzML response
An OzML response is always between <response> nodes:
<response>
'commands and their parameters between the nodes'
</response>
8/17
Example for an HTTP request and response
9/17
The Call command can be used to initiate a voice call.
It makes an API extension call a number and do tasks with the call.
Let’s look at an example
How to use Call command
How does it work
OUTGOING CALL
10/17
The tasks are declared in an OzML response document as seen below.
Let’s look at an example
How to use Call command
11/17
Let’s look at an example
How to use Call command
Step 1. Create a call using a HTTP request
http://ozekixepbx.ip:7780/?command=Call&Dialed=100&ApiE
xtension=9997&Url=http://yourapp.com/callconnected.php
12/17
Accept the CallConnected request from the Ozeki Phone System XE on your webserver
and return an XML to handle the call.
Example request sent by the PBX to your webserver: http://yourapp.com/callconnected.php
Let’s look at an example
How to use Call command
Step 2. Return an XML to handle the call
HTTP Request: CallConnected
HTTP Response: XML Your application
13/17
OzML example response returned by callconnected.php:
Let’s look at an example
How to use Call command
<Response>
<Delay>1</Delay>
<Speak>Congratulations, this is your first OzML Response command.</Speak>
<Delay>2</Delay>
<Speak>Have a nice day!</Speak>
</Response>
14/17
Develop IVR | Autodialer | Appointment Reminder
15/17
Excellent VoIP example projects…
…at www.ozekiphone.com with detailed instructions and source code:
16/17
