zhb/nexmo-bundle

This package is abandoned and no longer maintained. The author suggests using the https://github.com/symfony/nexmo-notifier package instead.

Symfony Nexmo SMS integration

v0.1.0 2018-09-14 06:13 UTC

Requires

• php: ^7.1.3
• nexmo/client: ^1.4
• symfony/config: ^3.4 || ^4.0
• symfony/dependency-injection: ^3.4 || ^4.0
• symfony/http-kernel: ^3.4 || ^4.0
• symfony/serializer: ^3.4 || ^4.1
• symfony/swiftmailer-bundle: ^3.1

Requires (Dev)

• symfony/browser-kit: ^3.4 || ^4.0
• symfony/framework-bundle: ^3.4 || ^4.0
• symfony/phpunit-bridge: ^3.4 || ^4.0
• symfony/property-access: ^3.4 || ^4.1

MIT

• Vincent Huck

• sms
• nexmo

README

Nexmo SMS integration for Symfony. This bundle provides a simple service to send SMS from your application.

Installation

Use Composer to install NexmoBundle in your project:

composer require "zhb/nexmo-bundle"

Configuration

First of all, create a Nexmo account. Next, configure the bundle :

# config/packages/zhb_nexmo.yaml

zhb_nexmo:
    provider: 'zhb_nexmo.mail' # (optional) default to zhb_nexmo.sms
    disable_delivery: true # (optional) default to false.
    sms:
        api_key: 'nexmo_api_key'
        api_secret: 'nexmo_api_secret'
        from: 'John Doe'
        ttl: '86400000' # (optional) default to 259200000 ms.
        callback: 'https://website.com/zhb-nexmo/delivery-receipt' # (optional) default to null. This parameter overrides the webhook endpoint you set in Dashboard.
    mail:
        from: '[e-mail]'
        to: '[e-mail]'

To be able to use Nexmo delivery receipt (DLR) :

# config/routes/zhb_nexmo.yaml

_zhb_nexmo:
    resource: '@ZhbNexmoBundle/Resources/config/routes.xml'
    prefix: /zhb-nexmo/delivery-receipt # change as you want

To set up the webhook used for incoming messages, use zhb_nexmo.sms.callback parameter or use the message setter :

$message->setCallback('https://website.com/nexmo/delivery-receipt');

Alternatively, you can go to the your numbers section of the Nexmo Dashboard. Click 'edit' for the virtual number and set the Callback URL (the prefix defined above).

Usage

How to send an SMS

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Routing\Annotation\Route;
use Zhb\NexmoBundle\Message\TextMessage;
use Zhb\NexmoBundle\Provider\MailProvider;
use Zhb\NexmoBundle\Provider\ProviderInterface;
use Zhb\NexmoBundle\Provider\SmsProvider;

class SmsController extends AbstractController
{
    private $provider;

    private $emailProvider;

    private $smsProvider;

    public function __construct(ProviderInterface $provider, MailProvider $emailProvider, SmsProvider $smsProvider)
    {
        $this->provider = $provider; // provider defined in zhb_nexmo.yaml provider key.
        $this->emailProvider = $emailProvider;
        $this->smsProvider = $smsProvider;
    }

    /**
     * @Route("/sms/send", name="sms_send")
     */
    public function send()
    {
        // phone number must be in E.164 format
        $message = new TextMessage('[phone]', 'Sms message content');
        
        // message setters overrides global config defined in config/packages/zhb_nexmo.yaml
        $message->setFrom('Tom Cruise');
        $message->setTtl(900000); // in milliseconds
        $message->setCallback('https://website.com/zhb-nexmo/delivery-receipt');
        $message->setClientRef('custom_sms_reference');

        $response = $this->provider->send($message);
        var_dump($response);

        $this->emailProvider->send($message);
        $this->smsProvider->send($message);
        
        ...
    }
}

How to listen for SMS delivery receipt (DLR)

<?php

namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Zhb\NexmoBundle\Event\DeliveryReceiptEvent;
use Zhb\NexmoBundle\Event\ZhbNexmoEvents;

class DeliveryReceiptSubscriber implements EventSubscriberInterface
{
    public function onSmsStatusChanged(DeliveryReceiptEvent $event)
    {
        $deliveryReceipt = $event->getDeliveryReceipt();
        
        ...
    }

    public static function getSubscribedEvents()
    {
        return [
           ZhbNexmoEvents::SMS_STATUS_CHANGED => 'onSmsStatusChanged',
        ];
    }
}