Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fre5h/sinchbundle
📦 Provides integration with Sinch.com SMS API.
https://github.com/fre5h/sinchbundle
bundle php sinch sms symfony symfony-bundle
Last synced: 3 months ago
JSON representation
📦 Provides integration with Sinch.com SMS API.
- Host: GitHub
- URL: https://github.com/fre5h/sinchbundle
- Owner: fre5h
- License: mit
- Created: 2015-10-12T07:44:33.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-01-01T13:41:45.000Z (12 months ago)
- Last Synced: 2024-10-10T13:04:04.956Z (3 months ago)
- Topics: bundle, php, sinch, sms, symfony, symfony-bundle
- Language: PHP
- Homepage: https://www.sinch.com/docs/sms-rest/index.html
- Size: 146 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SinchBundle
:package: Provides integration with **[Sinch.com](https://www.sinch.com)** SMS API.
> **Currently in development process! Things can be changed at any moment!**
[](https://scrutinizer-ci.com/g/fre5h/SinchBundle/)
[](https://travis-ci.com/fre5h/SinchBundle)
[](https://codecov.io/github/fre5h/SinchBundle)
[](https://packagist.org/packages/fresh/sinch-bundle)
[](https://packagist.org/packages/fresh/sinch-bundle)
[](https://packagist.org/packages/fresh/sinch-bundle)
[](https://styleci.io/repos/44092074)
[](https://gitter.im/fre5h/SinchBundle)
[](https://insight.sensiolabs.com/projects/2303fcfb-2e4b-45b3-8b37-6d1e7598acf4)
[](http://knpbundles.com/fre5h/SinchBundle)
## Requirements
* PHP 7.1 *and later*
* Symfony 4.0 *and later*
## Installation
### Create application for Sinch
Sing up in [Sinch.com](https://www.sinch.com) and [create a new app](https://www.sinch.com/dashboard/#/quickstart).
### Add dependency via Composer
```composer req fresh/sinch-bundle='dev-master'```
### Add key and secret to parameters.yml
Add the following lines to your `parameters.yml.dist` file:
```yml
parameters:
sinch.key: EnterKeyForYourSinchApp
sinch.secret: EnterSecretForYourSinchApp
```
During the composer update you have to enter your own key and secret for your Sinch application,
which you can find in your [Sinch dashboard](https://www.sinch.com/dashboard/#/apps).
### Update config.yml
Add the following lines to `config.yml` file:
```yml
fresh_sinch:
key: "%sinch.key%"
secret: "%sinch.secret%"
```
## Usage
### Example of sending SMS
```php
use Fresh\SinchBundle\Service\Sinch;
class Foo {
public function bar(Sinch $sinch) {
// Set the outbound number where you want to send the SMS
$messageId = $sinch->sendSMS('+13155555552', 'Your message');
// If success then the ID of sent message is returned (it is an integer value)
echo $messageId;
}
}
```
### Example of checking SMS status
```php
use Fresh\SinchBundle\Service\Sinch;
class Foo {
public function bar(Sinch $sinch) {
$messageId = 123456789; // The ID of Sinch message you get after successful SMS sending
// Status is a string with one of these values: pending, successful, faulted, unknown
$status = $sinch->getStatusOfSMS($messageId);
// Other helper methods, return true of false
$sinch->smsIsSentSuccessfully($messageId);
$sinch->smsIsPending($messageId);
$sinch->smsIsFaulted($messageId);
$sinch->smsInUnknownStatus($messageId);
}
}
```
#### Catching and processing Sinch exceptions
```php
use Fresh\SinchBundle\Exception\PaymentRequired\SinchPaymentRequiredException;
use Fresh\SinchBundle\Service\Sinch;
class Foo {
public function bar(Sinch $sinch) {
try {
$messageId = $sinch->sendSMS($phoneNumber, 'Your message');
// Some logic related to SMS processing...
} catch (SinchPaymentRequiredException $e) {
$logger->error('SMS was not sent. Looks like your Sinch account run out of money.');
// Here you can, for example, send urgent emails to admin users
// to notify that your Sinch account run out of money
}
}
}
```
***
## Contributing
See [CONTRIBUTING](https://github.com/fre5h/SinchBundle/blob/master/.github/CONTRIBUTING.md) file.