Bulk SMS API Integration

(Sandbox Environment) Register and Login on the Sandbox Website to get your Sandbox API Key for the Sandbox Integration Click Here

Welcome to the Bulk SMS API Sandbox Integration page. This guide will help you integrate our Sandbox Bulk SMS API into your system.

On Sandbox environment the mobile number you are sending the bulk sms to must be 08011111111, 08022222222 any other mobile number that is not 08011111111, 08022222222 the bulk sms send request will fail.

Send Bulk SMS API Request cURL Init Sample


curl -X POST https://sandbox.vtunaija.com.ng/api/bulksms/ \ 

-H "Authorization: Token YOUR_API_KEY" \ 

-H "Content-Type: application/json" \ 

-d '{ 

    "sender": "BomaComes", 

    "number": "08011111111,08022222222,08011111111,08022222222", 

    "message": "Merry Christmas and a Happy New Year! Thank you for choosing Boma Enterprise this year. We look forward to continuing to serve you in the future.", 

    "request-id": "287980ak9u7i798" 
          
}'

Successful Send Bulk SMS API Response Example

This is an example of the response returned for a successful Bulk SMS Submission


{ 
  
    "Status": "successful", 

    "status": "success", 

    "api_response": "Message Sent", 

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "34.00", 

    "transaction_internal_id": "9439" 

}

Failed Send Bulk SMS API Response Example

This is an example of the response returned for a failed Bulk SMS Submission


{ 

    "Status": "failed", 

    "status": "fail", 

    "api_response": "Transaction Fail", 

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "0.00", 

    "transaction_internal_id": "9439" 

}

Processing Send Bulk SMS API Response Example

This is an example of the response returned for a pending Bulk SMS Submission.


{ 

    "Status": "processing", 

    "status": "processing", 

    "api_response": "Pending Bulk SMS Submission, transaction pending",

    "id": "78977865523", 

    "ident": "78977865523", 

    "plan_amount": "34.00", 

    "transaction_internal_id": "9439" 
          
}

Failed Send Bulk SMS API Response Example

This is an example of a failed API response caused by factors such as an insufficient wallet balance, an incorrect API key, missing POST fields and so on.


{ 

    "Status": "failed", 
 
    "status": "fail", 

    "message": "Insufficient wallet balance", 
         
              
}

Post Terms Defined and Interpreted

sender: This represents the name or business name of the user sending the bulk SMS.

number: This field contains the phone numbers to which the user is sending the bulk SMS. If sending to multiple phone numbers, separate each number with a comma. Phone numbers can be formatted as either 2348187587897 or 08187587897. On Sandbox environment the mobile number you are sending the bulk sms to must be 08011111111, 08022222222 any other mobile number that is not 08011111111, 08022222222 the bulk sms send request will fail.

message: This field contains the content of the SMS message the user wishes to send via bulk SMS.

request-id: This is the unique ID you send as the Request ID.