The Live sms API enables you to send SMS messages from third-party platforms.
TABLE OF CONTENTS
- Endpoint URL and format
- Authentication
- Request parameters
- Request header
- Response / successful SMS confirmation
Endpoint URL and format
The endpoint URL for sending an SMS is: https://api.livesms.com.au/send-sms
Use the API by sending an HTTP POST.
Authentication
Requests to the POST API are protected with HTTP Basic authentication.
You will need to use your Live sms Username/Email and Password to create your API credentials using a Basic Authentication Header Generator such as Blitter.
Request parameters
Request header
Send you request as a regular application/x-www-form-urlencoded POST.
Header name | Header value |
Content-Type | application/x-www-form-urlencoded |
Authentication | Basic Live sms Username:Live sms Password / base63_encode |
Request body
The Request body requires three parameters to successfully send an SMS; senderID, recipients and message.
Parameter | Format | Required | Comments |
senderID | String | Yes | Numerical Sender ID - Max length of 14 numbers AlphaNumeric Sender ID - Max length of 11 characters |
recipients | Array | Yes | Mobile numbers can be 10 digit or use a country prefix 614xxxxxxxx. The maximum is currently set to 1000 numbers |
message | String | Yes | SMS is charged per 160 characters, inclusion of Unicode characters will reduce the per SMS limit to 70 characters. Max 1530 characters. |
Recipients phone number validation
Live sms API will check contact mobile numbers to see if they are valid before sending.
- Any number that prefix by the “+” sign will be valid.
- Any number that prefix by “61” will be valid.
- Any number that doesn’t follow points 1 & 2 will be validated as follows:
- All non-numeric characters will be removed.
- Any nine-digit numbers will be automatically be prefixed with '61'.
- Any eleven digit numbers will be valid.
Response / successful SMS confirmation
Successfully sent messages will receive an HTTP 200 response with JSON body similar to below.
{
"error": false,
"message": "Send SMS Successfully !",
"data": {
"ok": true,
"status": "Your SMS is being delivered",
"campaignID": "b642b61e-5433-11ea-8409-0213cac47a2a",
"unicode": false,
"messageLength": 15,
"unitsPerMessage": 1,
"totalValidRecipients": 2
}
}Valid and invalid numbers
invalid numbers are included in the payload body.
The 'recipients' parameter will list all valid numbers.