SMS HTTP API
We have a very simple but powerful HTTP/HTTPS API.
Simply send an HTTP POST or GET to our SMS campaign API.
You'll need to pass us a minimum of the following fields:
Your username and password (if you don't have one of these, SIGN UP and we'll get you going in 5 minutes)
The From number - where you'd like the message to appear to come from - In Australia this can be a mobile number in 614 format without the + sign (eg 61402111222) or a word up to 11 characters long. (eg 'SMSEveryone')
The destination number in international format (no + sign) - the person you are sending the SMS to. eg 61402123456
The message text
We can pass replies to you in 2 ways:
1. We send a HTTP GET to your URL with the from number, to number & message text. OR
2. Your system sends an HTTP POST or GET to our 'replies' API and we respond with all of replies available since you last checked. We recommend you hit us every 10 minutes.
We include their mobile number, date/time and message text in a simple, standard csv compatible format.
Once replies have been retrieved, we flag them as retrieved our end so that we don't pass the info to you again.
We even allow you to check for replies for a given period regardless of whether you have previously retrieved the data or not. For example you can check the last 7 days or you can specify a date range.
Scheduling an SMS
You can pass us the date and time in a field and we will handle queuing the message at our end so that you don't need to build message queue logic.
You can delete a scheduled message up to 15 minutes before the send time if you make a mistake using our 'delete' function.
You can also modify the send time, message text or originator using our 'modify' API function.
Bulk SMS Campaigns
If you are sending the same message to a lot of people, we allow you to send up to 10,000 mobile numbers per HTTP POST.
You'll need to provide us with a reference ID so that we can group messages for the same campaign together and remove any duplicates. As above, you can delete the campaign if you make a mistake.
Checking Credit Balance
Send an HTTP POST or GET to our credit check API with your username and password and we'll respond with your credit balance.
Approved clients can add credits to their sub-accounts via an API call and we will bill the parent account at the end of the month for all top ups in the previous month. This allows your software to top clients up automatically whenever they get low or offer your client a 'top up' page/section in your software for instant top-ups.
You can use us as your optout database.
When you send any SMS's via our platform, we wash every message against our optout database and prevent you from sending to opted out numbers.
You can add or remove a mobile number from our database via our API as well as retrieve a list of all opted out numbers any time.
Always URL encode your message content, especially the '&' character.
We're here to help you every step of the way so please contact us any time if you need any assistance.
Our latest API document is below.