README

The ServerClub SMS PHP SDK makes it easy to interact with the SMS API from your PHP application.

Installing

Via Composer

composer require serverclub/serverclub-sms-api

And Via Bash

git clone https://github.com/ServerClub-Digital/ServerClub-SMS-API.git

Usage

Step 1:

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

require_once 'src/Class_ServerClub_SMS_API.php';
use ServerClubSMS\ServerClubSMSAPI;

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

require 'vendor/autoload.php';
use ServerClubSMS\ServerClubSMSAPI;

Step 2:

set your API_KEY from https://sms.serverclub.digital/sms/api (your application install url)

$api_key = 'YWRtaW46YWRtaW4ucGFFDzc3dvcmQ=';

Step 3:

Change the from Sender ID below.

$from = 'Test';

Step 4:

the number we are sending to - Any phone number

$destination = '94771234567';

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

Step 5:

Replace your Install URL like https://sms.serverclub.digital/sms/api with https://sms.serverclub.digital sms/api is mandatory on your install url

$url = 'https://sms.serverclub.digital/sms/api';

// SMS Body

$sms = 'test message from ServerClub 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(
    'api_key' => $api_key,
    'to' => $destination,
    'from' => $from,
    'sms' => $sms
);

// Create Unicode SMS Body for request

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

// Create Voice SMS Body for request

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

// Create MMS SMS Body for request

$sms_body = array(
    'api_key' => $api_key,
    'to' => $destination,
    'from' => $from,
    'sms' => $sms, //optional
    'mms' => $mms,
    'media_url' => $media_url,
);

// Create Schedule SMS Body for request

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

Step 6:

Instantiate a new ServerClub SMS API request

$client = new ServerClubSMSAPI();

Send SMS

Finally send your sms through ServerClub SMS API

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

Get Inbox

Get your all message

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

Get Balance

Get your account balance

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

Response

ServerClub 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

Authors

ServerClub Digital Team - Initial work - ServerClub-Digital

serverclub / serverclub-sms-api

Maintainers

Details