Registration

SMS API integration

An easy and convenient way to integrate our service in your application. You can use the API also for a two-factor authentication (2FA) or a one-time password (OTP).

  1. Overview
  2. Connecting to the API
  3. Using the API
  4. PHP client library
  5. Usage examples
  6. API documentation

Overview

Our API offers an opportunity to configure automated SMS notifications directly from any software, CRM or application.

For the API server communication, a HTTP protocol is used, including secure SSL support. Requests are sent using GET and POST methods, and the server responds in either XML or JSON format, depending on your preference.

Connecting to the API

In order to be able to execute API requests, you need to enable and configure this function in the Mobizon Control Panel:

  1. Open API Settings in the Control Panel:
    Open API Settings in the Control Panel
  2. Check Enable access to the API:
    Check Enable access to the API
  3. Specify IP addresses which should be allowed to send API requests.

After enabling the access, you will see your API Key. Use this key in your application in order to execute API requests.

Please note: Your private key should not be written down or passed on to other persons unless necessary as anyone with knowledge of your key can perform any operations with your account via API.

In order to ensure the security of your account, it is recommended to specify a list of IP addresses assigned to your servers allowed to access the API. List your servers’ IP addresses in the List of IP addresses for access to the API field, separated by comma, e.g.: 192.12.34.56,23.45.67.89,123.123.123.123.

Please note: If this field is left empty, API access is allowed from any IP address, which could be a security threat.

You can change the API key by clicking the Update API key button next to the key. All applications using the old key would not be able to access the API anymore. You will need to replace the old key with the new one in the configuration of your applications.

Using the API

API entry point

All API requests are performed via the address: https://api.mobizon.gmbh/service/

Please note: You can choose to use HTTP or HTTPS protocol for your requests. We recommend sending all requests via secure HTTPS protocol, however if your software does not support creation of secure HTTP requests, you can use the non-encrypted HTTP protocol. In this case, the requests should be directed to http://api.mobizon.gmbh/service/.

Required parameters

Each API request must contain at least the module name, method, and API key:

https://api.mobizon.gmbh/service/user/getownbalance?apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
where:

and additional parameters are listed after the question mark; in this case there is only one additional parameter, apiKey.
Please note that there is no slash (/) before the question mark, as such a request would be invalid:

https://api.mobizon.gmbh/service/user/getownbalance/?apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

Optional parameters

Please note: All values of parameters supplied to the API must be in URL encoded format. Please refer to the documentation to your specific system or programming language for an instructions as to how to convert your parameters to this format.

API server response format

The server response is a string in the chosen data format (XML or JSON) containing an object that comprises three elements: code, data and message. Here are some response examples in JSON format:

{
    "code":0,
    "data":{
        "balance":"4043.0656",
        "currency":"EUR"
    },
    "message":""
}

A response in XML format looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <code>0</code>
    <data>
        <balance>123.4567</balance>
        <currency>EUR</currency>
    </data>
    <message></message>
</root>
where:

API response codes

The result returned by an API call always contains a code field with a numeric value indicating the request processing result:

PHP client library

You can use the official MobizonApi PHP client. Usage examples.

Another option is connecting this module via Composer.

Examples of API PHP client module usage

If you have your own working examples, please send them to us, and we will be glad to post them on the website. Just send your link or code example to support@mobizon.gmbh

GET request usage example

If your application does not support POST requests, use GET requests in the following format:

https://api.mobizon.gmbh/service/message/sendsmsmessage?recipient=NNNNNNNNNNN&from=PPPPPPP&text=Message+text+here%21&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
where:

Price Plans and SMS prices

Prices are listed in EUR for the current time and depend on your plan. All prices exclude 19% VAT. Destination country: Germany, All mobile carriers.

Free

0.068 per SMS

For entry-level SMS marketing

Basic

0.067 per SMS

For small and medium business

Standard

0.066 per SMS

For true professionals

Business

0.064 per SMS

For large companies

See all Prices and Destinations ➜

Test all of our products

30 days for free