Skip to content
Markus Neuhold edited this page Sep 27, 2015 · 6 revisions

URL based interface

The described method here is provided for compatibility reasons with smsgateway 1.0. In the future we will add an JSON based rest interface in addition.

This interface has limited capabilities in terms of response codes and functions.

To send a SMS message use the following example:

URL

[GET | POST] http://wis-server-address:port/smsgateway/sendsms?content=<CONTENT>&priority=<PRIORITY>&mobile=<MOBILE>&appid=<APPID>

After sending your request you could receive one of the following answers:

Success

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<SmsSendReturn>
  <returnCode>SUC0001</returnCode>
</SmsSendReturn>

Error

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<SmsSendReturn>
  <returnCode>ERR0001</returnCode>
</SmsSendReturn>

Parameter description

  • content
    The content must be URL and UTF-8 encoded if you are using other letters than ASCII. UTF-8 sample chess sign:
    sample: %E2%99%9e
  • priority
    Must be an positive integer number. The higher the priority the earlier the SMS will be send. The ordering is made through an order by in the SQlite sql statement.
    sample: 1
  • mobile
    The mobile number to send the SMS to, starting with the (target) country code. It can start with a + sign but must not have leading zeros! The country exit code is managed and added by PID.
    So for e.g. Austria all numbers have to start with the country code 43 or +43.
    sample: 436647654321 or +436647654321
  • appid An appid which will be shown up in the web gui.
    sample: myappid

JSON based interface

TBD.