API

Text Message

http://app.nigeriansms.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 Parameter

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

http://app.nigeriansms.com/api/?username=user&password=pass&message=391000&sender=2348030000000&mobiles=2348020000000&type=call

Upload Audio

app.nigeriansms.com/api/?username=623512d06c&password=f4e50093a6&action=upload&url=app.nigeriansms.com/demo/sample.mp3

{“status”:”success”,”error”:””,”errno”:””,”data”:{“reference”:”ac798a79-f9e9-4662-c85b-f53ae1e62691″,”seconds”:22,”size”:”339.78KB”}}

Send TTS

app.nigeriansms.com/api/?username=623512d06c&password=f4e50093a6&message=welcome+to+Nigerian+SMS.&type=tts&sender=2348040000000&mobiles=2348030000000

{“status”:”success”,”error”:””,”errno”:””,”data”:{“f75cfaec-5565-2044-449a-71f474f9f7d7″:”2348030000000”}}

Send Audio

app.nigeriansms.com/api/?username=623512d06c&password=f4e50093a6&message=ac798a79-f9e9-4662-c85b-f53ae1e62691&type=call&sender=441120000000&mobiles=441130000000

{“status”:”success”,”error”:””,”errno”:””,”data”:{“b5703ef4-9730-c56e-d884-a314fe974cd6”:441130000000}}

Fetching Data

http://app.nigeriansms.com/api/?username=user&password=pass&action=balance

Other Parameter

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