brainyservices/karobar-sms-api

Karobar SMS API is build for Karobar SMS - Bulk SMS Application For Marketing

dev-master 2018-08-15 21:18 UTC

README

Karobar SMS API is build for Karobar SMS - Bulk SMS Application For Marketing

Prerequisites

To run Karobar SMS API you have to install Karobar SMS Application on your server OR get KarobarSMS Reseller Account. For more details please visit: Karobar SMS

php >=5.6
Karobar SMS - Bulk SMS Application For Markting

Installing

Via Composer

composer require brainyservices/karobar-sms-api 

And Via Bash

git clone https://github.com/brainyservices/karobar-sms-api.git

Usage

Step 1:

If install Karobar SMS API using Git Clone then load your Karobar SMS API Class file and Use namespace.

require_once 'src/Class_Karobar_SMS_API.php';
use KarobarSMS\KarobarSMSAPI;

If install Karobar SMS API using Composer then Require/Include autoload.php file in the index.php of your project or whatever file you need to use Karobar SMS API classes:.

require 'vendor/autoload.php';
use KarobarSMS\KarobarSMSAPI;

Step 2:

set your API_KEY from https://my.karobarsms.com/api.php (your application install url)

$api_key = 'YWRtaW46YWRtaW4ucGFzc3dvcmQ=';

Step 2.1:

set your Username

$username = 'user_name_here';

Step 3:

Change the from number below. It can be a valid phone number or a String

$from = '923001234567';

Step 4:

the number we are sending to - Any phone number

$destination = '923001234568';

You have to must include Country code at beginning of the phone number.

Step 5:

Replace your Install URL like https://mywebhost.com/sms/api with https://ultimatesms.coderpixel.com/demo/ sms/api is mandatory on your install url

$url = 'https://my.karobarsms.com/api';

// SMS Body

$sms = 'test message from Karobar SMS';

// Unicode SMS

$unicode = '1'; //For Unicode message

// Voice SMS

$voice = '1'; //For voice message

// MMS SMS

$mms = '1'; //For mms message
$media_url = 'https://yourmediaurl.com'; //Insert your media url

// Schedule SMS

$schedule_date = '09/17/2018 10:20 AM'; //Date like this format: m/d/Y h:i A

// Create Plain/text SMS Body for request

$sms_body = array(
    'uname' => $username,
    'api_key' => $api_key,
    'to' => $destination,
    'mask' => $from,
    'text' => $sms
);

// Create Unicode SMS Body for request

$sms_body = array(
    'uname' => $username,
    'api_key' => $api_key,
    'to' => $destination,
    'mask' => $from,
    'text' => $sms
    'unicode' => $unicode,
);

// Create Voice SMS Body for request

$sms_body = array(
    'uname' => $username,
    'api_key' => $api_key,
    'to' => $destination,
    'mask' => $from,
    'text' => $sms
    'voice' => $voice,
);

// Create MMS SMS Body for request

$sms_body = array(
    'uname' => $username,
    'api_key' => $api_key,
    'to' => $destination,
    'mask' => $from,
    'text' => $sms
    'mms' => $mms,
    'media_url' => $media_url,
);

// Create Schedule SMS Body for request

$sms_body = array(
    'uname' => $username,
    'api_key' => $api_key,
    'to' => $destination,
    'mask' => $from,
    'text' => $sms
    'schedule' => $schedule_date,
);

Step 6:

Instantiate a new Karobar SMS API request

$client = new KarobarSMSAPI();

Send SMS

Finally send your sms through Karobar SMS API

$response = $client->send_sms($sms_body, $url);

Get Inbox

Get your all message

$get_inbox=$client->get_inbox($username,$api_key,$url);

Get Balance

Get your account balance

$get_balance=$client->check_balance($username,$api_key,$url);

Response

Karobar SMS API return response with json format, like:

{"code":"OK","message":"Successfully Send"}

Status Code

Status Message
OK Successfully Send
100 Bad gateway requested
101 Wrong action
102 Authentication failed
103 Invalid phone number
104 Phone coverage not active
105 Insufficient balance
106 Invalid Sender ID
107 Invalid SMS Type
108 SMS Gateway not active
109 Invalid Schedule Time
110 Media url required
111 SMS contain spam word. Wait for approval
112 Missing Required Parameters
999 Feature Not Available yet

Authors