maazwebz / maazsms
MaazSMS API is build for MaazSMS - Bulk SMS Application For Marketing
Requires
- php: >=5.3.0
This package is not auto-updated.
Last update: 2024-05-20 06:27:29 UTC
README
MaazSMS API is build for MaazSMS - Bulk SMS Application For Marketing
Prerequisites
To run MaazSMS API you have to install MaazSMS Application on your server. For more details please visit: MaazSMS
php >=5.6
MaazSMS - Bulk SMS Application For Markting
Installing
Via Composer
composer require maazwebz/maazsms
And Via Bash
git clone https://github.com/maazwebz/maazsms.git
Usage
Step 1:
If install MaazSMS API using Git Clone then load your MaazSMS API Class file and Use namespace.
require_once 'src/Class_Maaz_SMS_API.php'; use MaazSMS\MaazSMSAPI;
If install MaazSMS API using Composer then Require/Include autoload.php file in the index.php of your project or whatever file you need to use MaazSMS API classes:.
require 'vendor/autoload.php'; use MaazSMS\MaazSMSAPI;
Step 2:
set your API_KEY from https://mywebhost.com/sms-api/info
(your application install url)
$api_key = 'YWRtaW46YWRtaW4ucGFzc3dvcmQ=';
Step 3:
Change the from number below. It can be a valid phone number or a String
$from = '8801721000000';
Step 4:
the number we are sending to - Any phone number
$destination = '8801810000000';
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://1.dialogsms.pro/
sms/api
is mandatory on your install url
$url = 'https://1.dialogsms.pro/sms/api';
// SMS Body
$sms = 'test message from MaazSMS';
// 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 MaazSMS API request
$client = new MaazSMSAPI();
Send SMS
Finally send your sms through MaazSMS 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
MaazSMS 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 |