MessageBird API Client Bundle

Build Status Scrutinizer Code Quality SensioLabs Insight

A Symfony2 bundle to integrate MessageBird's messaging service.

Installation

  • Add the package to your Composer file

    composer require surfnet/messagebird-api-client-bundle:~1.0
  • 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.
    }
}