How to send an SMS using HTTP

To send an SMS using the HTTP SMS API, you need to form an HTTP URL and you should call this URL from your application. You can use both the HTTP GET and the HTTP POST methods. You can send the SMS over a secure HTTPS link, or through a plain HTTP link. Check out the following easy to use steps to send your fist text messages over HTTP.

How to send an SMS using HTTP (simple steps)

1. Find out the IP:Port of the SMS gateway
2. Write the http://IP:Port/api? url prefix
3. Append the sendmessage parameter to send the sms
4. Add your username and password
5. Set the number where you want to send the sms to
6. Add the url encoded sms text
7. Execute the http request
8. Read the XML response

Introduction to the sendmessage method

The sendmessage method can be used to send an SMS message via the SMS Gateway. The method can be used to send text SMS messages or other message types, such as binary SMS messages, operator logos, ringtones, WAP PUSH, etc... A complete list of available message types can be found in the Mobile Message Type Specification. When you use this method, you must specify the recipient phone number, the message type and the message data.

Send sms example URL Request

http://127.0.0.1:9501/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>

Description

To send a text message via SMS, use the following URL format:

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

For 127.0.0.1, please substitute the IP address or host name of the computer your Ozeki NG SMS gateway is installed on. (Note: 127.0.0.1 is a local loopback address that can be used when you are connecting to the SMS software from the same computer.) The number 9501 is the default port of the SMS gateway. In most environments it should not be changed.

"UUUUU" and "PPPPP" should be replaced to the username and password of the user you have created in the SMS gateway. If you have not created any user, you can use admin as the username and abc123 as the password to use the default account.

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

The message type should be substituted for "MMMMM". For text messages you will use the "SMS:TEXT" message type.

The message data should be substituted for "DDDDD". The message data should be using UTF-8 characters and should be urlencoded.

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.

Request parameters

Response parameters
(xml response format)

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