Bulk SMS
Basic flow for Bulk SMS API
Sandbox Base URL: https://sandbox.giftbills.com/api/v1
Production Base URL: https://giftbills.com/api/v1
Gift Bills allows Reseller/Agent to send SMS with two different methods over API.
a. Call /api/v1/sms to send sms via GET method.
b. Call /api/v1/send-sms to send sms via POST method
For multiple recipient, separate numbers with comma(,)
Note:- We advise that all tests should be done on our Sandbox environment. After tests have been done successfully and integration completed on the sandbox, kindly request to be provisioned on our Production Environment. Click Here to register sandbox account now.
Send SMS with Simple GET Method
API Base_URL+Endpoint
GET method
/sms/username=xxx&password=yyy&route=1&sender=GIFTBILLS&recipient=zzz&message=test
Sample Response
{ "success": true, "code": "00000", "message": "SMS Sent Successfully", "data": { "reference": "16360873111679427014", "recipient_count": 1, "details": "Message Successful. SMS Sent cost ₦2.2", "cost": 2.2, "status": "SENT", "duplicate": "0 Duplicate Numbers Removed" "recipients": "07036218209" } }
RESPONSE PROPERTY | DESCRIPTION |
---|---|
reference | sms transaction reference number |
recipient_count | total recipent message being sent to |
details | response details |
cost | total sms cost (determined by the route, total recipient, number of sms pages) |
status | SENT or FAILED |
duplicate | total numbers removed from recipient list |
recipients | recipient list |
To Send SMS Using jSON POST Method
API Endpoint: /send-sms
POST method
curl -X POST --header 'Authorization: Bearer API_KEY' --header 'MerchantId: toluxsys' --header 'content-type: application/json'
Sample Request Body
{ "sender_id": "GIFTBILLS", "route": "1", "message": "Test SMS", "type_recipient": "07036218209" }
REQUEST PROPERTY | DESCRIPTION |
---|---|
MerchantId | Reseller/Agent account username |
API_KEY | Reseller/Agent account api_key |
sender_id | SMS Sender |
route | the SMS Route to use in sending the SMS which determine the cost per SMS. Login to your account to see the SMS pricing. Standard(Ng) = 1, Corporate(Ng) = 2. |
message | sms content/body |
type_recipient | recipient phone number. For multiple number, separate numbers with comma(,) |
Sample Response
{ "success": true, "code": "00000", "message": "SMS Sent Successfully", "data": { "reference": "16360873111679427014", "recipient_count": 1, "details": "Message Successful. SMS Sent cost ₦2.2", "cost": 2.2, "status": "SENT", "duplicate": "0 Duplicate Numbers Removed" "recipients": "07036218209" } }
RESPONSE PROPERTY | DESCRIPTION |
---|---|
reference | sms transaction reference number |
recipient_count | total recipent message being sent to |
details | response details |
cost | total sms cost (determined by the route, total recipient, number of sms pages) |
status | SENT or FAILED |
duplicate | total numbers removed from recipient list |
recipients | recipient list |