Get Into Messaging!

SMS API Endpoint
https://api.bulk.ke/sms/sendsms

Below is a quick step by step guide on how to integrate into our Bulk and Short code / Premium messaging gateway through an application programming interface (API).

To use this API, you need an API Key. If you have already signed up, you can get your API Key from your account.

NOTE: You can import the cURL examples into Postman and generate sample code in different languages

Send SMS - Bulk & Shortcodes

# cURL example
curl --location --request POST 'https://api.bulk.ke/sms/sendsms' \
--header 'h_api_key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobile": "254748321607",
    "response_type": "json",
    "sender_name": "BULK_TECHY",
    "service_id": 0,
    "message": "This is a message.\n\nRegards\nBULK TECHNOLOGIES L.t.d."
}'

# PHP example
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bulk.ke/sms/sendsms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 15,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "mobile": "254748321607",
    "response_type": "json",
    "sender_name": "BULK_TECHY",
    "service_id": 0,
    "message": "This is a message.\n\nRegards\nBULK TECHNOLOGIES L.t.d."
}',
  CURLOPT_HTTPHEADER => array(
    'h_api_key: ', 'Content-Type: application/json'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Send a message to a mobile subscriber using a Sender Name (alphanumeric sender ID):
https://api.bulk.ke/sms/sendsms

Request Type:POST

Parameters

Messaging Status Codes

# Success status :
[
  {
    "status_code": "1000",
    "status_desc": "Success",
    "message_id": 9766667,
    "mobile_number": "254748321607",
    "network_id": "1",
    "message_cost": "0.75",
    "credit_balance": "4757",
 }
]

# Failed status
[
  {
    "status_code": "1001",
    "status_desc": "Invalid short code",
    "message_id": "0",
    "mobile_number": "254748321607",
    "network_id": "",
    "message_cost": "",
    "credit_balance": ""
  }
]

Send Multiple Messages

#cURL example
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bulk.ke/sms/sendmultiple',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "serviceId": "0",
    "shortcode": "BULK_TECHY",
    "messages": [
        {
            "mobile": "254748321607",
            "message": "This is a second message",
            "client_ref": 6481
        },
        {
            "mobile": "254748321607",
            "message": "This is a first message",
            "client_ref": 6092
        }
     
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'h_api_key:  '
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

{
    "status_code": 1000,
    "status_desc": "Success",
    "credit_balance": "-10615.0000",
    "schedule_details": [
        {
            "message_id": 335951830,
            "client_ref": 60970,
            "mobile": "254705941410",
            "schedule_status": "1",
            "schedule_desc": "Success",
            "network_id": "1",
            "message_cost": 1
        },
        {
            "message_id": 335951831,
            "client_ref": 64871,
            "mobile": "254705941419",
            "schedule_status": "1",
            "schedule_desc": "Success",
            "network_id": "1",
            "message_cost": 1
        }
    ]
}

Sending Multiple Messages to Multiple Mobile Numbers:

Request Type: POST

Request Parameters

Validate Mobile Number

#cURL example
curl --location --request GET 'https://api.bulk.ke/sms/mobile?mobile=748321607' \
--header 'h_api_key: '

# PHP example
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bulk.ke/sms/mobile?return=json&mobile=748321607',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 15,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'h_api_key: '
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Validate and check the network a mobile number belongs to:

Request Type:
GET

Request Parameters

Send Delivery Report

#cURL example
curl --location --request POST '/client.endpoint/dlr' \

# PHP example
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '/client.endpoint/dlr',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 15,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'
  { "messageId":"27312989",
  "dlrTime":"2022-02-22 11:46:42",
  "dlrStatus":"1",
  "dlrDesc":"DeliveredToTerminal",
  "tat":10005,
  "network":"1",
  "destaddr":"254767209917",
  "sourceaddr":"118",
  "origin":"Safaricom"}
  '
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Send Delivery report from Mobile Network Operator in realtime:

Request Type:
POST

Request Parameters

GET ACCOUNT BALANCE

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.bulk.ke/sms/getbalance',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
      "response_type":"json"
}',
  CURLOPT_HTTPHEADER => array(
    'h_api_key: adeedccd2199f41f7e731e3150b4c8009de4cded064b6407a310573e28978680',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Account balance for your account using only your API KEY https://api.bulk.ke/sms/getbalance

Request Type:
POST

Request Parameters