arklem/message-bird-sms

The Message Bird API integration for the Yii framework

dev-master / 1.0.x-dev 2022-12-15 15:30 UTC

Requires

• ext-json: *
• messagebird/php-rest-api: ~3.1.2
• yiisoft/yii2: *

Requires (Dev)

• roave/security-advisories: dev-latest

BSD-3-Clause

• Avaika Nametissa Jean Marcel

• sms
• extension
• yii2

README

What is this?

A PHP class, which is an implementation of the SMS API of MessageBird.

The implementation focus is to send SMS using Message Bird credentials (accessKey). (You can get it by signing up to the SMS API.)

It is based on the MessageBird PHP SDK .

Requirements

• Sign up for a free MessageBird account
• Create a new access_key in the developers sections
• MessageBird API client for PHP requires PHP 7.4 or higher to use it. .

Installation

Installation is recommended to be done via composer by running:

composer require arklem/message-bird-sms:dev-master

Alternatively you can add the following to the require section in your composer.json manually:

"arklem/message-bird-sms":"dev-master"

Run composer update afterwards.

Usage

In your PHP project

To send your sms, you'll need only two lines of code.

The first one is to set the accessKey and the originator (the name of who send the message).

The next step is to call the send()-method to send the message to the receivers(recipients).

Here is an example:

// Initialize the MessageBird
MessageBird::__construct("acessKey", "originator");

// send a message to a single receiver
$response = MessageBird::send(["[phone]"], "My First SMS");

//Or

// set a list of receivers / recipients
$receivers = [
    "receiver1",
    "receiver2",
    "receiver3",
    ...
]

// and then make a single call to send
$response = MessageBird::send(["[phone]"], "Send Many SMS");

Thank You for using this extension and if there is any problem, feel free to report it.