surfnet/messagebird-api-client-bundle

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

A Symfony 3 & 4 bundle to integrate MessageBird's messaging service.

4.1.2 2021-12-17 12:08 UTC

This package is auto-updated.

Last update: 2021-12-17 15:01:06 UTC


README

Build Status Scrutinizer Code Quality SensioLabs Insight

A Symfony 3 bundle (with Symfony 4 support) to integrate MessageBird's messaging service.

End of life warning

We've decided to stop maintaining this bundle because we're moving to Spryng. Contact us if you are interested in taking over maintenance of this bundle.

Installation

  • Add the package to your Composer file

    composer require surfnet/messagebird-api-client-bundle
  • Add the bundle to your kernel in app/AppKernel.php

    public function registerBundles()
    {
        // ...
        $bundles[] = new Surfnet\MessageBirdApiClientBundle\SurfnetMessageBirdApiClientBundle;
    }
  • Configure your MessageBird access key

    surfnet_message_bird_api_client:
      authorization: 'AccessKey test_xxxxxxxxx'

Usage

Sending a message

public function fooAction()
{
    $message = new \Surfnet\MessageBirdApiClient\Messaging\Message(
        'SURFnet',
        '31612345678',
        'Your one-time SMS security token: 9832'
    );
    
    /** @var \Surfnet\MessageBirdApiClientBundle\Service\MessagingService $messaging */
    $messaging = $this->get('surfnet_message_bird_api_client.messaging');
    $result = $messaging->send($message);
    
    if ($result->isSuccess()) {
        // Message has been buffered, sent or delivered.
    }
}

Release strategy

Please read: https://github.com/OpenConext/Stepup-Deploy/wiki/Release-Management for more information on the release strategy used in Stepup projects.