loafer/laravel-gateway-api

Unofficial laravel package for GatewayApi

0.3.0 2022-09-22 14:34 UTC

Requires

• php: ^7.4|^8.0|^8.1
• guzzlehttp/oauth-subscriber: ^0.5|^0.6
• illuminate/support: ^6.0|^7.0|^8.0|^9.0

MIT

• Ruslan Popelyshyn

README

Unofficial package for Gateway Api

Installation

composer require loafer/laravel-gateway-api

Publish config file

php artisan vendor:publish --provider=Loafer\GatewayApi\GatewayApiServiceProvider

Specify api key and secret in .env

GATEWAY_API_KEY=key
GATEWAY_API_SECRET=secret

Usage

Import on top of the file

use Loafer\GatewayApi\Facades\GatewayApi;

Simpliest way to send SMS

GatewayApi::sendSimpleSms('smooth', [[phone]]);

Complex way and available methods:

GatewayApi::setLabel(string)
    ->setSmsClass(string)
    ->setSenderName(string)
    ->setCallbackUrl(string)
    ->sendSimpleSms(string, array);

Sender Name

You can easily specify the sender's name:

In .env or in config/gatewayapi.php

GATEWAY_SENDER="Milky Way"

On the fly

GatewayApi::setSenderName('Elon Musk')
    ->sendSimpleSms('Doggy to moon', [[phone]])

Up to 11 alphanumeric characters or 15 digits

By default, the sender's name is the name of the app

Callback Url

You can easily specify the callback url:

In .env or in config

GATEWAY_CALLBACK_URL="https://some-url.com"

On the fly

GatewayApi::setCallbackUrl('https://test-dev.com/callbacks/sms')
    ->sendSimpleSms('test', [[phone]])

By default, the callback url is not specified

SMS Label

You can easily specify the sms label:

GatewayApi::setSmsLabel('registration')
    ->sendSimpleSms('Welcome...', [[phone]])

By default, the label is not specified

SMS Class

You can easily specify the SMS Class:

Available values: standart, premium, secret

GatewayApi::setSmsClass('premium')
    ->sendSimpleSms('money is honey', [[phone]])

You can use the constants as well:

GatewayApi::SMS_CLASS_STANDART
GatewayApi::SMS_CLASS_PREMIUM
GatewayApi::SMS_CLASS_SECRET

By default, the SMS Class is standart

Additional info

Official Docs