headsnet/sms-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Provide email and SMS sending functions

v0.1.12 2018-09-28 01:20 UTC

Requires

• php: >=7.0
• esendex/sdk: 1.*
• misd/phone-number-bundle: ^1.2
• symfony/framework-bundle: ~3.3 || ~4.0
• twig/twig: ^2.0

MIT

• Ben Roberts

README

Symfony bundle to send and receive SMS messages. Currently only the Esendex SMS gateway is supported - https://www.esendex.com/. Other gateways may be added in the future.

Greatly inspired by the excellent tomazahlin/symfony-mailer-bundle https://github.com/tomazahlin/symfony-mailer-bundle

Installation

Requires Symfony >= 3.3 and PHP >= 7.0

Install with Composer

composer require headsnet/sms-bundle

Add bundle to AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Headsnet\SmsBundle\HeadsnetSmsBundle(),
    );
}

If you need to receive SMS then add the routing configuration in app/config/routing.yml

headsnet_sms:
  resource: '@HeadsnetSmsBundle/Resources/config/routing.yml'
  prefix:   '/sms'

Configuration

Add required configuration in app/config.yml

headsnet_sms:
  dispatcher:          esendex
  esendex:
    account_reference: ~
    username:          ~
    password:          ~
    vmn:               ~  # Virtual Mobile Number

To simulate SMS sending, you can use the DummyDispatcher - for example in your when running your test suite - add the following to app/config_test.yml

headsnet_sms:
  dispatcher: dummy

To override the recipient phone number, for example in development, add the following to app/config_dev.yml

headsnet_sms:
  delivery_override:   '[phone]'

Define SMS message templates

Create a mapping service to link template path definitions to template names

<?php
declare(strict_types=1);

namespace AppBundle\Sms;

use Headsnet\Sms\Mapping\TemplateMappingInterface;

/**
 * Map template reference names to template paths
 */
class Mapping implements TemplateMappingInterface
{
	/**
	 * @return array
	 */
	public function getMappings()
	{
		return [
			'customer.confirm' => '@AppBundle/sms/customer.confirm.text.twig',
			'customer.reminder' => '@AppBundle/sms/customer.reminder.text.twig'
		];
	}
}

Sending SMS

To send SMS, inject the SMS sender service in to your code. From here you can access the SMS message factory, or the SMS sender

namespace Company\App;

use Headsnet\Sms\SmsSendingInterface;

class MyService
{
    private $smsSending;
        
    public function __construct(SmsSendingInterface $smsSending)
    {
        $this->smsSending = $smsSending;
    }

    public function doSomething()
    {
        // How to access factory to create SMS instances
        $factory = $this->smsSending->getFactory();
        
        // How to access sender to send or queue the SMS
        $smsSender = $this->smsSending->getSmsSender();
    }
}

Setting up Push Notifications

If you want the EsendexEventDispatcher gateway to phone home with delivery notifications etc, you must ensure you have added the bundle's routing in your routing.yml file.

Then, in your EsendexEventDispatcher control panel, configure the Push Notifications routes with the following URLs:

SMS received

https://app.your-domain.com/sms/esendex/message-received

SMS delivered

https://app.your-domain.com/sms/esendex/delivery-notify

SMS failed

https://app.your-domain.com/sms/esendex/delivery-error

Opt-out

https://app.your-domain.com/sms/esendex/opt-out

These end-points will receive the payload from EsendexEventDispatcher and dispatch one of the following events:

• headsnet.sms.delivered
• headsnet.sms.error
• headsnet.sms.received
• headsnet.sms.opt_out

Listeners to these events will receive a Headsnet\SmsBundle\Event\SmsEvent instance which contains the message data.

View an example Event Subscriber for these events.

Contributing

Pull requests and other contributions are very welcome.