1. Go to this page and download the library: Download phelix/safaricom-sdp library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
phelix / safaricom-sdp example snippets
use Phelix\SafaricomSDP\SDP;
use Phelix\SafaricomSDP\PremiumSMS;
use Phelix\SafaricomSDP\Exceptions\SDPException;
try {
// We instantiate the SDP class; passing to it, the api username, api password and the cp id
$sdp = new SDP($_ENV["SFC_SDP_API_USERNAME"], $_ENV["SFC_SDP_API_PASSWORD"], $_ENV["SFC_SDP_CP_ID"]);
// By default, SDP will use the sandbox apis (test bed), call useLive() method to use production APIs
$sdp->useLive()->init();
// We instantiate the premium SMS class and pass to it the SDP class
$premiumSMS = new PremiumSMS($sdp);
// We send SMS
$requestId = "1234"; // Generate an id that you can use for tracking/logging purposes
$offerCode = "23456"; // The service for which the sms is being sent
$linkId = "233348438989"; // This ID is generated when a user requests for a service in SDP.
$phoneNumber = "254712345678"; // The phone number of the user to receive the message. Format is 2547...
$message = "This is a test message";
$response = $premiumSMS->sendSMS($requestId, $offerCode, $linkId, $phoneNumber, $message);
// You can check the response and do logging as necessary. Ensure that the status is correctly logged to
// help in tracking if the request was successful or failed
if ($response['success']) {
// Request sent successfully to SDP. Should not be confused to mean the SMS has been successfully
// delivered to the user
// We can now check the status of the sent message
if (isset($response['data']['responseParam'])) {
if ($response['data']['responseParam']['status'] == 1) {
// failed to send SMS
print("SMS sending failed with status code" . $response['data']['responseParam']['statusCode']. "Error says: ". $response['data']['responseParam']['description']);
} else {
// SMS sending a success. Confirm with the status code and the description and also log them for tracking purposes
print($response['data']['responseParam']['description']);
}
} else {
// something wrong seems to have happened. No response param sent back. Handle this for tracking
print("Seems the response hasn't been sent. Best to assume it failed to send the sms");
}
} else {
// Failed to send the request. Could be network, authentication, authorization errors et al
print("Sending request failed with message" . $response['errorMessage']);
}
} catch (SDPException $ex) {
// You can do any error logging operations at this point. Exceptions here would most likely occur
// at the point of token generation
print $ex->getMessage();
}
use Phelix\SafaricomSDP\SDP;
use Phelix\SafaricomSDP\Subscription;
use Phelix\SafaricomSDP\Exceptions\SDPException;
try {
// We instantiate the SDP class; passing to it, the api username, api password and the cp id
$sdp = new SDP($_ENV["SFC_SDP_API_USERNAME"], $_ENV["SFC_SDP_API_PASSWORD"], $_ENV["SFC_SDP_CP_ID"]);
// By default, SDP will use the sandbox apis (test bed), call useLive() method to use production APIs
$sdp->useLive()->init();
// We instantiate the premium SMS class and pass to it the SDP class
$subscription = new Subscription($sdp);
// We send SMS
$requestId = "1234"; // Generate an id that you can use for tracking/logging purposes
$offerCode = "23456"; // The service for which the sms is being sent
$phoneNumber = "254712345678"; // The phone number of the user to receive the message. Format is 2547...
$response = $subscription->activateSubscription($requestId, $offerCode, $phoneNumber);
// You can check the response and do logging as necessary. Ensure that the status is correctly logged to
// help in tracking if the request was successful or failed
if ($response['success']) {
// Request sent successfully to SDP. Should not be confused to mean the activation has been successfully done
// We can now check the status of the sent message
if (isset($response['data']['responseParam'])) {
if ($response['data']['responseParam']['status'] == 1) {
// failed to activate subscription
print("Activation failed" . $response['data']['responseParam']['statusCode']. "Error says: ". $response['data']['responseParam']['description']);
} else {
// Activation a success. Confirm with the status code and the description and also log them for tracking purposes
// Not advisable to assume that this is a success. Always confirm with status code.
print($response['data']['responseParam']['description']);
}
} else {
// something wrong seems to have happened. No response param sent back. Handle this for tracking
print("Seems the response hasn't been sent. Best to assume it failed to activate the user");
}
} else {
// Failed to send the request. Could be network, authentication, authorization errors et al
print("Failed to send the request" . $response['errorMessage']);
}
} catch (SDPException $ex) {
// You can do any error logging operations at this point. Exceptions here would most likely occur
// at the point of token generation
print $ex->getMessage();
}
use Phelix\SafaricomSDP\SDP;
use Phelix\SafaricomSDP\Subscription;
use Phelix\SafaricomSDP\Exceptions\SDPException;
try {
// We instantiate the SDP class; passing to it, the api username, api password and the cp id
$sdp = new SDP($_ENV["SFC_SDP_API_USERNAME"], $_ENV["SFC_SDP_API_PASSWORD"], $_ENV["SFC_SDP_CP_ID"]);
// By default, SDP will use the sandbox apis (test bed), call useLive() method to use production APIs
$sdp->useLive()->init();
// We instantiate the premium SMS class and pass to it the SDP class
$subscription = new Subscription($sdp);
// We send SMS
$requestId = "1234"; // Generate an id that you can use for tracking/logging purposes
$offerCode = "23456"; // The service for which the sms is being sent
$phoneNumber = "254712345678"; // The phone number of the user to receive the message. Format is 2547...
$response = $subscription->deactivateSubscription($requestId, $offerCode, $phoneNumber);
// You can check the response and do logging as necessary. Ensure that the status is correctly logged to
// help in tracking if the request was successful or failed
if ($response['success']) {
// Request sent successfully to SDP. Should not be confused to mean the deactivation has been successfully done
// We can now check the status of the sent message
if (isset($response['data']['responseParam'])) {
if ($response['data']['responseParam']['status'] == 1) {
// failed to activate subscription
print("Activation failed" . $response['data']['responseParam']['statusCode']. "Error says: ". $response['data']['responseParam']['description']);
} else {
// Activation a success. Confirm with the status code and the description and also log them for tracking purposes
// Not advisable to assume that this is a success. Always confirm with status code.
print($response['data']['responseParam']['description']);
}
} else {
// something wrong seems to have happened. No response param sent back. Handle this for tracking
print("Seems the response hasn't been sent. Best to assume it failed to deactivate the user");
}
} else {
// Failed to send the request. Could be network, authentication, authorization errors et al
print("Failed to send the request" . $response['errorMessage']);
}
} catch (SDPException $ex) {
// You can do any error logging operations at this point. Exceptions here would most likely occur
// at the point of token generation
print $ex->getMessage();
}
use Phelix\SafaricomSDP\SDP;
use Phelix\SafaricomSDP\BulkSMS;
use Phelix\SafaricomSDP\Exceptions\SDPException;
try {
// We instantiate the SDP class; passing to it, the api username, api password and the cp id
$sdp = new SDP($_ENV["SFC_SDP_API_USERNAME"], $_ENV["SFC_SDP_API_PASSWORD"], $_ENV["SFC_SDP_CP_ID"]);
// By default, SDP will use the sandbox apis (test bed), call useLive() method to use production APIs
$sdp->useLive()->init();
// We instantiate the premium SMS class and pass to it the SDP class
$bulkSMS = new BulkSMS($sdp);
// We send SMS
$requestId = "1234"; // Generate an id that you can use for tracking/logging purposes
$username = ""; // Username allocated by the SDP to the partner after successful registration.
$packageId = ""; // The id of the campaign package as issued upon successful registration
$originatingAddress = ""; // Originating address assigned to partner after successful registration.
$recipients = [723345678, 789923456, 79098734];
$message = "This is a bulk sms";
$callback = "https://your_call_back_url.com/callback";
$response = $bulkSMS->sendSMS($requestId, $username, $packageId, $originatingAddress, $recipients, $message, $callback);
// You can check the response and do logging as necessary. Ensure that the status is correctly logged to
// help in tracking if the request was successful or failed
if ($response['success']) {
// Request sent successfully to SDP. Should not be confused to mean the bulk has been successfully done
// We can now check the status of the sent message
if (isset($response['data'])) {
if ($response['data']['status'] == "SUCCESS") {
// Bulk SMS successfully dispatched. This does not mean sent to users; this can only be confirmed from the callback
print("Messages successfully dispatched to SDP");
} else {
// Error dispatching bulk SMS to SDP/Safaricom
print("Failed to response code ". $response['data']['statusCode']);
}
} else {
// something wrong seems to have happened. No response param sent back. Handle this for tracking
print("Seems the response hasn't been sent. Best to assume it failed to dispatch the bulk SMS to the users");
}
} else {
// Failed to send the request. Could be network, authentication, authorization errors et al
print("Failed to send request. Error says " . $response['errorMessage']);
}
} catch (SDPException $ex) {
// You can do any error logging operations at this point. Exceptions here would most likely occur
// at the point of token generation
print $ex->getMessage();
}
// put this code in your callback route (controller)
use Phelix\SafaricomSDP\Utils;
$response = Utils::getCallback();
// get the request id. At this point, you can query your database to get the request so as to be able to update its status
$requestId = isset($response['requestId']) ? $response['requestId'] : "";
// check status of the callback
if ($response['success'] == false) {
// callback received has an error
// update to failed delivery with the error message as the reason
print($response['errorMessage']);
} else {
// correct callback data.
$data = $response['data'];
// check the delivery status
$status = $data['responseParam']['status'];
if ($status != 0) {
// failed to deliver message eg when someone has no airtime or is not subscribed
print($data['responseParam']['description']);
} else {
// message successfully delivered.
// update request as being a succss
print("Request $requestId successfully delivered");
}
}
{
"msg": "You have been Authenticated to access this protected API System.",
"token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0dXNlciIsImF1ZCI6IkFDQ0VTUyIsInNjb3BlcyI6IkFETUlOIi wiaXNzIjoiaHR0cDovL3NpeGRlZS5jb20iLCJpYXQiOjE1Njk0OTc1MjksImV4cCI6MTU3NDI5NzUyOX0.- u2Db8OSDhtITMoFqIZYTgs6u4Ib_voynEA6k7ZwiqJqaPQ1_CnUaARxeaoSpC_BC-78_k- rzOr3v2Jdb9_KaA",
"refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0dXNlciIsImF1ZCI6IlJFRlJFU0giLCJzY29wZXMiOiJBRE1J TiIsImlzcyI6Imh0dHA6Ly9zaXhkZWUuY29tIiwianRpIjoiZGIzOTk4OTYtMTU0ZS00ZDFjLTg1NmYtNTUy MDE2MDU3MDVkIiwiaWF0IjoxNTY5NDk3NTI5LCJleHAiOjE1ODAyOTc1Mjl9.uD7fvaMigBI0a2GC00fte qtTx79Elil1CFxRtXz5CTs1qRhJYUVsD0ZjF5Q13J9btY-5ppuzFDqDFkFfUpZAMw"
}