net-tools/sms

Composer library for sending SMS through several gateways

Maintainers

Details

github.com/net-tools/SMS

Source

Issues

Installs: 36

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

1.0.5 2023-10-20 11:39 UTC

Requires

  • php: >= 7.2.0

MIT db41906ca533fdc006b90c2554d5c51a9089c5c0

  • Pierre <dev.woop@nettools.ovh>

This package is auto-updated.

Last update: 2024-10-20 13:54:52 UTC

README

Root composer library to send SMS through an host such as AWS SNS or OVH

Setup instructions

To install net-tools/sms package, just require it through composer : require net-tools/sms:^1.0.0.

Don't forget to append the real implementation : require net-tools/sms-aws:^1.0.0 or require net-tools/sms-ovh:^1.0.0

How to use ?

This project makes it possible to send SMS through AWS SNS or OVH provider

// create the $snsclient ; please refer to AWS API reference to see how to create the client

// creating config ; actual parameters vary along providers
$config = new \Nettools\Core\Misc\ObjectConfig((object)['sanitizeSenderId' => true]);

// create the api gateway
$gw = new Aws\ApiGateway($snsclient, $config);


// send a sms to several recipients, and this is a transactionnal message (last parameter set to True)
$gw->send('Appointment confirmed !', 'CLINIC', ['+XXYYYYYYYYY', '+XXZZZZZZZZZZ'], true);


// if there are many recipients, call bulkSend insted, with same parameters, as it's more optimized

The APIs supported are : AWS and OVH.

PHPUnit

To test with PHPUnit, point the -c configuration option to the /phpunit.xml configuration file.