Welcome page
Products
Ozeki 10
Apps
Chat
SMS Gateway
SMS with Client Software
HTTP API
Get Started
HTTP API Tester
Send message
Receive message
Billing methods
URL encode
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
SMS from/to Database
PHP SMS API
Solutions
C# SMS API
VB.NET SMS API
SQL Logging
System Database
Robot Controller
Softphone
Connections
Installation guide
Terms and Definitions
SMS
Bulk Messenger
Cluster
Developer tools
Robots
Hardware
Technology
Company


Ozeki SMS Gateway
HTTP API HTTP API | HTTP API Tester HTTP API Tester

HTTP API - Get Started

Communicate with your SMS Gateway with the HTTP protocol. You can control or get information from the SMS Gateway by HTTP requests. If you used the correct IP address and port of your SMS Gateway, you will receive a HTTP response after every request.

You can give orders to your SMS Gateway by using actions. The HTTP request must start with the requested action and it has to contain the correct username, password pair of any enabled Ozeki SMS Gateway user.

Mandatory parameters in every HTTP API request: action, username, password

Action Example:
HTTP request:

http://127.0.0.1:9501/api?action=createuser&username=admin&password=abc123&type=Standard&name=Alice

HTTP response:

StatusCode: 200, ReasonPhrase: 'OK'

You are advised to try this example with the HTTP API Tester which is a GUI interface for Ozeki SMS Gateway API testing. You can find the HTTP API Tester tutorial here.

Mandatory parameters in every HTTP API request

Parameter Description Possible values Example M/O*
action The name of the action. sendmessage, receivemessage, createuser, configuser, startuser, stopuser, deleteuser, createdriver, configdriver, startdriver, stopdriver, deletedriver, createroute, configroute, deleteroute, configengine, getcredits, setcredits, addcredits, getaddressbook, getmessagebyid, markmessagebyid, deletemessagebyid, getmessagelist, deletemessagelist, deletefolderitems, reporting action=createuser M
username Specifies the username. The username and password parameters are used to authenticate the user. When you send an message it will be sent in the name of the authenticated user. The value must be URL encoced. string value username=admin M
password Specifies the password. The username and password parameters are used to authenticate the user. When you send an message it will be sent in the name of the authenticated user. The value must be URL encoced. string value,
minimum length: 6 characters
password=abc123 M

* M = Mandatory parameter, O = Optional parameter


Copyright © 2000- - Ozeki Ltd | info@ozeki.hu | Tel: +36 1 371 0150
Home > Products > Ozeki 10 > Apps > SMS Gateway > HTTP API > Get Started
Legal | Privacy policy | Terms of use
Page: 5704 | Login | 54.159.51.118