What is an SMS API?

An API or Application Programming Interface acts as an interface between the code you write and the RemindMe SMS Gateway. SMS messages are sent by making HTTP or HTTPS calls to the API. You can loop through your list of mobile numbers and make HTTP/S requests to send SMS messages to them.

If you are a beginner to SMS APIs its quick to get started (copy and paste a URL directly in your web browser to send a message!) and there is no need to understand the additional API documentation or advanced features unless you want to use them.

How to Use an SMS API

To send your first message you will need:

• Your API ID - this is available under your 'My account profile - System Settings'
• Format the mobile number that you want to send to in international format.
  
• The mobile number needs to start with the country code
• It must contain no spaces or other non-numeric characters
• If the mobile number starts with zero, remove the zero before typing the rest of the number
• The SMS message text that you want to send. All URL parameters must be URL encoded.
• Add the details into this URL in a web browser and paste it into the URL bar of your browser to send a message.
  
  

  https://www.remindme.ie/sendsmsv2.php?username=XXX&password=XXX&api_id=XXX&to=XXX&message=XXX

• You should receive an onscreen message containing the message id (GUID) from the API. This GUID this is a message tracking ID that you can use
  
  

  GUID: f732e043b21b24bc84d80963b1cbbf9e3fc41e37b3663db1bc

• If you received an error such as Error code: 109 then you may need to double check the parameters that were specified in the URL.

Send message - HTTP SMS API

This command allows you to send one or more SMS messages. To send messages to your database of mobile numbers, you can call this command in a loop.

The server will respond with a unique identifier for each message (referred to as an API message ID). This API message ID can be used to track and monitor the status of your message.

You can also send to multiple handsets in one single HTTP/S request by comma separating mobile numbers (up to 300 numbers with an HTTP GET and 600 with HTTP POST). This is useful if you are sending the same message text to all the handsets.

For high volume messaging, we encourage the use of persistent HTTP/S connections (keep-alive). Multiple concurrent HTTP/S connections may also be used for additional performance.

Command

You can copy and paste the URL below into your web browser. Simply set your authentication details, mobile number and text. Remember to URL encode your parameter values.

https://www.remindme.ie/sendsmsv2.php?username=xxxx&password=xxxx&api_id=xxxx&to=xxxx&message=xxxx

Parameters

In addition to authentication parameters, only to and text are required to send a message. It's important to note that when sending from a two-way number, the from and mo parameters will also be required as in the table below.

Code samples:

Single number submission

Bash:

username="place username here"
password="place password here"
api_id="place password here"
to="mobile number"message="Test+Message"
curl --data "username=$username&password=$password&api_id=$api_id&to=$to&text=$message" \ 'https://www.remindme.ie/sendsmsv2.php'

PHP:

<?php $username = urlencode("place username here");
 $password = urlencode("place password here");
 $api_id = urlencode("place api_id here");
 $to = urlencode("mobile number");
 $message = urlencode("Test Message");

 echo file_get_contents("https://www.remindme.ie/sendsmsv2.php"
 . "?username=$username&password=$password&api_id=$api_id&to=$to&text=$message"); ?>

Python:

import urllib2,

urllib params = { "username": "place username here", "password": "place password here", "api_id": "place password here", "to": "mobile number", "text": "message" }

params = urllib.urlencode(params)

f = urllib2.urlopen("https://www.remindme.ie/sendsmsv2.php", params)

print f.read()

Multiple number submission

HTTP GET URL:

https://www.remindme.ie/sendsmsv2.php?username=xxxx&password=xxxx&api_id=xxxx&to=xxxx,xxxx,xxxx&text=xxxx

Bash:

username="place username here"
password="place password here"
api_id="place password here"
to="number 1,number 2,number 3"
message="message"

curl --data "username=$username&password=$password&api_id=$api_id&to=$to&text=$message" \ 'https://www.remindme.ie/sendsmsv2.php'

PHP:

<?php 

$username = urlencode("place username here");
$password = urlencode("place password here");
$api_id = urlencode("place api_id here");

$toList = array(urlencode("number 1"),urlencode("number 2"),urlencode("number 3"));

$to = implode(',', $toList);
$message = urlencode("Test Message");
echo file_get_contents("https://www.remindme.ie/sendsmsv2.php" . "?username=$username&password=$password&api_id=$api_id&to=$to&text=$message"); ?>

Python:

import urllib2,

urllib params = { "username": "place username here", "password": "place password here", "api_id": "place api_id here", "to": ",".join({"number 1", "number 2", "number 3"}), "text": "message" } 

params = urllib.urlencode(params)
f = urllib2.urlopen("https://www.remindme.ie/sendsmsv2.php", params)
print f.read()

API responses

Example response - Single number submission

Successful API response:

GUID: f7012c1edff2509a19ce1667c7f52b18

Error response:

ERR: 101, Authentication failed

Example response - Multiple number submission

Successful API response:

GUID: f6b9af2a2c9e5b18ee2d257e3def5d66 To: <number 1> GUID: 3e3ca2485ff340185e4af50851422943 To: <number 2> GUID: 48e783af2f1e918f544d389310317369 To: <number 3>

Error response:

ERR: 001, Authentication failed To: <number 1> ERR: 001, Authentication failed To: <number 2> ERR: 001, Authentication failed To: <number 3>

Format - Single number submission

Successful API response:

GUID: <message ID>

Error response:

ERR: <error code>, <error description>

Format - Multiple number submission

Successful API response:

GUID: <message ID> To: <number 1> GUID: <message ID> To: <number 2> GUID: <message ID> To: <number 3>

Error response:

ERR: <error code>, <error description> To: <number 1> ERR: <error code>, <error description> To: <number 2> ERR: <error code>, <error description> To: <number 3>