Skip to content

This package enables to send message or OTP to any mobile.This package uses external plivo api.

Notifications You must be signed in to change notification settings

lakshmaji/plivo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 

Repository files navigation

Laravel - plivo

docs on web

WHAT IT IS?

  • This package is used to send sms to any mobile number.
  • This uses Plivo! API.
  • It requires AuthId and AuthToken, they can be generated by registering @at Plivo
    • after registrion click on Dashboard ,there you will be able to see authid and authtoken.
    • sample snapshot: Image of plivo dashboard

Version

1.2.4

Compatibility

Laravel version Plivo version
5.4 1.2.4
5.2 1.2.4
5.1 1.2.4
5.0 1.2.4
4.2 1.1.0

INSTALLATION

To install this package you will need:

  • Laravel 4 or 5 (see compatibility table)
  • PHP

Install via composer ( you can install this package issuing the following command from the terminal )

composer require lakshmaji/plivo

Laravel INTEGRATION

Once this has finished, you will need to add the service provider to the providers array in your app.php config as follows:

 Lakshmaji\Plivo\PlivoServiceProvider::class,

Next, also in the app.php config file, under the aliases array, you are required to add the Plivo facade.

'Plivo' => Lakshmaji\Plivo\Facade\Plivo::class,

Finally, you will want to publish the config using the following command:

	php artisan vendor:publish  

In the plivo.php configuration file we need to enter the Plivo API key and ID

Don't forget to set a auth id and auth secret keys in the config file!, you can get them at Plivo dashboard.

SENDING SMS

<?php

Use Plivo;

$params = array(
	'src' => '1111111111',
	'dst' => '91999999999',
	'text' => 'Hello world!'
);

Plivo::sendSMS($params);

Sent SMS history

<?php

Use Plivo;

// Lists all messages history
$list_all_messages = Plivo::allMessages();

// Lists the filtered messages (pagination)
$params = array(
	'limit' => 2,
	'offset' => 2,
	'message_direction' => 'inbound',
	'message_state' => 'delivered',
);
$list_some_messages = Plivo::allMessages($params);

Get Message data

<?php

Use Plivo;

// Lists all messages history
$list_all_messages = Plivo::allMessages();

// Lists the filtered messages (pagination)
$params = array(
	'limit' => 2,
	'offset' => 2,
	'message_direction' => 'inbound',
	'message_state' => 'delivered',
);
$list_some_messages = Plivo::allMessages($params);

MISCELLANEOUS

<?php

  Use Plivo;

  $params = array(
	  'country_iso' => 'IN'
  );
  
  // List the pricing plans available in a country by using country ISO code
  Plivo::pricing($params);

EXAMPLE CODE FOR Laravel

<?php 
// Define namespace
namespace App\Http\Controllers;

// Include required namespaces
use Illuminate\Routing\Controller as BaseController;
use Plivo;

class Controller extends BaseController
{
    public function sendSMS()
    {
		$params = array(
			'src' => '1111111111',
			'dst' => '91999999999',
			'text' => 'Hello world!'
		);
		
		$response = Plivo::sendSMS($params);
		
}

LICENSE

MIT

Todo

  • Need to add voice support

About

This package enables to send message or OTP to any mobile.This package uses external plivo api.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages