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. 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.

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 the GUID). This GUID will be generated on the successful creation of your message.

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

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

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 parameter will also be required as in the table below.

Create Contact - HTTP API

This command allows you to create new contacts.

The server will respond with a unique identifier for each contact created (referred to as the GUID). This GUID will be generated on the successful creation of your contact.

Command

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

https://www.remindme.ie/http-create-contact.php?username=xxxx&password=xxxx&api_id=xxxx&firstname=xxxx&surname=xxxx&number=xxxx

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

Parameters

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()

API responses

Example response - Single number submission

Successful API response:

GUID: f7012c1edff2509a19ce1667c7f52b18

Error response:

ERR: 101, Authentication failed