neolikotsi / php-smsportal

1.0.13 2021-06-23 11:51 UTC

Requires

• php: ^7.0.0 | ^8.0
• guzzlehttp/guzzle: ~5.0|~6.0|~7.0

MIT

• Neo Likotsi

• sms
• php sms
• sms portal
• sms-client api

Published on Packagist.org on 2021-06-23 11:53 UTC

README

SMS Portal API for PHP

Send SMS from your PHP client API powered by SMSPortal.

Installation

Install the composer package neolikotsi/php-smsportal

composer required neolikotsi/php-smsportal

Usage

Create an instance of NeoLikotsi\SMSPortal\RestClient and use it to hit the endpoints of the SMSPortal RESTful API

use NeoLikotsi\SMSPortal\Message;
use NeoLikotsi\SMSPortal\RestClient;

$apiId = 'YOUR CLIENT API ID';
$apiSecret = 'YOUR CLIENT SECRET';
$baseRestUri = 'https://rest.smsportal.com/v1/';

$client = new RestClient($apiId, $apiSecret, $baseRestUri);
$message = new Message('Hello World');

// send to /bulkmessages endpoint
$responseArray1 = $client->message()->send([
                    'messages' => [
                        [
                            'destination' => '1234567890'
                            'content' => $message->getContent(),
                        ]
                    ]
                ]);

// send to /groupmessages endpoint
$responseArray2 = $client->message()->sendToGroup([
                    'message' => $message->getContent(),
                    'groups' => ['BloemfonteinStores', 'BotshabeloStores'],
                ]);

Balance

You can check your SMS credit with the balance method.

$client->balance();

Test Mode (see api doc)

$client->message()->inTestMode()->send([
    'messages' => [
        [
            'destination' => '1234567890'
            'content' => $message->getContent(),
        ]
    ]
]);

For Laravel users see package

neolikotsi/laravel-smsportal

License

The MIT License (MIT). Please see License File for more information.

Sponsor

₿ BTC Wallet: 18YGRct3jRxkRyxsHG5ByLCkUef7MdXNMw