endroid/cm-sms

Endroid CM SMS

Fund package maintenance!
endroid

2.0.5 2019-03-21 21:07 UTC

README

By endroid

Latest Stable Version Build Status Total Downloads Monthly Downloads License

This library enables sending SMS messages using the CM Telecom SMS service.

Installation

Use Composer to install the library.

$ composer require endroid/cm-sms

Symfony integration

You can easily integrate the library in Symfony with the endroid/cm-sms-bundle.

Usage

use Endroid\CmSms\Client;
use Endroid\CmSms\Exception\RequestException;

$client = new Client();

$options = [
    'sender' => 'Endroid',
    'unicode' => 'auto',
    'minimum_number_of_message_parts' => 1,
    'maximum_number_of_message_parts' => 3,
];

$message = new Message();
$message->addTo('0600000000');
$message->setBody('SMS Messaging is the future!');

// Send single message (to one or more recipients)
try {
    $client->sendMessage($message, $options);
} catch (RequestException $exception) {
    // handle exception
}

// Or bulk send multiple messages (to one or more recipients)
try {
    $client->sendMessages([$message, ...], $options);
} catch (RequestException $exception) {
    // handle exception
}

Options

The following sending options are available.

  • sender: default sender
  • unicode: unicode handling (auto, force or never)
  • minimum_number_of_message_parts: min when splitting up long messages
  • maximum_number_of_message_parts: max when splitting up long messages

Versioning

Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatibility breaking changes will be kept to a minimum but be aware that these can occur. Lock your dependencies for production and test your code when upgrading.

License

This source code is subject to the MIT license bundled in the file LICENSE.