The Dibon SMS API is the ultimate solution for any company to start their SMS campaign, either for SMS marketing, event notification, scheduled reminders, holiday greetings, SMS auto-responder, SMS auto follow-up, SMS lucky draw… and many more!

Getting started

To use service, you will need to configure a Sender Id . This could be a shortcode or alphanumeric.

The above is registered on your Dibon Account SMS section.

Integration

This documentation is intended to guide third party application developers interact with the Dibon Payments platform in an easy way using HTTP Post and JSON.

The API request is made via HTTP POST to

https://api.dibon.co.ke

All parameters below are compulsory. The parameters are:

Parameter	Description	Example
api_key	This should match the api key that you have generated for your Dibon account here	2_aa67677e8bf1d4c8fe886a38c03a860
client_id	This should match client id as on your Dibon Account	2
command_id	Pass this as sms	sms
phone_number	Mobile phone number of the recipient of the message	0712345678
message	This is the message to be sent	This is a test Message through our API
sender_id	This is the sender Id	Dibon

API Response

The response from the Dibon API will be a JSON object which the client application can process.

Please note that in order to ensure that you do not miss any transaction notifications the instant they come onto our api, you will need to register a call back url that we will invoke whenever we receive a notification for your service transaction. This is done on your Dibon Account SMS Call Back Section.

Every time a transaction status changes, we will forward you the following information as POST variables as outlined below as a JSON object.

The following POST parameters that will be passed will be as follows

Parameter	Description	Example
request_id	The unique reference number as assigned by the Dibon API	Dibon_2_2938888333
result_desc	The result description of delivery status.	Success
sms	The sms text delivered	text message
phone_number	The subscriber's phone number (subscriber making the payment) in E.164 format	0713456987
transaction_time	The date and time stamp of the transaction.	2017-05-18 18:23:23

            {
              "api_key":"2_aa67677e8bf1d4c8fe886a38c03a860",
              "client_id":"2",
              "command_id":"sms",
              "phone_number":"0712345678",
              "message":"This is a test Message through our API",
              "sender_id":"Dibon"          
            }
          

            {
              "request_id":"Dibon_2_2938888333",
              "result_desc":"Success",
              "sms":"10.00",
              "phone_number":"0713456987",
              "transaction_time":"2017-05-18 18:23:23"          
            }