1. Introduction
Instant SMS uses a simple GET API for your integrations, for recipients not exceeding 400. The call requires 4 core parameters. Account information can also be obtained to provide details including current balance, number of sent messages and sessions.
Revision history: v1.0 01/01/2019, reviewed by Sekalema Hamza (cto@eurosatgroup.com). v1.1 27/04/2022, reviewed by Sekalema Hamza (cto@eurosatgroup.com).
2. Endpoints
Two environments are available. Use the sandbox for testing and the live link for production.
POST
https://instantsms.eurosatgroup.com/api/sandboxjsonapi.aspx
Sandbox
POST
https://instantsms.eurosatgroup.com/api/smsjsonapi.aspx
Live
3. Parameters
| Name |
Description |
unm |
Sender login name on the Instant SMS system. |
ps |
Sender password. |
message |
Text message. Limited to 160 characters. |
recipients |
Comma-separated array of phone numbers on MTN or Airtel networks. Other networks may be supported on special request. |
Note the spelling of the recipients parameter: receipients in the sample requests below — it must match the API exactly.
4. Sample request
Sandbox
GET / POST
# Sandbox request
https://instantsms.eurosatgroup.com/API/sandboxisonapi.aspx?unm=hamm&ps=xxxx&message=Testing is good&receipients=256703502258,256781122820
Live
GET / POST
# Live request
https://instantsms.eurosatgroup.com/API/smsisonapi.aspx?unm=hamm&ps=xxxx&message=Testing is good&receipients=256703502258,256781122820
5. Reply messages and codes
The API responds in JSON format:
JSON
{
"Code": "200",
"Message": "Message sent successfully to 1 receipients"
}
200
Success
Message sent successfully to x recipients. x is the number of recipients; maximum is 400 per request.
300
Insufficient credit
Sorry, you have insufficient credit. You need to buy enough credit to cover your current message cost.
400
Message too long
Reduce to 160 characters (including spaces) — accepted pattern.
500
Access denied
Invalid account details. Check the login name and password you provided.
501
General error
Check your SMS account and message parameter data.
6. General testing account
For easy testing, use the testing account with the following credentials:
| Field |
Value |
| Username | testing |
| Password | 123456 |
Otherwise you can create a new account either by downloading the Instant SMS app from the Play Store, or from the website:
New accounts have a bonus credit of 100 and can send up to 2 live messages.
7. Account information
To get information about your account, simply call the dashboard API:
GET
https://instantsms.eurosatgroup.com/API/user_admin.aspx?act=DashBoard&username=testing
Dashboard
Sample reply
JSON
[
{
"MyBalance": "300",
"EgoBalance": "0",
"AfrBalance": "0",
"TotalMsgs": "2",
"TotalSessions": "2",
"AllMessages": "0",
"TotalContacts": "0",
"TotalClients": "0"
}
]
8. Conclusion
This API is subject to modifications as technology and user needs change. A new version is always available for all users when changes occur. Thank you for choosing Instant SMS.