API DOCUMENTATION AND API PARAMETERS

You can interface an application, website or system with our messaging gateway by using our very flexible HTTP API connection. Once you're connected, you'll be able to deliver messages or check your balance. Connect to send single or multiple sms messages through the following api url


API

API Documentation and API Parameters

Connect to send single or multiple sms messages through the following api url:

API NAME: GladSMS

HTTP API


Text Message

https://sms.gladsms.com/api/?username=user&password=pass&message=test&sender=welcome&mobiles=2348030000000,2348020000000

Example Responses:

Success Response: {"status":"OK","count":1,"price":2}

Failed Response: {"error":"Login denied.","errno":"103"}

Other optional Parameters

1. contacts = The list of contact ids to send the message
2. groups = The list of group ids to send the message
3. numbers = The list of number ids to send the message
4. type = The type (text, call, tts ) of the message
5. message = message text or audio reference number

Call Message(VoiceSMS/Robocall)

https://sms.gladsms.com/api/?username=user&password=pass&message=391000&sender=2348030000000&mobiles=2348020000000&type=call

Text-To-Speech

https://sms.gladsms.com/api/?username=user&password=pass&message=391000&sender=2348030000000&mobiles=2348020000000&type=tts

Fetching Data

https://sms.gladsms.com/api/?username=user&password=pass&action=balance

9iceSMS API for SPC Users

HTTP API: https://sms.gladsms.com/api/?username=xxxxx&password=yyyyy&message=@@message@@&sender=@@sender@@&mobiles=@@recipient@@
API response on Success: Ok
API Response confirmation: Contains
Account balance API: https://sms.gladsms.com/api/?username=xxxx&password=yyyy&action=balance
API Protocol: HTTP POST
Push to API as:*: Bulk

API Parameters

You can use the following parameters below to query the API for specific data from our Service



1. login = Perform account login to validate a user
2. profile = The customer profile of the account
3. balance = The current balance on the account
4. contacts = The type (text, call, tts ) of the message
5. numbers = The saved numbers on the account
6. groups = The groups on the account
7. audios = The saved audios on the account
8. history = The message history on the account
9. scheduled = The scheduled messages on the account
10. reports = The delivery reports on the account
11. payments = The payment history on the account

Error Codes:

000 = Request successful
100 = Incomplete request parameters
101 = Request denied
110 = Login status failed
111 = Login status denied
120 = Message limit reached
121 = Mobile limit reached
122 = Sender limit reached
130 = Sender prohibited
131 = Message prohibited
140 = Invalid price setup
141 = Invalid route setup
142 = Invalid schedule date
150 = Insufficient funds
151 = Gateway denied access
152 = Service denied access
160 = File upload error
161 = File upload limit
162 = File restricted
190 = Maintenance in progress
191 = Internal error