API Documentation

With our robust and flexible API connection, you can send bulk SMS from your applications, websites or systems easily and fast. Our HTTP API allows integration to any front-end or legacy system with a direct connection into our premium gateways.

Note
: You must have an account with us to use our API. Register Now and start enjoying this unique feature.

All our Resellers buy at a flat rate of N 1.90k and resell to their customers between N2.20k - N 2.39k

Sending bulk SMS with HTTP API

End Point URL:

https://swiftbulksms.com/sendsms.php

API Parameters

Field Name Example Value Description
user * Sandra The login username for your swiftbulksms.com account
password * 123456 The login password for your swiftbulksms.com account
mobile * 08181234411,08188987443 The target mobile numbers separated by Comma
senderid * SwiftSMS The sender name that will show as from address
message * Hello World! The actual text message to send to the target mobile numbers
schedule 2019:07:30:14:20:10 This is to schedule the SMS in future date. The format should be yyyy:mm:dd:hh:mm:ss (without white spaces)
group_id 1,2,3 Account holder Group id in SwiftBulkSMS.
dnd 0 or 1 This is used for sending SMS via DND gateway for DND enabled numbers 
DND = 0 (Do not send via DND gateway for DND enabled mobile numbers and automatically refund units for DND numbers) 
DND = 1 (Send via DND gateway for DND enabled mobile numbers)
unicode 1 or 2 This is used for sending Unicode SMS via SwiftBulkSMS HTTP API. 
Unicode = 1 (You can directly send the Unicode characters). 
Unicode = 2 (You can send Unicode converted as hex)
*are mandatory


Example [Sending to Mobile(s)]

https://swiftbulksms.com/sendsms.php?user=Sandra&password=123456&mobile=08181234411,08188987443&senderid=SwiftSMS&message=HelloWorld&dnd=1

Example [Sending to Group(s)]

https://swiftbulksms.com/sendsms.php?user=Sandra&password=123456&group_id=1,2&senderid=SwiftSMS&message=HelloWorld&dnd=1

Response Codes

1111:SUCCESS:SMS Submitted Successfully. (mobilecount=x, creditsused=y)

When all the mobile numbers are accepted for delivery.
1112:SUCCESS:SMS Submitted Successfully. (mobilecount=x, creditsused=y, failedcount=z)

When there are few numbers which are not accepted for delivery
1113:SUCCESS:SMS Scheduled Successfully
1001:ERROR:Invalid URL. User cannot be empty
1001:ERROR:Invalid URL. Password cannot be empty
1001:ERROR:Invalid URL. Mobile or Group id cannot be empty
1001:ERROR:Invalid URL. Message cannot be empty
1005:ERROR:Invalid value in username or password field
1030:ERROR:Account doesn't exist
1010:ERROR:Account expired
1015:ERROR:Your credits are Low
1020:ERROR:Invalid Sender
1040:ERROR:You are not allowed to send Unicode Messages
1050:ERROR:Character count is greater than X
1060:ERROR:Invalid Group id Specified
1070:ERROR:Invalid schedule time
1080:ERROR:Unable to schedule message
1090:ERROR:Unable to send message
1100:ERROR:Message has been waitlisted (mobilecount=x)

Checking SMS Units Balance

End Point URL:

https://swiftbulksms.com/balance.php

Parameters

Field Name Example Value Description
user * Sandra The login username for your swiftbulksms.com account
password * 123456 The login password for your swiftbulksms.com account
action * send The action string. It can be 'send' or 'receive' or 'account' (Please, always use 'send' for now.)
* are mandatory

Example [Getting SMS Units Balance]

https://swiftbulksms.com/balance.php?user=Sandra&password=123456&action=send

Response Codes

1112:SUCCESS:Total Send Credits:1000000 Used Credits: 84 Remaining credits: 999916
1113:SUCCESS:Total Receive Credits:1000 Used Credits: 50 Remaining credits: 950
1114:SUCCESS:{"name":"Sandra", "Totalsendcredits":"1000000", "Usedsendcredits":"84", "Remainingsendcredits":"999916", "TotalRrecivecredits":"1000", "UsedRrecivecredits":"50", "Remainingrecivecredits":"950", "createdDate":"28 Jan,2016 03:14 PM", "expiryDate":"03 Feb,2017 09:15 PM"}
1001:ERROR:Invalid URL. User cannot be empty
1001:ERROR:Invalid URL. Password cannot be empty
1055:ERROR:Please enter the valid action