tesark/msg91-php

Send SMS and OTP using MSG91 service

, _(*1)

MSG91 SMS & OTP Composer Package

, _(*2)

• Installation
  • Supported Framework
• Config file setup
• SMS API
  • SendTransactional & SendPromotional
  • SendBulkSms
• OTP API
  • SEND OTP
  • RESEND OTP
  • VERIFY OTP

Installation

Run the following command to install the latest applicable version of the package:, _(*3)

composer require tesark/msg91-php

```sh "require": { "tesark/msg91-php": "dev-master" }, <sub>(*4)</sub>

## Supported FrameWorks

- `Laravel5.3`, `Laravel5.4`, `laravel5.5` we are suggested Laravel frame work
- `Symfony 3.1`, `Slim 3.8 `, `Zend 3.0`, `Codeigniter 3.1`

## Config file setup

- Config file Now, using only for send Authkey.

`Three ways send Authkey`

Tips 1: `Using Config`

```sh
'msg91' => [
    'common' => [
        'transAuthKey' =>  "17086...........9a87a1",
        'promoAuthKey' =>  "17086...........9a87a1",
        'otpAuthKey'   =>  "17043...........59969531",
    ],
]

Tips 2: Using Class parameter, <sub>(*5)</sub>

use Sender\PromotionalSms;
use Sender\TransactionalSms;

$sms = new PromotionalSms("17043...........59969531");
$sms->PromotionalSms("919******541,919******728",$sample);

$sms = new TransactionalSms("17043...........59969531");
$sms->sendTransactional("919******541,919******728",$sample);

Tips 3: Dot Env File, <sub>(*6)</sub>

TRANSAUTHKEY=170***************a87a1
OTPAUTHKEY=1704***************531

Coding Standards

The entire library is intended to be PSR-1, PSR-2 compliant., <sub>(*7)</sub>

SMS

Msg91 Send SMS - GET Method - POST Method, <sub>(*8)</sub>

 GET
http://api.msg91.com/api/sendhttp.php?authkey=YourAuthKey&mobiles=919999999990,919999999999&message=message&sender=ABCDEF&route=4&country=0

operator supports., <sub>(*9)</sub>

• route=1 for promotional
• route=4 for transactional

SMS API

1. SendTransactional & SendPromotional Using GET

• GET Method

Input Data

• $mobileNumber "919******541,919******728" String 9195********3 Integer
• $data Array

Sample Input Data

Tips 1:
$sample = [ 
    'message'      => 'WELCOME TO TESARK',
    'sender'       => 'UTOOWE',
    'country'      => 91,
    'flash'        => 1,
    'unicode'      => 1,
    'schtime'      => "2020-01-01 10:10:00",
    'response'     => "json",
    'afterminutes' => 10,
    'campaign'     => "venkat"
];
use Sender\PromotionalSms;
use Sender\TransactionalSms;

$sms = new PromotionalSms();
$sms->PromotionalSms("919******541,919******728",$sample);

$sms = new TransactionalSms();
$sms->sendTransactional("919******541,919******728",$sample);

Tips 2:
$sample = [ 
    'message'      => 'WELCOME TO TESARK',
    'sender'       => 'TOOME',
    'country'      => 91,
    'flash'        => 1,
    'unicode'      => 1,
    'schtime'      => "2020-01-01 10:10:00",
    'response'     => "json",
    'afterminutes' => 10,
    'campaign'     => "venkat"
];

use Sender\PromotionalSms;
use Sender\TransactionalSms;

$sms = new PromotionalSms();
$sms = new TransactionalSms();

$sms->sendTransactional(919******541,$sample);
$sms->PromotionalSms(919******541,$sample);

API

use Sender\TransactionalSms;
$sms = new TransactionalSms();
$sms->sendTransactional($mobileNumber, $data);

```sh use Sender\PromotionalSms; $sms = new PromotionalSms(); $sms->sendPromotional($mobileNumber, $data);, <sub>(*10)</sub>

## 2. SendBulkSms Using POST
- `POST` Method

### Input Data
- `$data`  Array

### Sample Input Data

```sh
Tips 1: 
$sample = [
    [
        'authkey' => '17086************k599a87a1',
        'sender'  => 'MULSMS',
        'schtime'=> '2016-03-31 11:17:39',
        'campaign'=> 'venkat',
        'country'=> '91',
        'flash'=> 1,
        'unicode'=> 1,
        'content' =>[ 
           [
           'message'    => 'welcome multi sms',
           'mobile' => '91951******1,91880******4,917******972'
           ],
           [
              'message'    => 'tesark world',
              'mobile' => '9195******41,918******824,917******972'
           ]
        ]
    ]  
];        
Tips 2:
$sample = [
    [
       'authkey' => '17086************k599a87a1',
       'sender'  => 'MULSMS',
       'content' =>[ 
            [
                'message'    => 'welcome multi sms',
                'mobile' => '919******541,918******824,917******972'
            ],
            [
                'message'    => 'tesark world',
                'mobile' => '9195******41,91880******4,9170******72'
            ]
        ]
    ],
    [
       'authkey' => '17086************k599a87a1',
       'sender'  => 'SUNSMS',
       'content' =>[ 
            [
                'message'    => 'hai how are u',
                'mobile' => '9195******41,918******824,9******2972'
            ],
            [
                'message'    => 'hai welcome',
                'mobile' => '9195******41,918******824,9******42972'
            ]
        ]
    ]
];

API

use Sender\PromotionalSms;
$sms = new PromotionalSms();
$sms->sendBulkSms($data);

Sample XML

<?xml version="1.0"?>
<MESSAGE>
  <AUTHKEY>17086************k599a87a1</AUTHKEY>
  <SENDER>MULSMS</SENDER>
  <SMS TEXT="welcome multi sms">
    <ADDRESS TO="919******541"/>
  </SMS>
  <SMS TEXT="tesark world">
    <ADDRESS TO="919******541"/>
  </SMS>
</MESSAGE>

Sample Output

5134842646923e183d000075

Note : Output will be request Id which is alphanumeric and contains 24 character like mentioned above. With this request id, delivery report can be viewed. If request not sent successfully, you will get the appropriate error message. View error codes, <sub>(*11)</sub>

OTP API

Msg91 Send OTP, <sub>(*12)</sub>

SEND OTP

• GET Method

GET
http://api.msg91.com/api/sendotp.php?authkey=YourAuthKey&mobile=919999999990&message=Your%20otp%20is%202786&sender=senderid&otp=2786

Input Data

• authkey * alphanumeric
• mobile * Integer
• message varchar
• sender varchar
• otp Integer
• otp_expiry Integer
• otp_length Integer

Sample Input Data

$data = [
    'message'       => "Your verification code is ##5421##",
    'sender'        => "Venkat",
    'otp'           => 5421,
    'otp_expiry'    => 20,
    'otp_length'    => 4
];

API

use Sender\Otp;

$otp = new Otp();
$otp->sendOtp($mobile,$data);

Sample Output

{"message":"3763646c3058373530393938","type":"success"}

RESEND OTP

• GET Method

http://api.msg91.com/api/retryotp.php?authkey=YourAuthKey&mobile=919999999990&retrytype=voice

Input Data

• $mobile Integer
• $retrytype String

Sample Input Data

use Sender\Otp;

$otp = new Otp();

$otp->resendOtp($mobile,"voice")
$otp->resendOtp($mobile,"text")
$otp->resendOtp($mobile)

API

use Sender\Otp;

$otp = new Otp();
$otp->resendOtp($mobile,$retrytype)

Sample Output, <sub>(*13)</sub>

{"message":"otp_sent_successfully","type":"success"}

VERIFY OTP

• GET Method

http://api.msg91.com/api/verifyRequestOTP.php?authkey=YourAuthKey&mobile=919999999990&otp=2786

Input Data

• $mobile Integer
• $otp string

Sample Input Data

OtpSend::verifyOtp(919*******41,9195****421);, <sub>(*14)</sub>

API

use Sender\Otp;

$otp = new Otp();
$otp->verifyOtp($mobile,$otp);

Sample Output, <sub>(*15)</sub>

{"message":"number_verified_successfully","type":"success"}

NOTE:

- Mobile number not attached `+` sign like this `+9195*****41`

Get in touch

If you have any suggestions, feel free to email me at venkatsamuthiram5@gmail.com or ping me on Twitter with @venkatskpi., <sub>(*16)</sub>