API Documentation

SMSS | Superior Global Messaging Tools
HTTPS & SMPP

SMS-enable your Software hassle-free with our API’s

Scope

This document is a QUICK START GUIDE to allow customers to integrate and access the basic functionality of the SMSS platform.

The API is HTTP based and involves interaction with our dedicated API URL using JSON Objects. The API is:

https://smss.smss.co.za/app/api/rest/v1/sms/send-url/URL Token?recipientNumber=27XXXXXXXXX&message=Test from API

The API has many features which are available on the website in the API specification along with some examples and prebuilt classes for PHP and Java.

This guide will focus on:

• Sending SMSes (Mobile Terminated or MT)
• Balance check via API

SMS User Configuration Requirements

To make use of the BULK SMS API, some configuration is required via the Web User Portal. The most important is the API Token. An API token acts as a password when interacting with the API.

Creating a Sending API Token

To create an API token, follow the steps below:

1. Below your Account Name, on dropdown, click on Developer settings and under URL Settings click Enable
2. Then the API string to be used will be: https://smss.smss.co.za/app/api/rest/v1/sms/send-url/URL Token?recipientNumber=27XXXXXXXXX&message=Test from API
3. Use this URL to send SMS’s from your account without needing to authenticate

Creating a Rest API Token

To create an API token, follow the steps below:

1. Below your Account Name, on dropdown, click on Developer settings and under REST API token click Enable/Generate

Balance Check via API

https://smss.smss.co.za/app/api/rest/v1/account/[email protected]&token=Your Rest API Token

Interactive REST API

{
  "links": [
    {
      "href": "",
      "templated": false,
      "rel": ""
    }
  ],
  "creditBalance": 0
}

{
  "message": "",
  "campaign": "",
  "dateToSend": "",
  "dataField": "",
  "recipientNumber": ""
}

{
  "defaultDateToSend": "",
  "sendSmsRequests": [
    {
      "message": "",
      "campaign": "",
      "dateToSend": "",
      "dataField": "",
      "recipientNumber": ""
    }
  ],
  "messagesPerMinute": 0
}