HTTP API - 'sendmessage' action

This http api command can be used to send an SMS message via the SMS Gateway. The command can be used to send text SMS messages or other message types, such as binary SMS messages, operator logos, ringtones, WAP PUSH, etc... When you use this command, you must use an http api username and password, you must specify the recipient phone number, and the message text.

Description

To send an SMS, use the following URL format:

https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD

127.0.0.1 is a local IP, so please replace it to the IP address or host name of the computer with the installed Ozeki SMS Gateway. (Note: 127.0.0.1 is a local loopback address that can be used when you are connecting to the SMS Gateway from the same computer.) 9508 is the default port of Ozeki SMS Gateway's HTTP API. This port number can be viewed and edited in Ozeki 10 SMS Gateway-s user interface, by clicking on the Advanced button in the toolbar.

"UUUUU" and "PPPPP" should be replaced to the username and password of the user you have created in the SMS gateway.

Substitute "NNNNN" to the phone number you wish to send the SMS message to. You can use the local phone number format as well as international phone number formats (telephone numbers formatted according to the international number format always start with a '+' sign). If the international phone number format is used, note that you must substitute '%2B' for the '+' character, because of URL encoding rules.

Please substitute "MMMMM" for the message type. "SMS:TEXT" message type should be used for text messages.

The message data contains the message you would like to send. Place the message data instead of "DDDDD". The message data should be using UTF-8 characters and should be URL encoded.

Other parameters can also be added to the request.
For a complete list of available parameters please take a look at the 'Request parameters' table below:

Example URL Request

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

Example Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 246

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml">
<response>
   <action>sendmessage</action>
   <data>
      <acceptreport>
         <statuscode>0</statuscode>
         <statusmessage>Message accepted for delivery</statusmessage>
         <messageid>ERFAV23D</messageid>
         <recipient>06203105366</recipient>
      </acceptreport>
   </data>
</response>

HTTP request parameters

Response parameters
(xml response format)

<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Message accepted
   for delivery</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>

Summary

This article was about the HTTP API ‘sendmessage’ action. With this action, you can send text SMS messages and many other message types to any recipients through the Ozeki SMS Gateway. You have seen example responses and some more http requests with description, possible values and examples.

If you would like to know more about the delivery status of your messages, feel free to click the page about SMS delivery statuses. If you would like to get a URL template, visit the page for it.

If you would like to use this solution in real situations, download the Ozeki SMS Gateway and start using it now!