PHPackages                             mnovik/laravel-zadarma - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. mnovik/laravel-zadarma

ActiveLibrary[API Development](/categories/api)

mnovik/laravel-zadarma
======================

Laravel ^5.6 integration for the Jlorente Zadarma package.

v1.0.4(1y ago)0214BSD-3-ClausePHPPHP >=7.1.3

Since Aug 15Pushed 1y agoCompare

[ Source](https://github.com/MattNovik/laravel-zadarma)[ Packagist](https://packagist.org/packages/mnovik/laravel-zadarma)[ RSS](/packages/mnovik-laravel-zadarma/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (6)Used By (0)

Zadarma SDK for Laravel
=======================

[](#zadarma-sdk-for-laravel)

Laravel integration for the [Zadarma SDK](https://github.com/jlorente/zadarma-php-sdk) including two notification channels.

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

With Composer installed, you can then install the extension using the following commands:

```
$ php composer.phar require jlorente/laravel-zadarma
```

or add

```
...
    "require": {
        "jlorente/laravel-zadarma": "*"
    }
```

to the `require` section of your `composer.json` file.

Configuration
-------------

[](#configuration)

1. Register the ServiceProvider in your config/app.php service provider list.

config/app.php

```
return [
    //other stuff
    'providers' => [
        //other stuff
        \Jlorente\Laravel\Zadarma\ZadarmaServiceProvider::class,
    ];
];
```

2. Add the following facade to the $aliases section.

config/app.php

```
return [
    //other stuff
    'aliases' => [
        //other stuff
        'Zadarma' => \Jlorente\Laravel\Zadarma\Facades\Zadarma::class,
    ];
];
```

3. Publish the package configuration file.

```
$ php artisan vendor:publish --provider='Jlorente\Laravel\Zadarma\ZadarmaServiceProvider'
```

4. Set the api\_key and api\_secret in the config/zadarma.php file or use the predefined env variables.

config/zadarma.php

```
return [
    'api_key' => 'YOUR_API_KEY',
    'api_secret' => 'YOUR_API_SECRET',
    //other configuration
];
```

or .env

```
//other configurations
ZADARMA_API_KEY=
ZADARMA_API_SECRET=

```

Usage
-----

[](#usage)

You can use the facade alias Zadarma to execute api calls. The authentication params will be automaticaly injected.

```
Zadarma::api()->getBalance();
```

Notification Channels
---------------------

[](#notification-channels)

Two notification channels are included in this package and allow you to integrate the Zadarma send SMS service and the phone call request callback with the Laravel notifications.

You can find more info about Laravel notifications in [this page](https://laravel.com/docs/5.6/notifications).

### ZadarmaSmsChannel

[](#zadarmasmschannel)

If you want to send an SMS through Zadarma, you should define a toZadarmaSms method on the notification class. This method will receive a $notifiable entity and should return a string with the message to be sent on the SMS:

```
/**
 * Get the SMS message.
 *
 * @param  mixed  $notifiable
 * @return string
 */
public function toZadarmaSms($notifiable)
{
    return 'Hello, this is an SMS sent through Zadarma API';
}
```

Once done, you must add the notification channel in the array of the via() method of the notification:

```
/**
 * Get the notification channels.
 *
 * @param  mixed  $notifiable
 * @return array|string
 */
public function via($notifiable)
{
    return [ZadarmaSmsChannel::class];
}
```

### ZadarmaPhoneCallChannel

[](#zadarmaphonecallchannel)

If you want to stablish a phone call by request callback through the Zadarma API, you should define a toZadarmaPhoneCall method on the notification class. This method will receive a $notifiable entity and should return a phone/SIP number, a PBX extension number or the PBX scenario to which the callback will be made.

```
/**
 * Gets a phone/SIP number, a PBX extension number or a PBX scenario to which the
 * phone callback will be made.
 *
 * @param mixed $notifiable
 * @return string
 */
public function toZadarmaPhoneCall($notifiable)
{
    return 100;
}
```

Once done, you must add the notification channel in the array of the via() method of the notification:

```
/**
 * Get the notification channels.
 *
 * @param mixed $notifiable
 * @return array|string
 */
public function via($notifiable)
{
    return [ZadarmaPhoneCallChannel::class];
}
```

### Routing the Notifications

[](#routing-the-notifications)

When sending notifications via Zadarma channel, the notification system will automatically look for a phone\_number attribute on the notifiable entity. If you would like to customize the number you should define a routeNotificationForZadarma method on the entity:

```