HTTP SMS API v2.0 - Overview
Ozeki introduced a new HTTP SMS API (v2.0) in Ozeki NG SMS Gateway v3 to address
the requirements of the SMS software developer community. This new HTTP SMS API
provides more features, flexibility and simplicity compared to the previous
versions. It was designed to help developers be more productive and to be
able to add SMS functionality to any project efficiently. This overview gives
you quick links to the HTTP SMS API documentation.
Use the built in webserver of Ozeki NG to send SMS messages
Ozeki NG SMS Gateway has a built in webserver. To send an SMS message you can
submit it using a HTTP request (Figure 1). To send your SMS messages you
can simply call an URL (HTTP Get) or you can use the HTTP Post method.
Figure 1 - Send an SMS messages through the built in webserver
The following links give you detailed information about how to form the URL
and what kind of parameters you can use:
How to send a text message (HTTP API
How to send many SMS messages with a
single HTTP request
How to send a text message (C#
Use the built in webserver to download incoming SMS messages
When an SMS message arrives to the Ozeki NG SMS gateway, it is stored in
a message folder, called inbox. If you want to check incoming SMS messages one
of your options is to download the contents of the inbox folder using HTTP.
The following URL gives more information about how to download the contents
of a message folder:
How to download incoming SMS messages
Processing incoming messages
If you want to process incoming SMS messages as soon as they arrive to your
system, you may want to setup an HTTP Client
user in Ozeki NG SMS Gateway. This
HTTP Client user can forward incoming messages to your web application(s) as
HTTP GET or HTTP POST requests (Figure 2).
Figure 2 - HTTP Post on incoming SMS
The following webpage gives information on how to configure Ozeki NG to forward
your SMS messages to an external web application:
HTTP Client user
Note that you can write this external web application in any programming
language. We have examples for PHP SMS
ASP SMS processing and
Java SMS processing.
Your web application can also return a response SMS message in the HTTP response.
This response SMS messages will be forwarded back to the recipient handset. The
following URL has information about the proper response format your web
application can use:
HTTP response format for returning SMS
Query a message by ID