- Product Manual
- Introduction
- Installation Guide
- User Guide
- Developers Guide
- Tutorials
- ASP SMS API
- PHP SMS API
- HTTP SMS API
- Send message
- Receive message
- Billing methods
- Urlencode
- Select operator
- Operate with single message
- Query the addressbook
- Operations with message folders
- Examples
- User handling
- Service Provider Connection Handling
- Reporting API
- Dynamic SMPP parameters
- SQL SMS API
- C# SMS API
- AJAX SMS API
- Delphi SMS API
- Cpp SMS API
- Java SMS API
- VB.NET SMS API
- Python SMS API
- Perl SMS API
- TCL/TK SMS API
- Coldfusion SMS API
- VB 6 SMS API
- Examples and Solutions
- Appendix
- SMS FAQ
- Feature list
- Commercial Information
- Search
RECOMMENDED FOR YOU:
SMS Gateway software
Ozeki brings you outstanding
SMS Gateway technology. Use our SMS Server products on Windows,Linux, or Android
C# SMS API
Developers can use our C# SMS API to send SMS from C#.Net. The C# SMS API comes with full source code
PHP SMS API
The ozeki PHP SMS gateway software can be used to send SMS from PHP and to receive SMS usig PHP on your website
SMPP SMS Gateway
SMS service providers use our SMPP gateway solution, that offers a high performance SMPP server and SMPP client gateway with amazing routing capabilities
Ozeki brings you outstanding
SMS Gateway technology. Use our SMS Server products on Windows,Linux, or Android
C# SMS API
Developers can use our C# SMS API to send SMS from C#.Net. The C# SMS API comes with full source code
PHP SMS API
The ozeki PHP SMS gateway software can be used to send SMS from PHP and to receive SMS usig PHP on your website
SMPP SMS Gateway
SMS service providers use our SMPP gateway solution, that offers a high performance SMPP server and SMPP client gateway with amazing routing capabilities
Ozeki NG SMS Gateway
HTTP API for the Reporting function of Ozeki NG SMS Gateway
(available in version: Ozeki NG SMS Gateway v4.1.22 or newer)This method can be used to query the messages that are sent and received by the Ozeki NG SMS Gateway software. With the help of different parameters it becomes possible to filter the messages by operator, user, and date. Therefore it is also possible to query the sent and received messages from an external application.
Description
By using the reporting function (if it is configured in the NG), the following data can be queried:
- the sender user of the SMS message
- the service provider through which the message went
- the exact time when the message was sent
- the content of the SMS message
To use the reporting function, it needs to be allowed in the Ozeki NG SMS Gateway. For the exact configuration steps, please visit the following website: http://ozekisms.com/index.php?owpn=2378
Example URL Request
http://127.0.0.1:9501/api?action=reporting&username=admin&password=abc123&repDirection=in&toExport=summary
Example Response
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: 246 <?xml version="1.0" encoding="utf-8"?> <response> <action>reporting</action> <data> <user> <username>admin</username> <messages>4</messages> </user> </data> </response>
Request parameters
Parameter | Description | Possible values | Example | M/O* |
action | Specifies the HTTP API command sendmessage | reporting | action=reporting | M |
username | Specifies the username. The username and password parameters are used to authenticate the user. The value must be urlencoded. | admin (the admin user's username) | username=admin | M |
password | Specifies the password. The username and password parameters are used to authenticate the user. The value must be urlencoded. | string value, maximum length is 16 characters (the admin user's password) | password=abc123 | M |
repDirection | Specifies whether we would like to list the incoming or the outgoing messages. urlencoded. | in, out | repDirection=in | M |
toExport | Specifies what the got back xml should contain. A summary of the
number of the messages or the messages themselves. |
summary, messages | toExport=messages | M |
repUser | Specifies which user's data we would like to list. In case we do
not define the user, the admin user is being listed automatically.
| string, maximum 16 characters | repUser=testuser | O |
repOperator | Specifies the name of the service provider the data of which we would like to know. | string value, maximum 16 characters | repOperator=HTTPServer0 | O |
repStartTime | Specifies the date after which the sent and received messages we would like to know about. The value must be YYYY-MM-DD hh:mm::ss urlencoded. | date in urlencoded form: YYYY-MM-DD hh:mm::ss | repStartTime=2011-11-29%2011:00:00 | O |
repStopTime | Specifies the date before which the sent and received messages we would like to know about. The value must be YYYY-MM-DD hh:mm::ss urlencoded. | date in urlencoded form: YYYY-MM-DD hh:mm::ss | repStartTime=2020-11-29%2011:00:00 | O |
More information
- HTTP SMS API Examples
- Reporting
- Reporting Mysql Table Layout
- Reporting Oracle Table Layout
- Advanced traffic queries
- HTTP SMS API - billing method
- HTTP SMS API - SMS service provider connection selection
- HTTP SMS API - Operate with single message
- How to query the addressbook in Ozeki NG SMS Gateway
- FAQ of the Ozeki NG SMS Gateway