Ozeki 10 SMS Gateway
HTTP API user HTTP API user | Send message Send message

HTTP API - Get Started

The HTTP API allows you to send and receive SMS messages through your Ozeki SMS Gateway with the help of HTTP requests. Requests can be done using both the GET and POST HTTP methods and you can use http or https, depending on your configuration.

For each HTTP request, you must include a set of mandatory parameters. These are: action, username and password. The action defines the command you wish to execute and the username and password identify you. To How to create an HTTP API user guide gives you information about how to create a username and password.

Example HTTP request:

https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagedata=Hello+World

Example 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, action=sendmessage 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
Home > Developers guide > HTTP API > Get Started
Legal | Privacy | Terms of use | 5704
3.235.105.97 | 92.118.27.157 | Login